Evaluation Result API

This documentation is valid for:

This API allows you to manage and retrieve evaluation results. It is useful to access the results of a specific Evaluation Plan or an individual Evaluation Result through its Id.

The following endpoints require a Globant Enterprise AI API token related to project scope.

Check the generic variables needed to use the API.

Endpoints

Method	Path	Description
GET	/evaluationResultApi/evaluationResults/{evaluationPlanId}	Retrieves a list of evaluation results for a given evaluation plan ID.
GET	/evaluationResultApi/evaluationResult/{evaluationResultId}	Retrieves a specific evaluation result by its ID.

GET/evaluationResultApi/evaluationResults/{evaluationPlanId}

Retrieves a list of evaluation results associated with a specific evaluation plan.

Request

Method: GET
Path: /evaluationResultApi/evaluationResults/{evaluationPlanId}
Request Body: Empty

Returns a JSON array of EvaluationResult objects. Each object represents a single evaluation result within the specified plan. If no results are found, an empty array [] is returned. Error responses (non-200 status codes) will provide details in the response body.

[
  {
    "dataSetId": "UUID",
    "evaluationPlanAssistantName": "string",
    "evaluationPlanId": "UUID",
    "evaluationResultAssitantRevision": "string",
    "evaluationResultChunckCount": "integer",
    "evaluationResultChunckSize": "string",
    "evaluationResultCost": "number",
    "evaluationResultDuration": "integer",
    "evaluationResultEndDate": "string",
    "evaluationResultId": "UUID",
    "evaluationResultModelName": "string",
    "evaluationResultProviderName": "string",
    "evaluationResultStartDate": "string",
    "evaluationResultStatus": "string",
    "evaluationResultTemperature": "number",
    "evaluationResultUploadFiles": "boolean",
    "evaluationResultaMaxTokens": "string"
  }
]

cURL Sample

curl -X GET "$BASE_URL/evaluationResultApi/evaluationResults/$global_evaluation_plan_id" \
  -H "Authorization: Bearer $SAIA_PROJECT_APITOKEN" \
  -H "Accept: application/json"

GET/evaluationResultApi/evaluationResult/{evaluationResultId}

Retrieves a specific evaluation result by its ID.

Request

Method: GET
Path: /evaluationResultApi/evaluationResults/{evaluationPlanId}
Request Body: Empty

Response

Returns a single EvaluationResult object with detailed information, including row-level data.

{
  "dataSetId": "UUID",
  "evaluationPlanAssistantName": "string",
  "evaluationPlanId": "UUID",
  "evaluationResultAssitantRevision": "string",
  "evaluationResultChunckCount": "integer",
  "evaluationResultChunckSize": "string",
  "evaluationResultCost": "number",
  "evaluationResultDuration": "integer",
  "evaluationResultEndDate": "string",
  "evaluationResultId": "UUID",
  "evaluationResultModelName": "string",
  "evaluationResultProviderName": "string",
  "evaluationResultStartDate": "string",
  "evaluationResultStatus": "string",
  "evaluationResultTemperature": "number",
  "evaluationResultUploadFiles": "boolean",
  "evaluationResultaMaxTokens": "string",
  "rows": [
    {
      "dataSetRowId": "UUID",
      "evaluationResultRowCost": "number",
      "evaluationResultRowEndDate": "string",
      "evaluationResultRowOutput": "string",
      "evaluationResultRowStartDate": "string",
      "evaluationResultRowStatus": "string"
    }
  ]
}

cURL Sample

curl -X GET "$BASE_URL/evaluationResultApi/evaluationResult/$global_evaluation_result_id" \
  -H "Authorization: $SAIA_PROJECT_APITOKEN" \
  -H "Accept: application/json"