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

    Type Alias QueryShared

    Query settings shared by searches using a vector or an existing record ID.

    Query data

    type QueryShared = {
        filter?: object;
        includeMetadata?: boolean;
        includeValues?: boolean;
        maxCandidates?: number;
        namespace?: string;
        scanFactor?: number;
        topK: number;
    }
    Index
    filter? includeMetadata? includeValues? maxCandidates? namespace? scanFactor? topK
    filter?: object

    This parameter allows you to modify your query with a metadata filter.

    Metadata filtering

    includeMetadata?: boolean

    Include metadata in each match. Omit or use false to keep the response smaller.

    includeValues?: boolean

    Include embedding values in each match. Omit or use false to keep the response smaller.

    maxCandidates?: number

    Maximum candidates to rerank for dedicated dense indexes, from topK to 100000. Increase to favor recall or decrease to favor latency; omit for the service default.

    namespace?: string

    The namespace to query. If not specified, uses the namespace configured on the Index.

    scanFactor?: number

    Search effort for dedicated dense indexes, from 0.5 to 4. Lower values trade recall for lower latency; omit to use the service default.

    topK: number

    The number of query results you would like returned.

    Settings
    Member Visibility

    On This Page
    Properties