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

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

An evaluation represents all of the information needed to simulate and evaluate an agent.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#aggregated_metrics

def aggregated_metrics() -> ::Google::Cloud::Ces::V1beta::AggregatedMetrics
Returns

#create_time

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

#created_by

def created_by() -> ::String
Returns
  • (::String) — Output only. The user who created the evaluation.

#description

def description() -> ::String
Returns
  • (::String) — Optional. User-defined description of the evaluation.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Optional. User-defined description of the evaluation.
Returns
  • (::String) — Optional. User-defined description of the evaluation.

#display_name

def display_name() -> ::String
Returns
  • (::String) — Required. User-defined display name of the evaluation. Unique within an App.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — Required. User-defined display name of the evaluation. Unique within an App.
Returns
  • (::String) — Required. User-defined display name of the evaluation. Unique within an App.

#etag

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

#evaluation_datasets

def evaluation_datasets() -> ::Array<::String>
Returns
  • (::Array<::String>) — Output only. List of evaluation datasets the evaluation belongs to. Format: projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}

#evaluation_runs

def evaluation_runs() -> ::Array<::String>
Returns
  • (::Array<::String>) — Output only. The EvaluationRuns that this Evaluation is associated with.

#golden

def golden() -> ::Google::Cloud::Ces::V1beta::Evaluation::Golden
Returns
  • (::Google::Cloud::Ces::V1beta::Evaluation::Golden) — Optional. The golden steps to be evaluated.

    Note: The following fields are mutually exclusive: golden, scenario. If a field in that set is populated, all other fields in the set will automatically be cleared.

#golden=

def golden=(value) -> ::Google::Cloud::Ces::V1beta::Evaluation::Golden
Parameter
  • value (::Google::Cloud::Ces::V1beta::Evaluation::Golden) — Optional. The golden steps to be evaluated.

    Note: The following fields are mutually exclusive: golden, scenario. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Ces::V1beta::Evaluation::Golden) — Optional. The golden steps to be evaluated.

    Note: The following fields are mutually exclusive: golden, scenario. If a field in that set is populated, all other fields in the set will automatically be cleared.

#invalid

def invalid() -> ::Boolean
Returns
  • (::Boolean) — 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_completed_result

def last_completed_result() -> ::Google::Cloud::Ces::V1beta::EvaluationResult
Returns

#last_ten_results

def last_ten_results() -> ::Array<::Google::Cloud::Ces::V1beta::EvaluationResult>
Returns
  • (::Array<::Google::Cloud::Ces::V1beta::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.

#last_updated_by

def last_updated_by() -> ::String
Returns
  • (::String) — Output only. The user who last updated the evaluation.

#name

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

#name=

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

#scenario

def scenario() -> ::Google::Cloud::Ces::V1beta::Evaluation::Scenario
Returns
  • (::Google::Cloud::Ces::V1beta::Evaluation::Scenario) — Optional. The config for a scenario.

    Note: The following fields are mutually exclusive: scenario, golden. If a field in that set is populated, all other fields in the set will automatically be cleared.

#scenario=

def scenario=(value) -> ::Google::Cloud::Ces::V1beta::Evaluation::Scenario
Parameter
  • value (::Google::Cloud::Ces::V1beta::Evaluation::Scenario) — Optional. The config for a scenario.

    Note: The following fields are mutually exclusive: scenario, golden. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Ces::V1beta::Evaluation::Scenario) — Optional. The config for a scenario.

    Note: The following fields are mutually exclusive: scenario, golden. If a field in that set is populated, all other fields in the set will automatically be cleared.

#tags

def tags() -> ::Array<::String>
Returns
  • (::Array<::String>) — Optional. User defined tags to categorize the evaluation.

#tags=

def tags=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Optional. User defined tags to categorize the evaluation.
Returns
  • (::Array<::String>) — Optional. User defined tags to categorize the evaluation.

#update_time

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