Interface VectorStoreSearchParams

interface VectorStoreSearchParams {
    filters?: ComparisonFilter | CompoundFilter;
    max_num_results?: number;
    query: string | string[];
    ranking_options?: OpenAIClient.VectorStores.VectorStoreSearchParams.RankingOptions;
    rewrite_query?: boolean;
}

Properties

filters?: ComparisonFilter | CompoundFilter

A filter to apply based on file attributes.

max_num_results?: number

The maximum number of results to return. This number should be between 1 and 50 inclusive.

query: string | string[]

A query string for a search

Ranking options for search.

rewrite_query?: boolean

Whether to rewrite the natural language query for vector search.