Gemini Enterprise for Customer Experience V1BETA API - Class Google::Cloud::Ces::V1beta::EvaluationRun (v0.1.0)

Reference documentation and code samples for the Gemini Enterprise for Customer Experience V1BETA API class Google::Cloud::Ces::V1beta::EvaluationRun.

An evaluation run represents an all the evaluation results from an evaluation execution.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#app_version

def app_version() -> ::String
Returns
  • (::String) — Output only. The app version to evaluate. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version}

#app_version_display_name

def app_version_display_name() -> ::String
Returns
  • (::String) — Output only. The display name of the app_version that the evaluation ran against.

#changelog

def changelog() -> ::String
Returns
  • (::String) — 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

def changelog_create_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::Google::Protobuf::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.

#config

def config() -> ::Google::Cloud::Ces::V1beta::EvaluationConfig
Returns

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#display_name

def display_name() -> ::String
Returns
  • (::String) — Optional. User-defined display name of the evaluation run. default: "

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — Optional. User-defined display name of the evaluation run. default: "
Returns
  • (::String) — Optional. User-defined display name of the evaluation run. default: "

#error

def error() -> ::Google::Rpc::Status
Returns
  • (::Google::Rpc::Status) — Output only. Deprecated: Use error_info instead. Errors encountered during execution.

#error_info

def error_info() -> ::Google::Cloud::Ces::V1beta::EvaluationErrorInfo
Returns

#evaluation_dataset

def evaluation_dataset() -> ::String
Returns
  • (::String) — 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_results

def evaluation_results() -> ::Array<::String>
Returns
  • (::Array<::String>) — Output only. The evaluation results that are part of this run. Format: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{result}

#evaluation_run_summaries

def evaluation_run_summaries() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Ces::V1beta::EvaluationRun::EvaluationRunSummary}
Returns
  • (::Google::Protobuf::Map{::String => ::Google::Cloud::Ces::V1beta::EvaluationRun::EvaluationRunSummary}) — Output only. Map of evaluation name to EvaluationRunSummary.

#evaluation_type

def evaluation_type() -> ::Google::Cloud::Ces::V1beta::EvaluationRun::EvaluationType
Returns

#evaluations

def evaluations() -> ::Array<::String>
Returns
  • (::Array<::String>) — 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}

#golden_run_method

def golden_run_method() -> ::Google::Cloud::Ces::V1beta::GoldenRunMethod
Returns

#initiated_by

def initiated_by() -> ::String
Returns
  • (::String) — Output only. The user who initiated the evaluation run.

#latency_report

def latency_report() -> ::Google::Cloud::Ces::V1beta::LatencyReport
Returns

#name

def name() -> ::String
Returns
  • (::String) — Identifier. The unique identifier of the evaluation run. Format: projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluationRun}

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Identifier. The unique identifier of the evaluation run. Format: projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluationRun}
Returns
  • (::String) — Identifier. The unique identifier of the evaluation run. Format: projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluationRun}

#optimization_config

def optimization_config() -> ::Google::Cloud::Ces::V1beta::OptimizationConfig
Returns

#optimization_config=

def optimization_config=(value) -> ::Google::Cloud::Ces::V1beta::OptimizationConfig
Parameter
Returns

#persona_run_configs

def persona_run_configs() -> ::Array<::Google::Cloud::Ces::V1beta::PersonaRunConfig>
Returns

#progress

def progress() -> ::Google::Cloud::Ces::V1beta::EvaluationRun::Progress
Returns

#run_count

def run_count() -> ::Integer
Returns
  • (::Integer) — Output only. The number of times the evaluations inside the run were run.

#scheduled_evaluation_run

def scheduled_evaluation_run() -> ::String
Returns
  • (::String) — 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}

#state

def state() -> ::Google::Cloud::Ces::V1beta::EvaluationRun::EvaluationRunState
Returns