Search vector store

Search a vector store for relevant chunks based on a query and file attributes filter.

POST /vector_stores/{vector_store_id}/search

Search vector store

cURL

curl --request POST \
  --url https://api.openai.com/v1/vector_stores/{vector_store_id}/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "rewrite_query": false,
  "max_num_results": 10,
  "filters": {
    "type": "eq",
    "key": "<string>",
    "value": "<string>"
  },
  "ranking_options": {
    "ranker": "auto",
    "score_threshold": 0
  }
}
'

200

{
  "object": "vector_store.search_results.page",
  "search_query": [
    "<string>"
  ],
  "data": [
    {
      "file_id": "<string>",
      "filename": "<string>",
      "score": 0.5,
      "attributes": {},
      "content": [
        {
          "type": "text",
          "text": "<string>"
        }
      ]
    }
  ],
  "has_more": true,
  "next_page": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

vector_store_id · string · required

The ID of the vector store to search.

Example:

"vs_abc123"

Body

application/json

query · required

A query string for a search

rewrite_query · boolean · default: false

Whether to rewrite the natural language query for vector search.

max_num_results · integer · default: 10

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

Required range: 1 <= x <= 50

filters · Comparison Filter · object

A filter to apply based on file attributes.

Comparison Filter

Compound Filter

Show child attributes

ranking_options · object

Ranking options for search.

Show child attributes

Response

200 - application/json

OK

object · enum<string> · required

The object type, which is always vector_store.search_results.page

Available options: vector_store.search_results.page

search_query · string[] · required

The query used for this search.

data · object[] · required

The list of search result items.

Show child attributes

has_more · boolean · required

Indicates if there are more results to fetch.

next_page · string | null · required

The token for the next page, if any.