REST Resource: projects.locations.brands.evaluationCaseResults

Resource: EvaluationCaseResult

An evaluation case result.

JSON representation 
{
  "name": string,
  "evaluationCase": {
    object (EvaluationCase)
  },
  "evaluationContext": {
    object (EvaluationContext)
  },
  "evaluationDataset": string,
  "sessionRecord": string,
  "status": enum (Status),
  "matcherResults": [
    {
      object (MatcherResult)
    }
  ]
}
Fields
name

string

Identifier. The resource name of the evaluation case result. Format: projects/{project}/locations/{location}/brands/{brand}/evaluationCaseResults/{evaluation_case_result}
evaluationCase

object (EvaluationCase)

Output only. The evaluation case this result is associated with.
evaluationContext

object (EvaluationContext)

Output only. The evaluation context this result is associated with.
evaluationDataset

string

Output only. The evaluation dataset reference this result is associated with. If not set, it means the test case is run as a standalone test, not as part of an evaluation dataset. Format: projects/{project}/locations/{location}/brands/{brand}/evaluationDatasets/{evaluationDataset}
sessionRecord

string

Output only. The resource name of the session record this result is associated with. Format: projects/{project}/locations/{location}/brands/{brand}/sessionRecords/{sessionRecord}
status

enum (Status)

Output only. The status of the evaluation case.
matcherResults[]

object (MatcherResult)

Output only. The list of evaluation matcher results for the evaluation case. The results of the evaluation matchers.

Status

The status of the evaluation case.

Enums
STATUS_UNSPECIFIED Invalid status.
PASS All the evaluation matchers are satisfied.
FAIL At least one of the evaluation matchers is not satisfied.
ERROR There was an error that the BidiProcessOrder session terminated unexpectedly and the evaluation could not be completed.

MatcherResult

A result of an evaluation matcher.

JSON representation 
{
  "evaluationMatcher": {
    object (EvaluationMatcher)
  },

  // Union field result can be only one of the following:
  "orderResultMatcherResult": {
    object (OrderResultMatcherResult)
  },
  "agentUtteranceStringMatcherResult": {
    object (AgentUtteranceStringMatcherResult)
  },
  "llmJudgementMatcherResult": {
    object (LLMJudgementMatcherResult)
  }
  // End of list of possible types for union field result.
}
Fields
evaluationMatcher

object (EvaluationMatcher)

Output only. The evaluation matcher this result is associated with.
Union field result. The result of the evaluation matcher. result can be only one of the following:
orderResultMatcherResult

object (OrderResultMatcherResult)

Output only. The result of an order result matcher.
agentUtteranceStringMatcherResult

object (AgentUtteranceStringMatcherResult)

Output only. The result of an agent utterance string matcher.
llmJudgementMatcherResult

object (LLMJudgementMatcherResult)

Output only. The result of an agent utterance LLM judgement matcher.

OrderResultMatcherResult

A result of an order result matcher.

JSON representation 
{
  "match": boolean,
  "difference": string
}
Fields
match

boolean

Output only. Whether the order result matcher passed or not.
difference

string

Output only. The pretty printed difference between the expected order and the actual order in the order result matcher in the (-want +got) format.

AgentUtteranceStringMatcherResult

A result of an agent utterance string matcher.

JSON representation 
{
  "match": boolean
}
Fields
match

boolean

Output only. Whether the agent utterance string matcher passed or not.

LLMJudgementMatcherResult

A result of an agent utterance LLM judgement matcher.

JSON representation 
{
  "match": boolean
}
Fields
match

boolean

Output only. Whether the agent utterance LLM judgement matcher passed or not.

Methods

delete

 Deletes the specified EvaluationCaseResult.

get

 Gets an EvaluationCaseResult.

list

 Lists EvaluationCaseResults.