Interface ListDocumentsResponse

The response for the list_documents operation.

Export

ListDocumentsResponse

interface ListDocumentsResponse {
    documents: ListedDocumentRecord[];
    namespace: string;
    pagination?: Pagination;
    usage: DocumentListUsage;
}

Index

Properties

documents namespace pagination? usage

Properties

documents

documents: ListedDocumentRecord[]

The listed documents, in sorted order by ID.

Memberof

ListDocumentsResponse

namespace

namespace: string

The namespace the documents were listed from.

Memberof

ListDocumentsResponse

`Optional`pagination

pagination?: Pagination

Memberof

ListDocumentsResponse

usage

usage: DocumentListUsage

Memberof

ListDocumentsResponse