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
- GETGet Chunk and Artifact Information by Chunk ID
- 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
- POSTPublish Application Variant
ChatThreads
MonitoringDashboard
Chat Themes
account groups
JavaScript
Copy
Ask AI
import SGPClient from 'sgp';
const client = new SGPClient({
apiKey: 'My API Key',
});
const applicationSchema = await client.applicationSchemas.retrieve({ version: 'OFFLINE' });
console.log(applicationSchema);Copy
Ask AI
{}Applications
Get Application Schemas
GET
/
v4
/
application-schemas
JavaScript
Copy
Ask AI
import SGPClient from 'sgp';
const client = new SGPClient({
apiKey: 'My API Key',
});
const applicationSchema = await client.applicationSchemas.retrieve({ version: 'OFFLINE' });
console.log(applicationSchema);Copy
Ask AI
{}Authorizations
Query Parameters
An enum representing the version states of an application and its nodes' schemas. Attributes: V0: The initial version of an application schema. AGENTS_SERVICE: Application schema references egp_services definition. OFFLINE: Application schema for applications that do not run on SGP directly.
Available options:
OFFLINE, V0, AGENTS_SERVICE Response
Successful Response
Show child attributes
Show child attributes
Available options:
TEXT_INPUT_NODE, TEXT_OUTPUT_NODE, KNOWLEDGE_BASE_INPUT_NODE, KNOWLEDGE_BASE_NODE, MULTI_KNOWLEDGE_BASE_INPUT_NODE, MULTI_KNOWLEDGE_BASE_NODE, RERANKER_NODE, PROMPT_ENGINEERING_NODE, COMPLETION_MODEL_INPUT_NODE, COMPLETION_MODEL_NODE, EXTERNAL_ENDPOINT_NODE, DOCUMENT_INPUT_NODE, MAP_REDUCE_NODE, DOCUMENT_SEARCH_NODE, DOCUMENT_PROMPT_NODE An enum representing the version states of an application and its nodes' schemas. Attributes: V0: The initial version of an application schema. AGENTS_SERVICE: Application schema references egp_services definition. OFFLINE: Application schema for applications that do not run on SGP directly.
Available options:
OFFLINE, V0, AGENTS_SERVICE Show child attributes
Show child attributes
Show child attributes
Show child attributes
- NumberConfigurationFieldSchema
- StringConfigurationFieldSchema
- BoolConfigurationFieldSchema
Show child attributes
Show child attributes
Allowed value:
"NUMBER"Show child attributes
Show child attributes
Show child attributes
Show child attributes
Represents the possible types of values for an application configuration, inputs and outputs.
The available types are:
- TEXT: Represents a single line of text.
- STRING_ARRAY: Represents an array of strings.
- NUMBER: Represents a numeric value.
- BOOL: Represents a boolean value.
- CHUNK_ARRAY: Represents an array of chunks.
- DOCUMENT_ARRAY: Represents an array of documents.
- KNOWLEDGE_BASE_ID: Represents the ID of a knowledge base.
- KNOWLEDGE_BASE_ID_ARRAY: Represents an array of knowledge base IDs.
- COMPLETION_MODEL_ID: Represents the ID of a completion model.
Available options:
TEXT, STRING_ARRAY, NUMBER, BOOL, CHUNK_ARRAY, DOCUMENT_ARRAY, KNOWLEDGE_BASE_ID, KNOWLEDGE_BASE_ID_ARRAY, COMPLETION_MODEL_ID Show child attributes
Show child attributes
Show child attributes
Show child attributes
Represents the possible types of values for an application configuration, inputs and outputs.
The available types are:
- TEXT: Represents a single line of text.
- STRING_ARRAY: Represents an array of strings.
- NUMBER: Represents a numeric value.
- BOOL: Represents a boolean value.
- CHUNK_ARRAY: Represents an array of chunks.
- DOCUMENT_ARRAY: Represents an array of documents.
- KNOWLEDGE_BASE_ID: Represents the ID of a knowledge base.
- KNOWLEDGE_BASE_ID_ARRAY: Represents an array of knowledge base IDs.
- COMPLETION_MODEL_ID: Represents the ID of a completion model.
Available options:
TEXT, STRING_ARRAY, NUMBER, BOOL, CHUNK_ARRAY, DOCUMENT_ARRAY, KNOWLEDGE_BASE_ID, KNOWLEDGE_BASE_ID_ARRAY, COMPLETION_MODEL_ID Available options:
INPUT_NODE, OUTPUT_NODE, RAG_NODE ⌘I