Type Alias QueryShared

QueryShared: {
    filter?: object;
    includeMetadata?: boolean;
    includeValues?: boolean;
    namespace?: string;
    topK: number;
}

Optionalfilter?: object
This parameter allows you to modify your query with a metadata filter.

See
Metadata filtering
OptionalincludeMetadata?: 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.
OptionalincludeValues?: 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.
Optionalnamespace?: string
The namespace to query. If not specified, uses the namespace configured on the Index.
topK: number
The number of query results you would like returned.