import SGPClient from 'sgp';
const client = new SGPClient({
apiKey: process.env['SGP_API_KEY'], // This is the default and can be omitted
});
// Automatically fetches more pages as needed.
for await (const modelInstanceWithViews of client.models.list()) {
console.log(modelInstanceWithViews.id);
}
{
"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
}
Lists all models accessible to the user.
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.
import SGPClient from 'sgp';
const client = new SGPClient({
apiKey: process.env['SGP_API_KEY'], // This is the default and can be omitted
});
// Automatically fetches more pages as needed.
for await (const modelInstanceWithViews of client.models.list()) {
console.log(modelInstanceWithViews.id);
}
{
"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
}
Show child attributes
Show child attributes
Page number for pagination to be returned by the given endpoint. Starts at page 1
x >= 1
Maximum number of artifacts to be returned by the given endpoint. Defaults to 100 and cannot be greater than 10k.
1 <= x <= 10000
Successful Response
The response is of type object
.