Class: Google::Cloud::Ces::V1beta::Evaluation::Scenario

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/ces/v1beta/evaluation.rb

Overview

The config for a scenario

Defined Under Namespace

Modules: TaskCompletionBehavior, UserGoalBehavior Classes: UserFact

Instance Attribute Summary collapse

Instance Attribute Details

#evaluation_expectations ⇒ ::Array<::String>

Returns 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}



381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'proto_docs/google/cloud/ces/v1beta/evaluation.rb', line 381

class Scenario
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Facts about the user as a key value pair.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. The name of the user fact.
  # @!attribute [rw] value
  #   @return [::String]
  #     Required. The value of the user fact.
  class UserFact
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The expected behavior of the user task. This is used to determine whether
  # the scenario is successful.
  module TaskCompletionBehavior
    # Behavior unspecified. Will default to TASK_SATISFIED.
    TASK_COMPLETION_BEHAVIOR_UNSPECIFIED = 0

    # The user task should be completed successfully.
    TASK_SATISFIED = 1

    # The user task should be rejected.
    TASK_REJECTED = 2
  end

  # The expected behavior of the user goal. This is used to determine whether
  # the scenario is successful.
  module UserGoalBehavior
    # Behavior unspecified. Will default to USER_GOAL_SATISFIED.
    USER_GOAL_BEHAVIOR_UNSPECIFIED = 0

    # The user goal should be completed successfully.
    USER_GOAL_SATISFIED = 1

    # The user goal should be rejected.
    USER_GOAL_REJECTED = 2

    # Ignore the user goal status.
    USER_GOAL_IGNORED = 3
  end
end

#max_turns ⇒ ::Integer

Returns 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.



381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'proto_docs/google/cloud/ces/v1beta/evaluation.rb', line 381

class Scenario
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Facts about the user as a key value pair.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. The name of the user fact.
  # @!attribute [rw] value
  #   @return [::String]
  #     Required. The value of the user fact.
  class UserFact
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The expected behavior of the user task. This is used to determine whether
  # the scenario is successful.
  module TaskCompletionBehavior
    # Behavior unspecified. Will default to TASK_SATISFIED.
    TASK_COMPLETION_BEHAVIOR_UNSPECIFIED = 0

    # The user task should be completed successfully.
    TASK_SATISFIED = 1

    # The user task should be rejected.
    TASK_REJECTED = 2
  end

  # The expected behavior of the user goal. This is used to determine whether
  # the scenario is successful.
  module UserGoalBehavior
    # Behavior unspecified. Will default to USER_GOAL_SATISFIED.
    USER_GOAL_BEHAVIOR_UNSPECIFIED = 0

    # The user goal should be completed successfully.
    USER_GOAL_SATISFIED = 1

    # The user goal should be rejected.
    USER_GOAL_REJECTED = 2

    # Ignore the user goal status.
    USER_GOAL_IGNORED = 3
  end
end

#rubrics ⇒ ::Array<::String>

Returns Required. The rubrics to score the scenario against.

Returns:

  • (::Array<::String>) —

    Required. The rubrics to score the scenario against.



381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'proto_docs/google/cloud/ces/v1beta/evaluation.rb', line 381

class Scenario
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Facts about the user as a key value pair.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. The name of the user fact.
  # @!attribute [rw] value
  #   @return [::String]
  #     Required. The value of the user fact.
  class UserFact
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The expected behavior of the user task. This is used to determine whether
  # the scenario is successful.
  module TaskCompletionBehavior
    # Behavior unspecified. Will default to TASK_SATISFIED.
    TASK_COMPLETION_BEHAVIOR_UNSPECIFIED = 0

    # The user task should be completed successfully.
    TASK_SATISFIED = 1

    # The user task should be rejected.
    TASK_REJECTED = 2
  end

  # The expected behavior of the user goal. This is used to determine whether
  # the scenario is successful.
  module UserGoalBehavior
    # Behavior unspecified. Will default to USER_GOAL_SATISFIED.
    USER_GOAL_BEHAVIOR_UNSPECIFIED = 0

    # The user goal should be completed successfully.
    USER_GOAL_SATISFIED = 1

    # The user goal should be rejected.
    USER_GOAL_REJECTED = 2

    # Ignore the user goal status.
    USER_GOAL_IGNORED = 3
  end
end

#scenario_expectations ⇒ ::Array<::Google::Cloud::Ces::V1beta::Evaluation::ScenarioExpectation>

Returns Required. The ScenarioExpectations to evaluate the conversation produced by the user simulation.

Returns:



381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'proto_docs/google/cloud/ces/v1beta/evaluation.rb', line 381

class Scenario
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Facts about the user as a key value pair.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. The name of the user fact.
  # @!attribute [rw] value
  #   @return [::String]
  #     Required. The value of the user fact.
  class UserFact
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The expected behavior of the user task. This is used to determine whether
  # the scenario is successful.
  module TaskCompletionBehavior
    # Behavior unspecified. Will default to TASK_SATISFIED.
    TASK_COMPLETION_BEHAVIOR_UNSPECIFIED = 0

    # The user task should be completed successfully.
    TASK_SATISFIED = 1

    # The user task should be rejected.
    TASK_REJECTED = 2
  end

  # The expected behavior of the user goal. This is used to determine whether
  # the scenario is successful.
  module UserGoalBehavior
    # Behavior unspecified. Will default to USER_GOAL_SATISFIED.
    USER_GOAL_BEHAVIOR_UNSPECIFIED = 0

    # The user goal should be completed successfully.
    USER_GOAL_SATISFIED = 1

    # The user goal should be rejected.
    USER_GOAL_REJECTED = 2

    # Ignore the user goal status.
    USER_GOAL_IGNORED = 3
  end
end

#task ⇒ ::String

Returns Required. The task to be targeted by the scenario.

Returns:

  • (::String) —

    Required. The task to be targeted by the scenario.



381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'proto_docs/google/cloud/ces/v1beta/evaluation.rb', line 381

class Scenario
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Facts about the user as a key value pair.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. The name of the user fact.
  # @!attribute [rw] value
  #   @return [::String]
  #     Required. The value of the user fact.
  class UserFact
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The expected behavior of the user task. This is used to determine whether
  # the scenario is successful.
  module TaskCompletionBehavior
    # Behavior unspecified. Will default to TASK_SATISFIED.
    TASK_COMPLETION_BEHAVIOR_UNSPECIFIED = 0

    # The user task should be completed successfully.
    TASK_SATISFIED = 1

    # The user task should be rejected.
    TASK_REJECTED = 2
  end

  # The expected behavior of the user goal. This is used to determine whether
  # the scenario is successful.
  module UserGoalBehavior
    # Behavior unspecified. Will default to USER_GOAL_SATISFIED.
    USER_GOAL_BEHAVIOR_UNSPECIFIED = 0

    # The user goal should be completed successfully.
    USER_GOAL_SATISFIED = 1

    # The user goal should be rejected.
    USER_GOAL_REJECTED = 2

    # Ignore the user goal status.
    USER_GOAL_IGNORED = 3
  end
end

#task_completion_behavior ⇒ ::Google::Cloud::Ces::V1beta::Evaluation::Scenario::TaskCompletionBehavior

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns Optional. Deprecated. Use user_goal_behavior instead.

Returns:



381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'proto_docs/google/cloud/ces/v1beta/evaluation.rb', line 381

class Scenario
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Facts about the user as a key value pair.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. The name of the user fact.
  # @!attribute [rw] value
  #   @return [::String]
  #     Required. The value of the user fact.
  class UserFact
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The expected behavior of the user task. This is used to determine whether
  # the scenario is successful.
  module TaskCompletionBehavior
    # Behavior unspecified. Will default to TASK_SATISFIED.
    TASK_COMPLETION_BEHAVIOR_UNSPECIFIED = 0

    # The user task should be completed successfully.
    TASK_SATISFIED = 1

    # The user task should be rejected.
    TASK_REJECTED = 2
  end

  # The expected behavior of the user goal. This is used to determine whether
  # the scenario is successful.
  module UserGoalBehavior
    # Behavior unspecified. Will default to USER_GOAL_SATISFIED.
    USER_GOAL_BEHAVIOR_UNSPECIFIED = 0

    # The user goal should be completed successfully.
    USER_GOAL_SATISFIED = 1

    # The user goal should be rejected.
    USER_GOAL_REJECTED = 2

    # Ignore the user goal status.
    USER_GOAL_IGNORED = 3
  end
end

#user_facts ⇒ ::Array<::Google::Cloud::Ces::V1beta::Evaluation::Scenario::UserFact>

Returns Optional. The user facts to be used by the scenario.

Returns:



381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'proto_docs/google/cloud/ces/v1beta/evaluation.rb', line 381

class Scenario
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Facts about the user as a key value pair.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. The name of the user fact.
  # @!attribute [rw] value
  #   @return [::String]
  #     Required. The value of the user fact.
  class UserFact
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The expected behavior of the user task. This is used to determine whether
  # the scenario is successful.
  module TaskCompletionBehavior
    # Behavior unspecified. Will default to TASK_SATISFIED.
    TASK_COMPLETION_BEHAVIOR_UNSPECIFIED = 0

    # The user task should be completed successfully.
    TASK_SATISFIED = 1

    # The user task should be rejected.
    TASK_REJECTED = 2
  end

  # The expected behavior of the user goal. This is used to determine whether
  # the scenario is successful.
  module UserGoalBehavior
    # Behavior unspecified. Will default to USER_GOAL_SATISFIED.
    USER_GOAL_BEHAVIOR_UNSPECIFIED = 0

    # The user goal should be completed successfully.
    USER_GOAL_SATISFIED = 1

    # The user goal should be rejected.
    USER_GOAL_REJECTED = 2

    # Ignore the user goal status.
    USER_GOAL_IGNORED = 3
  end
end

#user_goal_behavior ⇒ ::Google::Cloud::Ces::V1beta::Evaluation::Scenario::UserGoalBehavior

Returns Optional. The expected behavior of the user goal.

Returns:



381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'proto_docs/google/cloud/ces/v1beta/evaluation.rb', line 381

class Scenario
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Facts about the user as a key value pair.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. The name of the user fact.
  # @!attribute [rw] value
  #   @return [::String]
  #     Required. The value of the user fact.
  class UserFact
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The expected behavior of the user task. This is used to determine whether
  # the scenario is successful.
  module TaskCompletionBehavior
    # Behavior unspecified. Will default to TASK_SATISFIED.
    TASK_COMPLETION_BEHAVIOR_UNSPECIFIED = 0

    # The user task should be completed successfully.
    TASK_SATISFIED = 1

    # The user task should be rejected.
    TASK_REJECTED = 2
  end

  # The expected behavior of the user goal. This is used to determine whether
  # the scenario is successful.
  module UserGoalBehavior
    # Behavior unspecified. Will default to USER_GOAL_SATISFIED.
    USER_GOAL_BEHAVIOR_UNSPECIFIED = 0

    # The user goal should be completed successfully.
    USER_GOAL_SATISFIED = 1

    # The user goal should be rejected.
    USER_GOAL_REJECTED = 2

    # Ignore the user goal status.
    USER_GOAL_IGNORED = 3
  end
end

#variable_overrides ⇒ ::Google::Protobuf::Struct

Returns 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.



381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'proto_docs/google/cloud/ces/v1beta/evaluation.rb', line 381

class Scenario
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Facts about the user as a key value pair.
  # @!attribute [rw] name
  #   @return [::String]
  #     Required. The name of the user fact.
  # @!attribute [rw] value
  #   @return [::String]
  #     Required. The value of the user fact.
  class UserFact
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The expected behavior of the user task. This is used to determine whether
  # the scenario is successful.
  module TaskCompletionBehavior
    # Behavior unspecified. Will default to TASK_SATISFIED.
    TASK_COMPLETION_BEHAVIOR_UNSPECIFIED = 0

    # The user task should be completed successfully.
    TASK_SATISFIED = 1

    # The user task should be rejected.
    TASK_REJECTED = 2
  end

  # The expected behavior of the user goal. This is used to determine whether
  # the scenario is successful.
  module UserGoalBehavior
    # Behavior unspecified. Will default to USER_GOAL_SATISFIED.
    USER_GOAL_BEHAVIOR_UNSPECIFIED = 0

    # The user goal should be completed successfully.
    USER_GOAL_SATISFIED = 1

    # The user goal should be rejected.
    USER_GOAL_REJECTED = 2

    # Ignore the user goal status.
    USER_GOAL_IGNORED = 3
  end
end