Class EvaluationResult (0.3.0) 

EvaluationResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)

An evaluation result represents the output of running an Evaluation.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name Description
golden_result google.cloud.ces_v1beta.types.EvaluationResult.GoldenResult
Output only. The outcome of a golden evaluation. This field is a member of oneof_ result.
scenario_result google.cloud.ces_v1beta.types.EvaluationResult.ScenarioResult
Output only. The outcome of a scenario evaluation. This field is a member of oneof_ result.
name str
Identifier. The unique identifier of the evaluation result. Format: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{result}
display_name str
Required. Display name of the Evaluation Result. Unique within an Evaluation. By default, it has the following format: "
create_time google.protobuf.timestamp_pb2.Timestamp
Output only. Timestamp when the evaluation result was created.
evaluation_status google.cloud.ces_v1beta.types.EvaluationResult.Outcome
Output only. The outcome of the evaluation. Only populated if execution_state is COMPLETE.
evaluation_run str
Output only. The evaluation run that produced this result. Format: projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluationRun}
persona google.cloud.ces_v1beta.types.EvaluationPersona
Output only. The persona used to generate the conversation for the evaluation result.
error_info google.cloud.ces_v1beta.types.EvaluationErrorInfo
Output only. Error information for the evaluation result.
error google.rpc.status_pb2.Status
Output only. Deprecated: Use error_info instead. Errors encountered during execution.
initiated_by str
Output only. The user who initiated the evaluation run that resulted in this result.
app_version str
Output only. The app version used to generate the conversation that resulted in this result. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version}
app_version_display_name str
Output only. The display name of the app_version that the evaluation ran against.
changelog str
Output only. The changelog of the app version that the evaluation ran against. This is populated if user runs evaluation on latest/draft.
changelog_create_time google.protobuf.timestamp_pb2.Timestamp
Output only. The create time of the changelog of the app version that the evaluation ran against. This is populated if user runs evaluation on latest/draft.
execution_state google.cloud.ces_v1beta.types.EvaluationResult.ExecutionState
Output only. The state of the evaluation result execution.
evaluation_metrics_thresholds google.cloud.ces_v1beta.types.EvaluationMetricsThresholds
Output only. The evaluation thresholds for the result.
config google.cloud.ces_v1beta.types.EvaluationConfig
Output only. The configuration used in the evaluation run that resulted in this result.
golden_run_method google.cloud.ces_v1beta.types.GoldenRunMethod
Output only. The method used to run the golden evaluation.

Classes

EvaluationExpectationResult

EvaluationExpectationResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The result of a single evaluation expectation.

ExecutionState

ExecutionState(value)

The state of the evaluation result execution.

GoldenExpectationOutcome

GoldenExpectationOutcome(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Specifies the expectation and the result of that expectation.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

GoldenResult

GoldenResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The result of a golden evaluation.

HallucinationResult

HallucinationResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The result of the hallucination check for a single turn.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Outcome

Outcome(value)

The outcome of the evaluation or expectation.

OverallToolInvocationResult

OverallToolInvocationResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The result of the overall tool invocation check.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ScenarioExpectationOutcome

ScenarioExpectationOutcome(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The outcome of a scenario expectation.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ScenarioResult

ScenarioResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The outcome of a scenario evaluation.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ScenarioRubricOutcome

ScenarioRubricOutcome(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The outcome of the evaluation against the rubric.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

SemanticSimilarityResult

SemanticSimilarityResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The result of the semantic similarity check.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

SpanLatency

SpanLatency(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The latency of a span execution.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

TaskCompletionResult

TaskCompletionResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The result of the task completion check for the conversation.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ToolCallLatency

ToolCallLatency(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The latency of a tool call execution.

UserGoalSatisfactionResult

UserGoalSatisfactionResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The result of a user goal satisfaction check for a conversation.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields