import SGPClient from 'sgp';
const client = new SGPClient({
apiKey: 'My API Key',
});
const modelInstanceWithViews = await client.models.retrieve('model_id');
console.log(modelInstanceWithViews.id);
{
"model_group": {
"name": "<string>",
"description": "<string>",
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"account_id": "<string>",
"created_by_user_id": "<string>",
"created_by_identity_type": "user"
},
"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>",
"created_by_identity_type": "user",
"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>",
"created_by_identity_type": "user",
"request_schema": {},
"response_schema": {},
"deployment_count": 123,
"supports_multi_turn": true
}
Gets the details of a model
This API can be used to get information about a single model by ID. To use this API, pass in the id
that was returned from your Create Model API call as a path parameter.
Review the response schema to see the fields that will be returned.
import SGPClient from 'sgp';
const client = new SGPClient({
apiKey: 'My API Key',
});
const modelInstanceWithViews = await client.models.retrieve('model_id');
console.log(modelInstanceWithViews.id);
{
"model_group": {
"name": "<string>",
"description": "<string>",
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"account_id": "<string>",
"created_by_user_id": "<string>",
"created_by_identity_type": "user"
},
"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>",
"created_by_identity_type": "user",
"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>",
"created_by_identity_type": "user",
"request_schema": {},
"response_schema": {},
"deployment_count": 123,
"supports_multi_turn": true
}
Show child attributes
Successful Response
The response is of type object
.