/agents/{id}/evaluate

Create Evaluation

Launch an Evaluation job which evaluates an Agent on a set of test questions and reference answers.

An Evaluation is an asynchronous operation. Users can select one or more metrics to assess the quality of generated answers. These metrics include equivalence and groundedness. equivalence evaluates if the Agent response is equivalent to the ground truth (model-driven binary classification). groundedness decomposes the Agent response into claims and then evaluates if the claims are grounded by the retrieved documents.

Evaluation data can be provided in one of two forms:

  • A CSV evalset_file containing the columns prompt (i.e. questions) and reference (i.e. gold-answers).

  • An evalset_name which refers to a Dataset created through the /datasets/evaluate API.

post/agents/{agent_id}/evaluate

Path parameters

agent_idstring uuid required

Agent ID of the agent to evaluate

Agent ID of the agent to evaluate

Response

Successful Response

idstring uuid required

ID of the launched evaluation

Changes