Models
List Models
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
Agents
Completions
Chat Completions
Models
- POSTExecute Model Deployment
- 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
- 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
- GETList Historical Test Cases
- DELWipe Full History of 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
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
- PATCHModify Parent For Application Spec
- 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
Models
List Models
Description
Lists all models accessible to the user.
Details
This API can be used to list models. If a user has access to multiple accounts, all models from all accounts the user is associated with will be returned.
GET
/
v4
/
models
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() {
// Automatically fetches more pages as needed.
for await (const modelInstanceWithViews of client.models.list()) {
console.log(modelInstanceWithViews.id);
}
}
main();{
"items": [
{
"model_group": {
"name": "<string>",
"description": "<string>",
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"account_id": "<string>",
"created_by_user_id": "<string>"
},
"deployments": [
{
"name": "<string>",
"model_creation_parameters": {},
"model_endpoint_id": "<string>",
"model_instance_id": "<string>",
"vendor_configuration": {
"min_workers": 0,
"max_workers": 1,
"per_worker": 10,
"vendor": "LAUNCH"
},
"deployment_metadata": {},
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"account_id": "<string>",
"created_by_user_id": "<string>",
"status": "<string>"
}
],
"name": "<string>",
"display_name": "<string>",
"model_vendor": "OPENAI",
"model_type": "COMPLETION",
"base_model_id": "<string>",
"base_model_metadata": {
"ui_model_section_type": "PARTNER",
"model_developer": "<string>",
"model_license_url": "<string>",
"delivery_date": "<string>",
"modelDetails": {
"number_of_parameters": 123,
"token_context_window": 123,
"languages": 123,
"alignments": 123
}
},
"model_creation_parameters": {},
"model_card": "<string>",
"training_data_card": "<string>",
"description": "<string>",
"model_template_id": "<string>",
"model_group_id": "<string>",
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"account_id": "<string>",
"created_by_user_id": "<string>",
"request_schema": {},
"response_schema": {},
"deployment_count": 123,
"supports_multi_turn": true
}
],
"total_item_count": 123,
"current_page": 123,
"items_per_page": 123
}Authorizations
Headers
Query Parameters
Available options:
Deployments, ModelGroup Available options:
display_name:asc, display_name:desc, model_vendor:asc, model_vendor:desc, base_model_id:asc, base_model_id:desc, base_model_metadata:asc, base_model_metadata:desc, model_creation_parameters:asc, model_creation_parameters:desc, model_card:asc, model_card:desc, training_data_card:asc, training_data_card:desc, description:asc, description:desc, model_template_id:asc, model_template_id:desc, model_group_id:asc, model_group_id:desc, model_group:asc, model_group:desc, request_schema:asc, request_schema:desc, response_schema:asc, response_schema:desc, deployment_count:asc, deployment_count:desc, supports_multi_turn:asc, supports_multi_turn:desc, deployments:asc, deployments:desc, id:asc, id:desc, created_at:asc, created_at:desc, account_id:asc, account_id:desc, created_by_user_id:asc, created_by_user_id:desc, created_by_user:asc, created_by_user:desc, name:asc, name:desc, model_type:asc, model_type:desc Page number for pagination to be returned by the given endpoint. Starts at page 1
Required range:
x > 1Maximum number of artifacts to be returned by the given endpoint. Defaults to 100 and cannot be greater than 10k.
Required range:
1 < x < 10000Response
200
application/json
Successful Response
The data returned for the current page.
An enum representing the different types of models supported.
Attributes: COMPLETION: Denotes that the model type is completion. CHAT_COMPLETION: Denotes that the model type is chat completion. AGENT: Denotes that the model type is agent. EMBEDDING: Denotes that the model type is embedding. RERANKING: Denotes that the model type is reranking. GENERIC: Denotes that the model type is generic.
Available options:
COMPLETION, CHAT_COMPLETION, AGENT, EMBEDDING, RERANKING, GENERIC The unique identifier of the entity.
The date and time when the entity was created in ISO format.
The ID of the account that owns the given entity.
The user who originally created the entity.
JSON schema for the requests to the model instance
JSON schema for the response to the model
Number of deployments of this model instance
True if a model supports multi-turn conversations natively
The unique identifier of the entity.
The date and time when the entity was created in ISO format.
The ID of the account that owns the given entity.
The user who originally created the entity.
The unique identifier of the entity.
The date and time when the entity was created in ISO format.
The ID of the account that owns the given entity.
The user who originally created the entity.
Status of the model's deployment.
The maximum number of concurrent requests that an individual worker can
service. Launch automatically scales the number of workers for the endpoint so that
each worker is processing per_worker requests, subject to the limits defined by
min_workers and max_workers.
- If the average number of concurrent requests per worker is lower than
per_worker, then the number of workers will be reduced. - Otherwise, if the average number of concurrent requests per worker is higher thanper_worker, then the number of workers will be increased to meet the elevated traffic.
Here is our recommendation for computing per_worker:
- Compute
min_workersandmax_workersper your minimum and maximum throughput requirements. 2. Determine a value for the maximum number of concurrent requests in the workload. Divide this number bymax_workers. Doing this ensures that the number of workers will "climb" tomax_workers.
Available options:
LAUNCH An enum representing the different types of model vendors supported.
Attributes: OPENAI: Denotes that the model vendor is OpenAI. COHERE: Denotes that the model vendor is Cohere. GOOGLE: Denotes that the model vendor is Google. ANTHROPIC: Denotes that the model vendor is Anthropic. LLMENGINE: Denotes that the model vendor is LLM Engine. OTHER: Denotes that the model vendor is Other.
Available options:
OPENAI, COHERE, GOOGLE, VERTEX_AI, ANTHROPIC, LAUNCH, LLMENGINE, BEDROCK, OTHER Available options:
PARTNER, OPENSOURCE, CUSTOM The total number of items of the query
The current page number.
The number of items per page.
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() {
// Automatically fetches more pages as needed.
for await (const modelInstanceWithViews of client.models.list()) {
console.log(modelInstanceWithViews.id);
}
}
main();{
"items": [
{
"model_group": {
"name": "<string>",
"description": "<string>",
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"account_id": "<string>",
"created_by_user_id": "<string>"
},
"deployments": [
{
"name": "<string>",
"model_creation_parameters": {},
"model_endpoint_id": "<string>",
"model_instance_id": "<string>",
"vendor_configuration": {
"min_workers": 0,
"max_workers": 1,
"per_worker": 10,
"vendor": "LAUNCH"
},
"deployment_metadata": {},
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"account_id": "<string>",
"created_by_user_id": "<string>",
"status": "<string>"
}
],
"name": "<string>",
"display_name": "<string>",
"model_vendor": "OPENAI",
"model_type": "COMPLETION",
"base_model_id": "<string>",
"base_model_metadata": {
"ui_model_section_type": "PARTNER",
"model_developer": "<string>",
"model_license_url": "<string>",
"delivery_date": "<string>",
"modelDetails": {
"number_of_parameters": 123,
"token_context_window": 123,
"languages": 123,
"alignments": 123
}
},
"model_creation_parameters": {},
"model_card": "<string>",
"training_data_card": "<string>",
"description": "<string>",
"model_template_id": "<string>",
"model_group_id": "<string>",
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"account_id": "<string>",
"created_by_user_id": "<string>",
"request_schema": {},
"response_schema": {},
"deployment_count": 123,
"supports_multi_turn": true
}
],
"total_item_count": 123,
"current_page": 123,
"items_per_page": 123
}