Type alias QueryShared

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

Optional filter?: object

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

See
Metadata filtering
Optional 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.
Optional 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.
topK: number

The number of query results you would like returned.