import SGPClient from 'sgp';
const client = new SGPClient({
apiKey: 'My API Key',
});
const evaluation = await client.evaluations.create({
account_id: 'account_id',
application_spec_id: 'application_spec_id',
application_variant_id: 'application_variant_id',
description: 'description',
evaluation_dataset_id: 'evaluation_dataset_id',
name: 'name',
});
console.log(evaluation.id);
{
"name": "<string>",
"description": "<string>",
"status": "PENDING",
"application_spec_id": "<string>",
"application_variant_id": "<string>",
"tags": {},
"evaluation_config": {},
"evaluation_config_id": "<string>",
"completed_at": "2023-11-07T05:31:56Z",
"total_test_case_result_count": 123,
"completed_test_case_result_count": 123,
"annotation_config": {
"annotation_config_type": "generation",
"components": [
[
{
"optional": true,
"data_loc": [
"<string>"
],
"label": "<string>"
}
]
],
"direction": "col",
"llm_prompt": {
"variables": [
{
"name": "<string>",
"optional": true,
"data_loc": [
"<string>"
]
}
],
"template": "<string>"
}
},
"question_id_to_annotation_config": {},
"metric_config": {
"components": [
{
"type": "rouge",
"name": "<string>",
"mappings": {},
"params": {}
}
]
},
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"account_id": "<string>",
"created_by_user_id": "<string>",
"created_by_identity_type": "user",
"archived_at": "2023-11-07T05:31:56Z"
}
Creates a evaluation
This API can be used to create a evaluation. To use this API, review the request schema and pass in all fields that are required to create a evaluation.
import SGPClient from 'sgp';
const client = new SGPClient({
apiKey: 'My API Key',
});
const evaluation = await client.evaluations.create({
account_id: 'account_id',
application_spec_id: 'application_spec_id',
application_variant_id: 'application_variant_id',
description: 'description',
evaluation_dataset_id: 'evaluation_dataset_id',
name: 'name',
});
console.log(evaluation.id);
{
"name": "<string>",
"description": "<string>",
"status": "PENDING",
"application_spec_id": "<string>",
"application_variant_id": "<string>",
"tags": {},
"evaluation_config": {},
"evaluation_config_id": "<string>",
"completed_at": "2023-11-07T05:31:56Z",
"total_test_case_result_count": 123,
"completed_test_case_result_count": 123,
"annotation_config": {
"annotation_config_type": "generation",
"components": [
[
{
"optional": true,
"data_loc": [
"<string>"
],
"label": "<string>"
}
]
],
"direction": "col",
"llm_prompt": {
"variables": [
{
"name": "<string>",
"optional": true,
"data_loc": [
"<string>"
]
}
],
"template": "<string>"
}
},
"question_id_to_annotation_config": {},
"metric_config": {
"components": [
{
"type": "rouge",
"name": "<string>",
"mappings": {},
"params": {}
}
]
},
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"account_id": "<string>",
"created_by_user_id": "<string>",
"created_by_identity_type": "user",
"archived_at": "2023-11-07T05:31:56Z"
}
Successful Response
The response is of type object
.