Download OpenAPI specification:Download
Login using your Context Data user login and generate your token
username required | string (Username) <= 150 characters Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. |
password required | string (Password) |
{- "username": "string",
- "password": "string"
}
Run a vector search query on configured target connection
vector_store_identifier required | string (Vector Store Identifier) Vector Store (Target Connection) identifier. Get the UUID from the '/target_connections' endpoint |
vector_store_column required | Array of strings (Vector Store Column) Specify the columns/fields in the target vector store connection |
embedding_model_identifier required | string (Embedding Model Identifier) Embedding model identifier. Get the UUID from the '/embedding_models' endpoint |
query_text required | string (Query Text) Your query text |
Response Limit (integer) or Response Limit (null) (Response Limit) |
{- "vector_store_identifier": "string",
- "vector_store_column": [
- "string"
], - "embedding_model_identifier": "string",
- "query_text": "string",
- "response_limit": 0
}
{- "message": "string",
- "data": { }
}
Create a new Query Session
session_name required | string (Session Name) Provide a unique name to identify your session |
vector_store_identifier required | string (Vector Store Identifier) Vector Store (Target Connection) identifier. Get the UUID from the '/target_connections' endpoint |
vector_store_column required | string (Vector Store Column) Specify the column/field in the target vector store connection |
embedding_model_identifier required | string (Embedding Model Identifier) Embedding model identifier. Get the UUID from the '/embedding_models' endpoint |
required | System Message (string) or System Message (null) (System Message) [Optional] Add an initial system message to the session |
chat_model_identifier required | string (Chat Model Identifier) Chat Model identifier. Get the UUID from the '/chat_models' endpoint |
required | Response Limit (integer) or Response Limit (null) (Response Limit) |
required | Max Tokens (integer) or Max Tokens (null) (Max Tokens) [Optional] Enter the maximum number of tokens for each query and response |
temperature required | number (Temperature) > 0 Enter your desired temperature |
{- "session_name": "string",
- "vector_store_identifier": "string",
- "vector_store_column": "string",
- "embedding_model_identifier": "string",
- "system_message": "string",
- "chat_model_identifier": "string",
- "response_limit": 0,
- "max_tokens": 0,
- "temperature": 0
}
{- "message": "string",
- "data": { }
}
Conduct a RAG Interaction with your Query Session
session_identifier required | string (Session Identifier) |
query_text required | string (Query Text) |
{- "query_text": "string"
}
{- "message": "string",
- "data": { }
}