意味的類似性によるベクトルストアのドキュメントを検索する

Initiate a search operation with a query text and receive most semantically similar responses from the vector store.

get

/vector-stores/{vector-store-id}/documents/search

Path parameters

vector-store-idstringrequired

The ID of the vector store.

Query parameters

qstringrequired

The search query text.

ninteger

Number of chunks to return.

tnumber

Matching threshold.

prev_chunksinteger

Number of chunks before the matched chunk to include.

next_chunksinteger

Number of chunks after the matched chunk to include.

Header parameters

x-api-keystringrequired

The API key for authentication.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.rememberizer.ai/api/v1/vector-stores/{vector-store-id}/documents/search?q=text' \
  --header 'x-api-key: text'

200

200

{
  "vector_store": {
    "id": "text",
    "name": "text"
  },
  "matched_chunks": [
    {
      "matched_content": "text",
      "distance": 1,
      "document": {
        "id": 1,
        "name": "text",
        "type": "text",
        "size": 1,
        "indexed_on": "2025-02-20T19:11:39.886Z",
        "vector_store": "text",
        "created": "2025-02-20T19:11:39.886Z",
        "modified": "2025-02-20T19:11:39.886Z"
      }
    }
  ]
}

Search results retrieved successfully.