Vector Store Query

Query

Run a vector search query on configured target connection

POSThttps://sapphire.contextdata.ai/api/workspace/query

Authorization

AuthBearer

Body

application/json

vector_store_identifier*Vector Store Identifier

Vector Store (Target Connection) identifier. Get the UUID from the '/target_connections' endpoint

vector_store_column*Vector Store Column

Specify the columns/fields in the target vector store connection

embedding_model_identifier*Embedding Model Identifier

Embedding model identifier. Get the UUID from the '/embedding_models' endpoint

query_text*Query Text

Your query text

response_limitResponse Limit

integernull

Response

200400

OK

Body

application/json

message*Message

dataData

objectnull

Request

JavaScriptCurlPython

const response = await fetch('https://sapphire.contextdata.ai/api/workspace/query', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "vector_store_identifier": "text",
      "vector_store_column": [
        "text"
      ],
      "embedding_model_identifier": "text",
      "query_text": "text"
    }),
});
const data = await response.json();

Response

200400

{
  "message": "text"
}