Member Junction
    Preparing search index...

    Type Alias QueryParamsBase

    type QueryParamsBase = {
        filter?: object;
        includeMetadata?: boolean;
        includeValues?: boolean;
        providerConfig?: Record<string, unknown>;
        topK: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    filter? includeMetadata? includeValues? providerConfig? topK

    Properties

    filter?: object

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

    includeMetadata?: boolean

    This boolean value specifies whether metadata values are returned with query results.

    By default, metadata values are not returned to reduce the size of the request payload.

    includeValues?: boolean

    This boolean value specifies whether embedding values are returned with query results.

    By default, values are not returned to reduce the size of the request payload.

    providerConfig?: Record<string, unknown>

    Optional opaque configuration blob passed through to the vector DB driver. Each driver reads the keys it understands and ignores the rest — callers do not need to know which driver is in use. Populated from the rendered ExternalIndexConfig on the scope's external-index row.

    Example: Pinecone reads providerConfig.namespace for tenant isolation.

    topK: number

    The number of query results you would like returned.

    Settings

    Member Visibility

    On This Page

    Properties