Knowledge Bases
- GETList Knowledge Bases
- POSTCreate Knowledge Base
- GETGet Knowledge Base
- DELDelete Knowledge Base
- PATCHPatch Knowledge Base
- GETList Upload Jobs
- GETGet Chunks
- POSTQuery Relevant Chunks
- POSTDelete Knowledge Base Data Source Connection
- POSTSubmit Upload Job with local files
- GETList Upload Jobs
- POSTSubmit Upload Job
- GETGet Upload Job
- POSTCancel Upload Job
- GETList Tracked Artifacts
- GETGet Tracked Artifact Details
- DELDelete Locally Stored Artifact
- PATCHPatch Artifact Information
- GETList Chunks of Artifacts with Pagination
- POSTCreate chunk for local chunk artifacts
- GETGet Single Chunk Information and status
- PUTUpdate Single Chunk data for local artifact
- DELDelete Single Chunk from Local Artifact
- POSTTest Knowledge Base Data Source credentials
- POSTBatch Delete Locally Stored Artifacts
- GETList Upload Schedules
- POSTCreate Upload Schedule
- GETGet Upload Schedule
- DELDelete Upload Schedule
- PATCHUpdate Upload Schedule
Chunks
Agents
Completions
Chat Completions
Models
- POSTExecute Model Deployment
- POSTExecute Model Deployment Async and Return the Async Run ID
- GETPoll Async Inference for result
- POSTGenerate text embedding
- POSTGenerate reranking
- POSTGenerate completion
- POSTGenerate chat completion
- GETList Model Deployments of a Model
- POSTDeploy Model
- GETGet Model usage by model name
- GETList All Model Deployments
- GETGet Model usage for one deployment
- POSTAdd model to group
- GETGet Model usage for a group
- GETList Models
- POSTCreate Model
- GETGet Model
- DELDelete Model
- PATCHUpdate Model
- GETList Model Groups
- POSTCreate Model Group
- GETGet Model Group
- DELDelete Model Group
- PATCHUpdate Model Group
- GETGet Deployment
- DELDelete Deployment
- PATCHUpdate Deployment
Accounts
Organizations
Question Sets
Evaluations
- POSTClaim Evaluation Task
- PATCHBatch assign tasks to user
- PATCHUpdate Evaluation Task
- GETGet Contributor Metrics
- GETList Contributor Metrics
- GETGet Evaluation Metrics
- GETGet Hybrid Evaluation Metrics
- GETList Evaluations
- POSTCreate Evaluation
- GETGet Evaluation
- DELDelete Evaluation
- PATCHUpdate Evaluation
- GETList Test Case Results
- POSTCreate Test Case Result
- POSTBatch Create Test Case Results
- GETGet Test Case Result
- PATCHUpdate Test Case Result
- GETGet Historical Test Case Result
- GETGet All Versions of Test Case Result
- GETList Historical Test Case Results
Evaluation Configs
Evaluation Datasets
- GETList Evaluation Datasets
- POSTCreate Evaluation Dataset
- GETGet Evaluation Dataset
- DELDelete Evaluation Dataset
- PATCHUpdate Evaluation Dataset
- GETList Evaluation Dataset Versions
- POSTCreate Evaluation Dataset Version
- GETGet Evaluation Dataset Version
- GETList Test Cases
- POSTCreate Test Case
- POSTBatch Create Test Cases
- GETGet Test Case
- DELDelete Test Case
- PATCHUpdate Test Case
- GETGet Historical Test Case
- GETGet All Versions of Test Case
- DELWipe Full History of Test Cases
- GETList Historical Test Cases
- GETList Autogenerated Draft Test Cases
- POSTCreate Autogenerated Draft Test Case
- GETGet Autogenerated Draft Test Case
- DELDelete Autogenerated Draft Test Case
- PATCHUpdate Autogenerated Draft Test Case
- POSTApprove Autogenerated Draft Test Case
- POSTPublish Latest Evaluation Dataset Version
- POSTApprove Auto Generated Test Cases Batch
- GETGet Evaluation Dataset Generation Jobs
- POSTCreate Evaluation Dataset Generation Job
- GETGet Evaluation Dataset Generation Job
- POSTCancel Evaluation Dataset Generation Job
- POSTPublish Evaluation Dataset Version
Studio Projects
Application Specs
Knowledge Base Data Sources
Model Templates V3 (Beta)
Model server
- POSTFixed Server interface for Model execution
- POSTFixed Server interface for async Model execution
- GETPoll Async Inference for result
- POSTFixed Server interface for Model execution by named alias
- POSTFixed Server interface for async Model execution by named alias
- GETPoll Async Inference for result by named alias
- POSTCreate a new Model Server
- GETGet current deployment of the Model Server
- PUTChange backend of the Model Server
- POSTRollback backend of the Model Server
API Reference
Fine Tuning Jobs V3 (Beta)
Training Datasets V3 (Beta)
package deployments
Beta
Applications
- GETList Application Variants
- POSTCreate Application Variant
- GETGet Application Variant
- DELDelete Application Variant
- PATCHUpdate Application Variant
- GETList Application Deployments
- POSTCreate Application Deployment
- GETGet Application Deployment
- PATCHUpdate Application Deployment
- GETList Application Variant Reports
- POSTCreate Application Variant Report
- GETGet Application Variant Report
- GETList Application Test Case Outputs
- POSTBatch Create Application Test Case Outputs
- GETGet Application Test Case Output
- POSTCreate Application With Variant
- GETGet Application Schemas
- POSTProcess Application
- POSTProcess Application By Id
- POSTProcess Deployed Application For Thread
- POSTProcess Application By Alias
- POSTValidate Application
- GETList Application Threads
- POSTCreate New Application Thread
- POSTUpload Application Files
- PATCHPatch Application Variant Guardrails
- POSTPublish Application Variant
ChatThreads
Interactions
MonitoringDashboard
Chat Themes
account groups
Interactions
Create Application Interaction
POST
/
v4
/
interactions
import SGPClient from 'sgp';
const client = new SGPClient({
apiKey: process.env['SGP_API_KEY'], // This is the default and can be omitted
});
async function main() {
const interaction = await client.interactions.create({
application_variant_id: 'application_variant_id',
input: { query: 'query' },
output: { response: 'response' },
start_timestamp: '2019-12-27T18:11:19.117Z',
});
console.log(interaction.id);
}
main();
{
"application_variant_id": "<string>",
"thread_id": "<string>",
"input": {
"query": "<string>"
},
"output": {
"response": "<string>",
"context": [
{
"text": "<string>",
"score": 123
}
]
},
"start_timestamp": "2023-11-07T05:31:56Z",
"duration_ms": 0,
"operation_status": "SUCCESS",
"operation_metadata": {},
"trace_spans": [
{
"node_id": "<string>",
"operation_type": "COMPLETION",
"operation_status": "SUCCESS",
"start_timestamp": "2023-11-07T05:31:56Z",
"end_timestamp": "2023-11-07T05:31:56Z",
"operation_input": {},
"operation_output": {},
"operation_metadata": {},
"duration_ms": 0,
"id": "<string>",
"application_interaction_id": "<string>"
}
],
"guardrail_results": [
{
"id": "<string>",
"guardrail_id": "<string>",
"application_spec_id": "<string>",
"application_variant_id": "<string>",
"application_interaction_id": "<string>",
"policy_id": "<string>",
"severity": "low",
"triggered": true,
"score": 123,
"description": "<string>",
"result_metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"guardrail": {
"id": "<string>",
"account_id": "<string>",
"description": "<string>",
"check_type": "input",
"guardrail_metadata": {},
"is_archived": true,
"created_at": "2023-11-07T05:31:56Z"
},
"policy": {
"id": "<string>",
"description": "<string>",
"category": "<string>",
"unsafe_threshold": 123,
"guardrail_policy_metadata": {},
"guardrail_id": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}
}
],
"id": "<string>"
}
Authorizations
Headers
Body
application/json
Represents an interaction performed with an application, including input, output, and associated metadata.
Response
200
application/json
Successful Response
Model representing an interaction entity.
import SGPClient from 'sgp';
const client = new SGPClient({
apiKey: process.env['SGP_API_KEY'], // This is the default and can be omitted
});
async function main() {
const interaction = await client.interactions.create({
application_variant_id: 'application_variant_id',
input: { query: 'query' },
output: { response: 'response' },
start_timestamp: '2019-12-27T18:11:19.117Z',
});
console.log(interaction.id);
}
main();
{
"application_variant_id": "<string>",
"thread_id": "<string>",
"input": {
"query": "<string>"
},
"output": {
"response": "<string>",
"context": [
{
"text": "<string>",
"score": 123
}
]
},
"start_timestamp": "2023-11-07T05:31:56Z",
"duration_ms": 0,
"operation_status": "SUCCESS",
"operation_metadata": {},
"trace_spans": [
{
"node_id": "<string>",
"operation_type": "COMPLETION",
"operation_status": "SUCCESS",
"start_timestamp": "2023-11-07T05:31:56Z",
"end_timestamp": "2023-11-07T05:31:56Z",
"operation_input": {},
"operation_output": {},
"operation_metadata": {},
"duration_ms": 0,
"id": "<string>",
"application_interaction_id": "<string>"
}
],
"guardrail_results": [
{
"id": "<string>",
"guardrail_id": "<string>",
"application_spec_id": "<string>",
"application_variant_id": "<string>",
"application_interaction_id": "<string>",
"policy_id": "<string>",
"severity": "low",
"triggered": true,
"score": 123,
"description": "<string>",
"result_metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"guardrail": {
"id": "<string>",
"account_id": "<string>",
"description": "<string>",
"check_type": "input",
"guardrail_metadata": {},
"is_archived": true,
"created_at": "2023-11-07T05:31:56Z"
},
"policy": {
"id": "<string>",
"description": "<string>",
"category": "<string>",
"unsafe_threshold": 123,
"guardrail_policy_metadata": {},
"guardrail_id": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}
}
],
"id": "<string>"
}
Assistant
Responses are generated using AI and may contain mistakes.