Pinecone TypeScript SDK - v8.2.0
    Preparing search index...

    Interface PreviewSearchDocumentsOptions

    The request for the search_documents operation.

    SearchDocumentsRequest

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

    A metadata filter expression to restrict the documents searched.

    SearchDocumentsRequest

    includeFields?: string[]

    The document fields to include in the search results.

    SearchDocumentsRequest

    scoreBy: PreviewDocumentScoringMethod[]

    The list of scoring methods to use for ranking documents.

    SearchDocumentsRequest

    topK: number

    The number of top-ranked documents to return.

    SearchDocumentsRequest

    Settings
    Member Visibility

    On This Page
    Properties