Sign in
Metric

Evaluate metrics

Evaluate the latest versions of specified metrics for a completed conversation. The results will be stored and retrievable through the GetMetricEvaluationResults endpoint with a special source type of manual.

If the same conversation has been manually evaluated for the same metric, the previous evaluation result will be overwritten.

Permissions

This endpoint requires the following permissions:

  • Metric:GetMetric for the metrics.
  • Metric:EvaluateMetric for the metrics.
  • Metric:GetMetricEvaluationResult for the metric results.
post/v1/{organization}/metric/evaluate

Path parameters

organizationstring required

Headers

x-mongo-cluster-namestring nullable

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

Sec-WebSocket-Protocolstring[]

Request body

metric_idsstring[] required

The IDs of the metrics to evaluate.

conversation_idstring required

The ID of the conversation to evaluate the metrics for.

evaluate_to_interaction_idstring nullable

If specified, only messages up to (and including) this interaction will be evaluated.

Response

Succeeded.

Changes

No recorded changes to this endpoint across all 17 revisions of this API.