Interface FetchDocumentsResponse

The response for the fetch_documents operation.

Export

FetchDocumentsResponse

interface FetchDocumentsResponse {
    documents: { [key: string]: FetchedDocument };
    namespace: string;
    pagination?: Pagination;
    usage: DocumentFetchUsage;
}

Index

Properties

documents namespace pagination? usage

Properties

documents

documents: { [key: string]: FetchedDocument }

A map of document IDs to their fetched documents.

Memberof

FetchDocumentsResponse

namespace

namespace: string

The namespace the documents were fetched from: the request's namespace, or the alias's target namespace when the request named a namespace alias.

Memberof

FetchDocumentsResponse

`Optional`pagination

pagination?: Pagination

Memberof

FetchDocumentsResponse

usage

usage: DocumentFetchUsage

Memberof

FetchDocumentsResponse