Search for Vector Store documents by semantic similarity

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

GEThttps://api.rememberizer.ai/api/v1/vector-stores/{vector-store-id}/documents/search

Path parameters

vector-store-id*string

The ID of the vector store.

Query parameters

Header parameters

Response

200

Search results retrieved successfully.

Body

application/json

vector_storeobject

matched_chunksarray of object

Request

JavaScriptCurlPython

const response = await fetch('https://api.rememberizer.ai/api/v1/vector-stores/{vector-store-id}/documents/search?q=text', {
    method: 'GET',
    headers: {
      "x-api-key": "text"
    },
});
const data = await response.json();

Response

200

{
  "vector_store": {
    "id": "text",
    "name": "text"
  },
  "matched_chunks": [
    {
      "document": {
        "name": "text",
        "type": "text",
        "indexed_on": "2024-11-21T08:48:33.943Z",
        "vector_store": "text",
        "created": "2024-11-21T08:48:33.943Z",
        "modified": "2024-11-21T08:48:33.943Z"
      },
      "matched_content": "text",
      "distance": 0
    }
  ]
}