Class RunEvaluationRequest (0.3.0)

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

Request message for EvaluationService.RunEvaluation.

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

Attributes

Name Description
app str
Required. The app to evaluate. Format: projects/{project}/locations/{location}/apps/{app}
evaluations MutableSequence[str]
Optional. List of evaluations to run. Format: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}
evaluation_dataset str
Optional. An evaluation dataset to run. Format: projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}
display_name str
Optional. The display name of the evaluation run.
app_version str
Optional. The app version to evaluate. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version}
config google.cloud.ces_v1beta.types.EvaluationConfig
Optional. The configuration to use for the run.
run_count int
Optional. The number of times to run the evaluation. If not set, the default value is 1 per golden, and 5 per scenario. This field is a member of oneof_ _run_count.
persona_run_configs MutableSequence[google.cloud.ces_v1beta.types.PersonaRunConfig]
Optional. 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
Optional. The resource name of the ScheduledEvaluationRun that is triggering this evaluation run. If this field is set, the scheduled_evaluation_run field on the created EvaluationRun resource will be populated from this value. Format: projects/{project}/locations/{location}/apps/{app}/scheduledEvaluationRuns/{scheduled_evaluation_run}
golden_run_method google.cloud.ces_v1beta.types.GoldenRunMethod
Optional. The method to run the evaluation if it is a golden evaluation. If not set, default to STABLE.
generate_latency_report bool
Optional. Whether to generate a latency report for the evaluation run.