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

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

Request message for EvaluationService.RunEvaluation.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#app

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

#app=

def app=(value) -> ::String
Parameter
  • value (::String) — Required. The app to evaluate. Format: projects/{project}/locations/{location}/apps/{app}
Returns
  • (::String) — Required. The app to evaluate. Format: projects/{project}/locations/{location}/apps/{app}

#app_version

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

#app_version=

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

#config

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

#config=

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

#display_name

def display_name() -> ::String
Returns
  • (::String) — Optional. The display name of the evaluation run.

#display_name=

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

#evaluation_dataset

def evaluation_dataset() -> ::String
Returns
  • (::String) — Optional. An evaluation dataset to run. Format: projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}

#evaluation_dataset=

def evaluation_dataset=(value) -> ::String
Parameter
  • value (::String) — Optional. An evaluation dataset to run. Format: projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}
Returns
  • (::String) — Optional. An evaluation dataset to run. Format: projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}

#evaluations

def evaluations() -> ::Array<::String>
Returns
  • (::Array<::String>) — Optional. List of evaluations to run. Format: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}

#evaluations=

def evaluations=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Optional. List of evaluations to run. Format: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}
Returns
  • (::Array<::String>) — Optional. List of evaluations to run. Format: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}

#generate_latency_report

def generate_latency_report() -> ::Boolean
Returns
  • (::Boolean) — Optional. Whether to generate a latency report for the evaluation run.

#generate_latency_report=

def generate_latency_report=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. Whether to generate a latency report for the evaluation run.
Returns
  • (::Boolean) — Optional. Whether to generate a latency report for the evaluation run.

#golden_run_method

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

#golden_run_method=

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

#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

#persona_run_configs=

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

#run_count

def run_count() -> ::Integer
Returns
  • (::Integer) — Optional. The number of times to run the evaluation. If not set, the default value is 1 per golden, and 5 per scenario.

#run_count=

def run_count=(value) -> ::Integer
Parameter
  • value (::Integer) — Optional. The number of times to run the evaluation. If not set, the default value is 1 per golden, and 5 per scenario.
Returns
  • (::Integer) — Optional. The number of times to run the evaluation. If not set, the default value is 1 per golden, and 5 per scenario.

#scheduled_evaluation_run

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

#scheduled_evaluation_run=

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

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