EvaluationRun(mapping=None, *, ignore_unknown_fields=False, **kwargs)An evaluation run represents an all the evaluation results from an evaluation execution.
Attributes |
|
|---|---|
| Name | Description |
name |
str
Identifier. The unique identifier of the evaluation run. Format: projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluationRun}
|
display_name |
str
Optional. User-defined display name of the evaluation run. default: " |
evaluation_results |
MutableSequence[str]
Output only. The evaluation results that are part of this run. Format: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{result}
|
create_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. Timestamp when the evaluation run was created. |
initiated_by |
str
Output only. The user who initiated the evaluation run. |
app_version |
str
Output only. The app version to evaluate. 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. |
evaluations |
MutableSequence[str]
Output only. The evaluations that are part of this run. The list may contain evaluations of either type. This field is mutually exclusive with evaluation_dataset. Format:
projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}
|
evaluation_dataset |
str
Output only. The evaluation dataset that this run is associated with. This field is mutually exclusive with evaluations. Format:
projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}
|
evaluation_type |
google.cloud.ces_v1beta.types.EvaluationRun.EvaluationType
Output only. The type of the evaluations in this run. |
state |
google.cloud.ces_v1beta.types.EvaluationRun.EvaluationRunState
Output only. The state of the evaluation run. |
progress |
google.cloud.ces_v1beta.types.EvaluationRun.Progress
Output only. The progress of the evaluation run. |
config |
google.cloud.ces_v1beta.types.EvaluationConfig
Output only. The configuration used in the run. |
error |
google.rpc.status_pb2.Status
Output only. Deprecated: Use error_info instead. Errors encountered during execution. |
error_info |
google.cloud.ces_v1beta.types.EvaluationErrorInfo
Output only. Error information for the evaluation run. |
evaluation_run_summaries |
MutableMapping[str, google.cloud.ces_v1beta.types.EvaluationRun.EvaluationRunSummary]
Output only. Map of evaluation name to EvaluationRunSummary. |
latency_report |
google.cloud.ces_v1beta.types.LatencyReport
Output only. Latency report for the evaluation run. |
run_count |
int
Output only. The number of times the evaluations inside the run were run. |
persona_run_configs |
MutableSequence[google.cloud.ces_v1beta.types.PersonaRunConfig]
Output only. The configuration to use for the run per persona. |
optimization_config |
google.cloud.ces_v1beta.types.OptimizationConfig
Optional. Configuration for running the optimization step after the evaluation run. If not set, the optimization step will not be run. |
scheduled_evaluation_run |
str
Output only. The scheduled evaluation run resource name that created this evaluation run. This field is only set if the evaluation run was created by a scheduled evaluation run. Format: projects/{project}/locations/{location}/apps/{app}/scheduledEvaluationRuns/{scheduled_evaluation_run}
|
golden_run_method |
google.cloud.ces_v1beta.types.GoldenRunMethod
Output only. The method used to run the evaluation. |
Classes
EvaluationRunState
EvaluationRunState(value)The state of the evaluation run.
EvaluationRunSummariesEntry
EvaluationRunSummariesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)The abstract base class for a message.
| Parameters | |
|---|---|
| Name | Description |
kwargs |
dict
Keys and values corresponding to the fields of the message. |
mapping |
Union[dict,
A dictionary or message to be used to determine the values for this message. |
ignore_unknown_fields |
Optional(bool)
If True, do not raise errors for unknown fields. Only applied if |
EvaluationRunSummary
EvaluationRunSummary(mapping=None, *, ignore_unknown_fields=False, **kwargs)Contains the summary of passed and failed result counts for a specific evaluation in an evaluation run.
EvaluationType
EvaluationType(value)The type of the evaluations in this run. Additional values may be added in the future.
Progress
Progress(mapping=None, *, ignore_unknown_fields=False, **kwargs)The progress of the evaluation run.