import SGPClient from 'sgp';
const client = new SGPClient({
apiKey: 'My API Key',
});
// Automatically fetches more pages as needed.
for await (const modelTemplate of client.modelTemplates.list()) {
console.log(modelTemplate.id);
}
{
"items": [
{
"name": "<string>",
"endpoint_type": "SYNC",
"model_type": "COMPLETION",
"vendor_configuration": {
"vendor": "LAUNCH",
"bundle_config": {
"registry": "<string>",
"image": "<string>",
"tag": "<string>",
"command": [
"<string>"
],
"env": {},
"streaming_command": [
"<string>"
],
"readiness_initial_delay_seconds": 120,
"healthcheck_route": "/readyz",
"predict_route": "/predict",
"streaming_predict_route": "/generate_streaming"
},
"endpoint_config": {
"cpus": 3,
"memory": "8Gi",
"storage": "16Gi",
"gpus": 0,
"gpu_type": "nvidia-tesla-t4",
"min_workers": 0,
"max_workers": 1,
"per_worker": 10,
"endpoint_type": "ASYNC",
"high_priority": false
},
"fine_tuning_job_bundle_config": {
"registry": "<string>",
"image": "<string>",
"tag": "<string>",
"command": [
"<string>"
],
"env": {},
"mount_location": "/workspace/launch_specific/config.json",
"training_dataset_schema_type": "GENERATION",
"resources": {
"cpus": 3,
"memory": "8Gi",
"storage": "16Gi",
"gpus": 0,
"gpu_type": "nvidia-tesla-t4"
}
}
},
"model_creation_parameters_schema": {
"parameters": [
{
"name": "<string>",
"type": "str",
"description": "<string>",
"required": true
}
]
},
"model_request_parameters_schema": {
"parameters": [
{
"name": "<string>",
"type": "str",
"description": "<string>",
"required": true
}
]
},
"endpoint_protocol": "SGP",
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"account_id": "<string>",
"created_by_user_id": "<string>",
"created_by_identity_type": "user"
}
],
"total_item_count": 123,
"current_page": 123,
"items_per_page": 123
}
Lists all model templates accessible to the user.
This API can be used to list model templates. If a user has access to multiple accounts, all model templates from all accounts the user is associated with will be returned.
import SGPClient from 'sgp';
const client = new SGPClient({
apiKey: 'My API Key',
});
// Automatically fetches more pages as needed.
for await (const modelTemplate of client.modelTemplates.list()) {
console.log(modelTemplate.id);
}
{
"items": [
{
"name": "<string>",
"endpoint_type": "SYNC",
"model_type": "COMPLETION",
"vendor_configuration": {
"vendor": "LAUNCH",
"bundle_config": {
"registry": "<string>",
"image": "<string>",
"tag": "<string>",
"command": [
"<string>"
],
"env": {},
"streaming_command": [
"<string>"
],
"readiness_initial_delay_seconds": 120,
"healthcheck_route": "/readyz",
"predict_route": "/predict",
"streaming_predict_route": "/generate_streaming"
},
"endpoint_config": {
"cpus": 3,
"memory": "8Gi",
"storage": "16Gi",
"gpus": 0,
"gpu_type": "nvidia-tesla-t4",
"min_workers": 0,
"max_workers": 1,
"per_worker": 10,
"endpoint_type": "ASYNC",
"high_priority": false
},
"fine_tuning_job_bundle_config": {
"registry": "<string>",
"image": "<string>",
"tag": "<string>",
"command": [
"<string>"
],
"env": {},
"mount_location": "/workspace/launch_specific/config.json",
"training_dataset_schema_type": "GENERATION",
"resources": {
"cpus": 3,
"memory": "8Gi",
"storage": "16Gi",
"gpus": 0,
"gpu_type": "nvidia-tesla-t4"
}
}
},
"model_creation_parameters_schema": {
"parameters": [
{
"name": "<string>",
"type": "str",
"description": "<string>",
"required": true
}
]
},
"model_request_parameters_schema": {
"parameters": [
{
"name": "<string>",
"type": "str",
"description": "<string>",
"required": true
}
]
},
"endpoint_protocol": "SGP",
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"account_id": "<string>",
"created_by_user_id": "<string>",
"created_by_identity_type": "user"
}
],
"total_item_count": 123,
"current_page": 123,
"items_per_page": 123
}
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
.