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

    Interface SearchDocumentsOptions

    The request for the search_documents operation.

    SearchDocumentsRequest

    interface SearchDocumentsOptions {
        filter?: object;
        includeFields?: string[];
        scoreBy: DocumentScoringMethod[];
        topK: number;
    }
    Index
    filter?: object

    A metadata filter expression to restrict the documents searched.

    SearchDocumentsRequest

    includeFields?: string[]

    The document fields to return on each match alongside _id and _score. When omitted or empty, no fields are returned. Pass ["*"] to return every field.

    SearchDocumentsRequest

    The list of scoring methods to use for ranking documents.

    A single clause of any type is always valid. Several clauses may be combined only when every one of them is text or query_string; a dense_vector or sparse_vector clause must appear on its own.

    SearchDocumentsRequest

    topK: number

    The number of top-ranked documents to return.

    SearchDocumentsRequest