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

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

The config for a scenario

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#evaluation_expectations

def evaluation_expectations() -> ::Array<::String>
Returns
  • (::Array<::String>) — Optional. The evaluation expectations to evaluate the conversation produced by the simulation against. Format: projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluationExpectation}

#evaluation_expectations=

def evaluation_expectations=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Optional. The evaluation expectations to evaluate the conversation produced by the simulation against. Format: projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluationExpectation}
Returns
  • (::Array<::String>) — Optional. The evaluation expectations to evaluate the conversation produced by the simulation against. Format: projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluationExpectation}

#max_turns

def max_turns() -> ::Integer
Returns
  • (::Integer) — Optional. The maximum number of turns to simulate. If not specified, the simulation will continue until the task is complete.

#max_turns=

def max_turns=(value) -> ::Integer
Parameter
  • value (::Integer) — Optional. The maximum number of turns to simulate. If not specified, the simulation will continue until the task is complete.
Returns
  • (::Integer) — Optional. The maximum number of turns to simulate. If not specified, the simulation will continue until the task is complete.

#rubrics

def rubrics() -> ::Array<::String>
Returns
  • (::Array<::String>) — Required. The rubrics to score the scenario against.

#rubrics=

def rubrics=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Required. The rubrics to score the scenario against.
Returns
  • (::Array<::String>) — Required. The rubrics to score the scenario against.

#scenario_expectations

def scenario_expectations() -> ::Array<::Google::Cloud::Ces::V1beta::Evaluation::ScenarioExpectation>
Returns

#scenario_expectations=

def scenario_expectations=(value) -> ::Array<::Google::Cloud::Ces::V1beta::Evaluation::ScenarioExpectation>
Parameter
Returns

#task

def task() -> ::String
Returns
  • (::String) — Required. The task to be targeted by the scenario.

#task=

def task=(value) -> ::String
Parameter
  • value (::String) — Required. The task to be targeted by the scenario.
Returns
  • (::String) — Required. The task to be targeted by the scenario.

#task_completion_behavior

def task_completion_behavior() -> ::Google::Cloud::Ces::V1beta::Evaluation::Scenario::TaskCompletionBehavior
Returns

#task_completion_behavior=

def task_completion_behavior=(value) -> ::Google::Cloud::Ces::V1beta::Evaluation::Scenario::TaskCompletionBehavior
Parameter
Returns

#user_facts

def user_facts() -> ::Array<::Google::Cloud::Ces::V1beta::Evaluation::Scenario::UserFact>
Returns

#user_facts=

def user_facts=(value) -> ::Array<::Google::Cloud::Ces::V1beta::Evaluation::Scenario::UserFact>
Parameter
Returns

#user_goal_behavior

def user_goal_behavior() -> ::Google::Cloud::Ces::V1beta::Evaluation::Scenario::UserGoalBehavior
Returns

#user_goal_behavior=

def user_goal_behavior=(value) -> ::Google::Cloud::Ces::V1beta::Evaluation::Scenario::UserGoalBehavior
Parameter
Returns

#variable_overrides

def variable_overrides() -> ::Google::Protobuf::Struct
Returns
  • (::Google::Protobuf::Struct) — Optional. Variables / Session Parameters as context for the session, keyed by variable names. Members of this struct will override any default values set by the system.

    Note, these are different from user facts, which are facts known to the user. Variables are parameters known to the agent: i.e. MDN (phone number) passed by the telephony system.

#variable_overrides=

def variable_overrides=(value) -> ::Google::Protobuf::Struct
Parameter
  • value (::Google::Protobuf::Struct) — Optional. Variables / Session Parameters as context for the session, keyed by variable names. Members of this struct will override any default values set by the system.

    Note, these are different from user facts, which are facts known to the user. Variables are parameters known to the agent: i.e. MDN (phone number) passed by the telephony system.

Returns
  • (::Google::Protobuf::Struct) — Optional. Variables / Session Parameters as context for the session, keyed by variable names. Members of this struct will override any default values set by the system.

    Note, these are different from user facts, which are facts known to the user. Variables are parameters known to the agent: i.e. MDN (phone number) passed by the telephony system.