Query sessions

Get Query Sessions

Get all Query Sessions

get

/api/workspace/query_sessions

Authorizations

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://sapphire.contextdata.ai/api/workspace/query_sessions' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

No body

OK

Create Query Session

Create a new Query Session

post

/api/workspace/query_session/create

Authorizations

Body

session_namestringrequired

Provide a unique name to identify your session

vector_store_identifierstringrequired

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

vector_store_columnstringrequired

Specify the column/field in the target vector store connection

embedding_model_identifierstringrequired

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

chat_model_identifierstringrequired

Chat Model identifier. Get the UUID from the '/chat_models' endpoint

temperaturenumberrequired

Enter your desired temperature

system_messageany ofrequired

[Optional] Add an initial system message to the session

response_limitany ofrequired

max_tokensany ofrequired

[Optional] Enter the maximum number of tokens for each query and response

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://sapphire.contextdata.ai/api/workspace/query_session/create' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "session_name": "text",
    "vector_store_identifier": "text",
    "vector_store_column": "text",
    "embedding_model_identifier": "text",
    "chat_model_identifier": "text",
    "temperature": 1,
    "system_message": "text",
    "response_limit": 1,
    "max_tokens": 1
  }'

200

400

200

{
  "message": "text",
  "data": {}
}

OK

Session Chat

Conduct a RAG Interaction with your Query Session

post

/api/workspace/session_chat/{session_identifier}

Authorizations

Path parameters

session_identifierstringrequired

Body

query_textstringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://sapphire.contextdata.ai/api/workspace/session_chat/{session_identifier}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "query_text": "text"
  }'

200

400

200

{
  "message": "text",
  "data": {}
}

OK

Get Session History

Get Query Session History

get

/api/workspace/session_history/{session_identifier}

Authorizations

Path parameters

session_identifierstringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://sapphire.contextdata.ai/api/workspace/session_history/{session_identifier}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

No body

OK