Evaluation(mapping=None, *, ignore_unknown_fields=False, **kwargs)An evaluation represents all of the information needed to simulate and evaluate an agent.
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 |
google.cloud.ces_v1beta.types.Evaluation.Golden
Optional. The golden steps to be evaluated. This field is a member of oneof_ inputs.
|
scenario |
google.cloud.ces_v1beta.types.Evaluation.Scenario
Optional. The config for a scenario. This field is a member of oneof_ inputs.
|
name |
str
Identifier. The unique identifier of this evaluation. Format: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}
|
display_name |
str
Required. User-defined display name of the evaluation. Unique within an App. |
description |
str
Optional. User-defined description of the evaluation. |
tags |
MutableSequence[str]
Optional. User defined tags to categorize the evaluation. |
evaluation_datasets |
MutableSequence[str]
Output only. List of evaluation datasets the evaluation belongs to. Format: projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}
|
create_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. Timestamp when the evaluation was created. |
created_by |
str
Output only. The user who created the evaluation. |
update_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. Timestamp when the evaluation was last updated. |
last_updated_by |
str
Output only. The user who last updated the evaluation. |
evaluation_runs |
MutableSequence[str]
Output only. The EvaluationRuns that this Evaluation is associated with. |
etag |
str
Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes. |
aggregated_metrics |
google.cloud.ces_v1beta.types.AggregatedMetrics
Output only. The aggregated metrics for this evaluation across all runs. |
last_completed_result |
google.cloud.ces_v1beta.types.EvaluationResult
Output only. The latest evaluation result for this evaluation. |
invalid |
bool
Output only. Whether the evaluation is invalid. This can happen if an evaluation is referencing a tool, toolset, or agent that has since been deleted. |
last_ten_results |
MutableSequence[google.cloud.ces_v1beta.types.EvaluationResult]
Output only. The last 10 evaluation results for this evaluation. This is only populated if include_last_ten_results is set to true in the ListEvaluationsRequest or GetEvaluationRequest. |
Classes
Golden
Golden(mapping=None, *, ignore_unknown_fields=False, **kwargs)The steps required to replay a golden conversation.
GoldenExpectation
GoldenExpectation(mapping=None, *, ignore_unknown_fields=False, **kwargs)Represents a single, checkable requirement.
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
GoldenTurn
GoldenTurn(mapping=None, *, ignore_unknown_fields=False, **kwargs)A golden turn defines a single turn in a golden conversation.
Scenario
Scenario(mapping=None, *, ignore_unknown_fields=False, **kwargs)The config for a scenario
ScenarioExpectation
ScenarioExpectation(mapping=None, *, ignore_unknown_fields=False, **kwargs)The expectation to evaluate the conversation produced by the simulation.
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
Step
Step(mapping=None, *, ignore_unknown_fields=False, **kwargs)A step defines a singular action to happen during the 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