Pinecone TypeScript SDK - v9.0.0
    Preparing search index...

    Interface FetchDocumentsOptions

    The request for the fetch_documents operation. Exactly one of ids or filter must be specified.

    FetchDocumentsRequest

    interface FetchDocumentsOptions {
        filter?: object;
        ids?: string[];
        includeFields?: string[];
        limit?: number;
        paginationToken?: string;
    }
    Index
    filter?: object

    A metadata filter expression selecting the documents to fetch. Must not be empty; an empty filter is rejected rather than matching every document. Mutually exclusive with ids.

    FetchDocumentsRequest

    ids?: string[]

    A list of document IDs to fetch. Mutually exclusive with filter.

    FetchDocumentsRequest

    includeFields?: string[]

    The document fields to return on each document. When omitted or empty, all fields are returned; ["*"] also returns every field.

    FetchDocumentsRequest

    limit?: number

    The maximum number of documents to return per page. Only applies to a fetch by filter; a fetch by ids is already bounded by ids and ignores an in-range value, but a value outside 1-10000 is rejected on either form. Defaults to 100.

    FetchDocumentsRequest

    paginationToken?: string

    A pagination token from a previous fetch response, used to retrieve the next page of matching documents. Only valid together with filter.

    FetchDocumentsRequest