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

    Type Alias SearchRecordsQuery

    The query object used with a SearchRecordsOptions request.

    type SearchRecordsQuery = {
        filter?: object;
        id?: string;
        inputs?: object;
        matchTerms?: SearchMatchTerms;
        topK: number;
        vector?: SearchRecordsVector;
    }
    Index
    filter? id? inputs? matchTerms? topK vector?
    filter?: object

    The filter to apply. You can use vector metadata to limit your search.

    Understanding metadata.

    id?: string

    The unique ID of the vector to be used as a query vector.

    inputs?: object

    Embedding inputs, such as { text: "waterproof hiking shoes" }. Requires an index with integrated embedding.

    matchTerms?: SearchMatchTerms

    Require matching terms in the text field configured by the index field map, for example { strategy: "all", terms: ["hiking", "waterproof"] }. Supported for compatible sparse indexes with integrated embedding.

    Integrated embedding

    topK: number

    The number of similar records to return.

    vector?: SearchRecordsVector

    The SearchRecordsVector to search with, if provided.

    Settings
    Member Visibility

    On This Page
    Properties