Class: Google::Cloud::Ces::V1beta::EvaluationSettings

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

Overview

Settings for evaluation.

Defined Under Namespace

Modules: ScenarioConversationInitiator, ScenarioExecutionMode

Instance Attribute Summary collapse

Instance Attribute Details

#evaluation_run_caching_settings ⇒ ::Google::Cloud::Ces::V1beta::EvaluationRunCachingSettings

Returns Optional. The caching settings to use for the evaluation run.

Returns:



664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
 
# File 'proto_docs/google/cloud/ces/v1beta/app.rb', line 664

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

  # Determines who starts the conversation in a scenario evaluation session.
  module ScenarioConversationInitiator
    # Unspecified. Defaults to USER.
    SCENARIO_CONVERSATION_INITIATOR_UNSPECIFIED = 0

    # The user starts the conversation.
    USER = 1

    # The agent starts the conversation.
    AGENT = 2
  end

  # The execution mode for scenario evaluations.
  module ScenarioExecutionMode
    # Unspecified execution mode. Defaults to QUALITY_OPTIMIZED.
    SCENARIO_EXECUTION_MODE_UNSPECIFIED = 0

    # Quality optimized mode.
    QUALITY_OPTIMIZED = 1

    # Speed optimized mode.
    SPEED_OPTIMIZED = 2
  end
end

#golden_evaluation_tool_call_behaviour ⇒ ::Google::Cloud::Ces::V1beta::EvaluationToolCallBehaviour

Returns Optional. Configures the default tool call behaviour for golden evaluations.

Returns:



664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
 
# File 'proto_docs/google/cloud/ces/v1beta/app.rb', line 664

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

  # Determines who starts the conversation in a scenario evaluation session.
  module ScenarioConversationInitiator
    # Unspecified. Defaults to USER.
    SCENARIO_CONVERSATION_INITIATOR_UNSPECIFIED = 0

    # The user starts the conversation.
    USER = 1

    # The agent starts the conversation.
    AGENT = 2
  end

  # The execution mode for scenario evaluations.
  module ScenarioExecutionMode
    # Unspecified execution mode. Defaults to QUALITY_OPTIMIZED.
    SCENARIO_EXECUTION_MODE_UNSPECIFIED = 0

    # Quality optimized mode.
    QUALITY_OPTIMIZED = 1

    # Speed optimized mode.
    SPEED_OPTIMIZED = 2
  end
end

#golden_run_method ⇒ ::Google::Cloud::Ces::V1beta::GoldenRunMethod

Returns Optional. The default method used to run golden evaluations. This will be used if no golden_run_method is specified in the RunEvaluationRequest.

Returns:



664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
 
# File 'proto_docs/google/cloud/ces/v1beta/app.rb', line 664

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

  # Determines who starts the conversation in a scenario evaluation session.
  module ScenarioConversationInitiator
    # Unspecified. Defaults to USER.
    SCENARIO_CONVERSATION_INITIATOR_UNSPECIFIED = 0

    # The user starts the conversation.
    USER = 1

    # The agent starts the conversation.
    AGENT = 2
  end

  # The execution mode for scenario evaluations.
  module ScenarioExecutionMode
    # Unspecified execution mode. Defaults to QUALITY_OPTIMIZED.
    SCENARIO_EXECUTION_MODE_UNSPECIFIED = 0

    # Quality optimized mode.
    QUALITY_OPTIMIZED = 1

    # Speed optimized mode.
    SPEED_OPTIMIZED = 2
  end
end

#metrics_config ⇒ ::Google::Cloud::Ces::V1beta::EvaluationMetricsConfig

Returns Optional. Configures the default metrics for evaluations.

Returns:



664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
 
# File 'proto_docs/google/cloud/ces/v1beta/app.rb', line 664

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

  # Determines who starts the conversation in a scenario evaluation session.
  module ScenarioConversationInitiator
    # Unspecified. Defaults to USER.
    SCENARIO_CONVERSATION_INITIATOR_UNSPECIFIED = 0

    # The user starts the conversation.
    USER = 1

    # The agent starts the conversation.
    AGENT = 2
  end

  # The execution mode for scenario evaluations.
  module ScenarioExecutionMode
    # Unspecified execution mode. Defaults to QUALITY_OPTIMIZED.
    SCENARIO_EXECUTION_MODE_UNSPECIFIED = 0

    # Quality optimized mode.
    QUALITY_OPTIMIZED = 1

    # Speed optimized mode.
    SPEED_OPTIMIZED = 2
  end
end

#scenario_conversation_initiator ⇒ ::Google::Cloud::Ces::V1beta::EvaluationSettings::ScenarioConversationInitiator

Returns Optional. Who starts the conversation in a scenario evaluation.

Returns:



664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
 
# File 'proto_docs/google/cloud/ces/v1beta/app.rb', line 664

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

  # Determines who starts the conversation in a scenario evaluation session.
  module ScenarioConversationInitiator
    # Unspecified. Defaults to USER.
    SCENARIO_CONVERSATION_INITIATOR_UNSPECIFIED = 0

    # The user starts the conversation.
    USER = 1

    # The agent starts the conversation.
    AGENT = 2
  end

  # The execution mode for scenario evaluations.
  module ScenarioExecutionMode
    # Unspecified execution mode. Defaults to QUALITY_OPTIMIZED.
    SCENARIO_EXECUTION_MODE_UNSPECIFIED = 0

    # Quality optimized mode.
    QUALITY_OPTIMIZED = 1

    # Speed optimized mode.
    SPEED_OPTIMIZED = 2
  end
end

#scenario_evaluation_tool_call_behaviour ⇒ ::Google::Cloud::Ces::V1beta::EvaluationToolCallBehaviour

Returns Optional. Configures the default tool call behaviour for scenario evaluations.

Returns:



664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
 
# File 'proto_docs/google/cloud/ces/v1beta/app.rb', line 664

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

  # Determines who starts the conversation in a scenario evaluation session.
  module ScenarioConversationInitiator
    # Unspecified. Defaults to USER.
    SCENARIO_CONVERSATION_INITIATOR_UNSPECIFIED = 0

    # The user starts the conversation.
    USER = 1

    # The agent starts the conversation.
    AGENT = 2
  end

  # The execution mode for scenario evaluations.
  module ScenarioExecutionMode
    # Unspecified execution mode. Defaults to QUALITY_OPTIMIZED.
    SCENARIO_EXECUTION_MODE_UNSPECIFIED = 0

    # Quality optimized mode.
    QUALITY_OPTIMIZED = 1

    # Speed optimized mode.
    SPEED_OPTIMIZED = 2
  end
end

#scenario_execution_mode ⇒ ::Google::Cloud::Ces::V1beta::EvaluationSettings::ScenarioExecutionMode

Returns Optional. The execution mode for scenario evaluations. If not provided, will default to QUALITY_OPTIMIZED.

Returns:



664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
 
# File 'proto_docs/google/cloud/ces/v1beta/app.rb', line 664

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

  # Determines who starts the conversation in a scenario evaluation session.
  module ScenarioConversationInitiator
    # Unspecified. Defaults to USER.
    SCENARIO_CONVERSATION_INITIATOR_UNSPECIFIED = 0

    # The user starts the conversation.
    USER = 1

    # The agent starts the conversation.
    AGENT = 2
  end

  # The execution mode for scenario evaluations.
  module ScenarioExecutionMode
    # Unspecified execution mode. Defaults to QUALITY_OPTIMIZED.
    SCENARIO_EXECUTION_MODE_UNSPECIFIED = 0

    # Quality optimized mode.
    QUALITY_OPTIMIZED = 1

    # Speed optimized mode.
    SPEED_OPTIMIZED = 2
  end
end