provider Vector stores POST /vector_stores/{vector_store_id}/search
@utdk/openai /vector_stores/{vector_store_id}/search
Search a vector store for relevant chunks based on a query and file attributes filter.
vector_store_id path required
The ID of the vector store to search.
string

Try it

Authentication
Configure credentials for OpenAI API
searchvectorstore
POST/vector_stores/{vector_store_id}/search

Parameters

required

The ID of the vector store to search.

Input

required

A query string for a search

Whether to rewrite the natural language query for vector search.

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

A filter to apply based on file attributes.

Ranking options for search.

Configure credentials above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import openai from '@utdk/openai';

await openai.searchvectorstore({
  "rewrite_query": false,
  "max_num_results": 10
})