Query sessions

Get Query Sessions

Get all Query Sessions

GEThttps://sapphire.contextdata.ai/api/workspace/query_sessions

Authorization

AuthBearer

Response

200

OK

Request

JavaScriptCurlPython

const response = await fetch('https://sapphire.contextdata.ai/api/workspace/query_sessions', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Create Query Session

Create a new Query Session

POSThttps://sapphire.contextdata.ai/api/workspace/query_session/create

Authorization

AuthBearer

Body

application/json

session_name*Session Name

Provide a unique name to identify your session

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 column/field in the target vector store connection

embedding_model_identifier*Embedding Model Identifier

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

system_message*System Message

[Optional] Add an initial system message to the session

stringnull

chat_model_identifier*Chat Model Identifier

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

response_limit*Response Limit

integernull

max_tokens*Max Tokens

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

integernull

temperature*Temperature

Enter your desired temperature

Response

200400

OK

Body

application/json

message*Message

dataData

objectnull

Request

JavaScriptCurlPython

const response = await fetch('https://sapphire.contextdata.ai/api/workspace/query_session/create', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "session_name": "text",
      "vector_store_identifier": "text",
      "vector_store_column": "text",
      "embedding_model_identifier": "text",
      "system_message": "text",
      "chat_model_identifier": "text",
      "response_limit": 0,
      "max_tokens": 0,
      "temperature": 0
    }),
});
const data = await response.json();

Response

200400

{
  "message": "text"
}

Session Chat

Conduct a RAG Interaction with your Query Session

POSThttps://sapphire.contextdata.ai/api/workspace/session_chat/{session_identifier}

Authorization

AuthBearer

Path parameters

session_identifier*Session Identifier

Body

application/json

query_text*Query Text

Response

200400

OK

Body

application/json

message*Message

dataData

objectnull

Request

JavaScriptCurlPython

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

Response

200400

{
  "message": "text"
}

Get Session History

Get Query Session History

GEThttps://sapphire.contextdata.ai/api/workspace/session_history/{session_identifier}

Authorization

AuthBearer

Path parameters

session_identifier*Session Identifier

Response

200

OK

Request

JavaScriptCurlPython

const response = await fetch('https://sapphire.contextdata.ai/api/workspace/session_history/{session_identifier}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();