Search Vector Store

POST /v1/vector_stores/{vector_store_id}/search

Python

from openai import OpenAI
client = OpenAI()

results = client.beta.vector_stores.search(
    vector_store_id="vs_abc123",
    query="How do I reset my password?",
    max_num_results=5
)

for result in results.data:
    print(f"Score: {result.score}")
    print(f"Content: {result.content}")
    print(f"File: {result.file_id}")
    print("---")

import OpenAI from "openai";
const openai = new OpenAI();

const results = await openai.beta.vectorStores.search(
  "vs_abc123",
  {
    query: "How do I reset my password?",
    max_num_results: 5
  }
);

for (const result of results.data) {
  console.log(`Score: ${result.score}`);
  console.log(`Content: ${result.content}`);
  console.log(`File: ${result.file_id}`);
  console.log("---");
}

curl https://api.openai.com/v1/vector_stores/vs_abc123/search \\
  -H "Authorization: Bearer $OPENAI_API_KEY" \\
  -H "Content-Type: application/json" \\
  -H "OpenAI-Beta: assistants=v2" \\
  -d '{
    "query": "How do I reset my password?",
    "max_num_results": 5
  }'

{
  "object": "list",
  "data": [
    {
      "type": "vector_store.search_result",
      "score": 0.95,
      "content": "To reset your password, click on the 'Forgot Password' link on the login page...",
      "file_id": "file-abc123",
      "metadata": {
        "page": 5,
        "chunk_id": "chunk_789"
      }
    },
    {
      "type": "vector_store.search_result",
      "score": 0.87,
      "content": "Password reset instructions: Navigate to Settings > Security > Reset Password...",
      "file_id": "file-abc456",
      "metadata": {
        "page": 12,
        "chunk_id": "chunk_456"
      }
    }
  ]
}

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

Path Parameters

vector_store_id · string · required

The ID of the vector store to search.

Request Body

query · string · required

A query string for a search. Can also be an array of strings for multi-query search.

max_num_results · integer

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

filters · object

A filter to apply based on file attributes.

Example:

{
  "file_id": "file-abc123"
}

ranking_options · object

Ranking options for search.

Show properties

ranker · string

The ranking algorithm to use. Options include:

• default_2024_08_21: Default ranking algorithm

score_threshold · number

Minimum score threshold for results.

rewrite_query · boolean

Whether to rewrite the natural language query for vector search.

Response

Returns a list of search results with relevant chunks.

data · array

Array of search result objects.

Show Search result object

type · string

The type of the object, always vector_store.search_result.

score · number

The relevance score of the chunk.

content · string

The text content of the chunk.

file_id · string

The ID of the file this chunk came from.

metadata · object

Metadata about the chunk location within the file.

Python

from openai import OpenAI
client = OpenAI()

results = client.beta.vector_stores.search(
    vector_store_id="vs_abc123",
    query="How do I reset my password?",
    max_num_results=5
)

for result in results.data:
    print(f"Score: {result.score}")
    print(f"Content: {result.content}")
    print(f"File: {result.file_id}")
    print("---")

import OpenAI from "openai";
const openai = new OpenAI();

const results = await openai.beta.vectorStores.search(
  "vs_abc123",
  {
    query: "How do I reset my password?",
    max_num_results: 5
  }
);

for (const result of results.data) {
  console.log(`Score: ${result.score}`);
  console.log(`Content: ${result.content}`);
  console.log(`File: ${result.file_id}`);
  console.log("---");
}

curl https://api.openai.com/v1/vector_stores/vs_abc123/search \\
  -H "Authorization: Bearer $OPENAI_API_KEY" \\
  -H "Content-Type: application/json" \\
  -H "OpenAI-Beta: assistants=v2" \\
  -d '{
    "query": "How do I reset my password?",
    "max_num_results": 5
  }'

{
  "object": "list",
  "data": [
    {
      "type": "vector_store.search_result",
      "score": 0.95,
      "content": "To reset your password, click on the 'Forgot Password' link on the login page...",
      "file_id": "file-abc123",
      "metadata": {
        "page": 5,
        "chunk_id": "chunk_789"
      }
    },
    {
      "type": "vector_store.search_result",
      "score": 0.87,
      "content": "Password reset instructions: Navigate to Settings > Security > Reset Password...",
      "file_id": "file-abc456",
      "metadata": {
        "page": 12,
        "chunk_id": "chunk_456"
      }
    }
  ]
}