Class: Google::Cloud::Dialogflow::CX::V3::GenerativeSettings

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dialogflow/cx/v3/generative_settings.rb

Overview

Settings for Generative AI.

Defined Under Namespace

Classes: FallbackSettings, KnowledgeConnectorSettings

Instance Attribute Summary collapse

Instance Attribute Details

#fallback_settings ⇒ ::Google::Cloud::Dialogflow::CX::V3::GenerativeSettings::FallbackSettings

Returns Settings for Generative Fallback.

Returns:



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/generative_settings.rb', line 42

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

  # Settings for Generative Fallback.
  # @!attribute [rw] selected_prompt
  #   @return [::String]
  #     Display name of the selected prompt.
  # @!attribute [rw] prompt_templates
  #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::GenerativeSettings::FallbackSettings::PromptTemplate>]
  #     Stored prompts that can be selected, for example default templates like
  #     "conservative" or "chatty", or user defined ones.
  class FallbackSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Prompt template.
    # @!attribute [rw] display_name
    #   @return [::String]
    #     Prompt name.
    # @!attribute [rw] prompt_text
    #   @return [::String]
    #     Prompt text that is sent to a LLM on no-match default, placeholders are
    #     filled downstream. For example: "Here is a conversation $conversation,
    #     a response is: "
    # @!attribute [rw] frozen
    #   @return [::Boolean]
    #     If the flag is true, the prompt is frozen and cannot be modified by
    #     users.
    class PromptTemplate
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Settings for knowledge connector. These parameters are used for LLM prompt
  # like "You are <agent>. You are a helpful and verbose <agent_identity> at
  # <business>, <business_description>. Your task is to help humans on
  # <agent_scope>".
  # @!attribute [rw] business
  #   @return [::String]
  #     Name of the company, organization or other entity that the agent
  #     represents. Used for knowledge connector LLM prompt and for knowledge
  #     search.
  # @!attribute [rw] agent
  #   @return [::String]
  #     Name of the virtual agent. Used for LLM prompt. Can be left empty.
  # @!attribute [rw] agent_identity
  #   @return [::String]
  #     Identity of the agent, e.g. "virtual agent", "AI assistant".
  # @!attribute [rw] business_description
  #   @return [::String]
  #     Company description, used for LLM prompt, e.g. "a family company selling
  #     freshly roasted coffee beans".
  # @!attribute [rw] agent_scope
  #   @return [::String]
  #     Agent scope, e.g. "Example company website", "internal Example
  #     company website for employees", "manual of car owner".
  # @!attribute [rw] disable_data_store_fallback
  #   @return [::Boolean]
  #     Whether to disable fallback to Data Store search results (in case the LLM
  #     couldn't pick a proper answer). Per default the feature is enabled.
  class KnowledgeConnectorSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#generative_safety_settings ⇒ ::Google::Cloud::Dialogflow::CX::V3::SafetySettings

Returns Settings for Generative Safety.

Returns:



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/generative_settings.rb', line 42

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

  # Settings for Generative Fallback.
  # @!attribute [rw] selected_prompt
  #   @return [::String]
  #     Display name of the selected prompt.
  # @!attribute [rw] prompt_templates
  #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::GenerativeSettings::FallbackSettings::PromptTemplate>]
  #     Stored prompts that can be selected, for example default templates like
  #     "conservative" or "chatty", or user defined ones.
  class FallbackSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Prompt template.
    # @!attribute [rw] display_name
    #   @return [::String]
    #     Prompt name.
    # @!attribute [rw] prompt_text
    #   @return [::String]
    #     Prompt text that is sent to a LLM on no-match default, placeholders are
    #     filled downstream. For example: "Here is a conversation $conversation,
    #     a response is: "
    # @!attribute [rw] frozen
    #   @return [::Boolean]
    #     If the flag is true, the prompt is frozen and cannot be modified by
    #     users.
    class PromptTemplate
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Settings for knowledge connector. These parameters are used for LLM prompt
  # like "You are <agent>. You are a helpful and verbose <agent_identity> at
  # <business>, <business_description>. Your task is to help humans on
  # <agent_scope>".
  # @!attribute [rw] business
  #   @return [::String]
  #     Name of the company, organization or other entity that the agent
  #     represents. Used for knowledge connector LLM prompt and for knowledge
  #     search.
  # @!attribute [rw] agent
  #   @return [::String]
  #     Name of the virtual agent. Used for LLM prompt. Can be left empty.
  # @!attribute [rw] agent_identity
  #   @return [::String]
  #     Identity of the agent, e.g. "virtual agent", "AI assistant".
  # @!attribute [rw] business_description
  #   @return [::String]
  #     Company description, used for LLM prompt, e.g. "a family company selling
  #     freshly roasted coffee beans".
  # @!attribute [rw] agent_scope
  #   @return [::String]
  #     Agent scope, e.g. "Example company website", "internal Example
  #     company website for employees", "manual of car owner".
  # @!attribute [rw] disable_data_store_fallback
  #   @return [::Boolean]
  #     Whether to disable fallback to Data Store search results (in case the LLM
  #     couldn't pick a proper answer). Per default the feature is enabled.
  class KnowledgeConnectorSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#knowledge_connector_settings ⇒ ::Google::Cloud::Dialogflow::CX::V3::GenerativeSettings::KnowledgeConnectorSettings

Returns Settings for knowledge connector.

Returns:



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/generative_settings.rb', line 42

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

  # Settings for Generative Fallback.
  # @!attribute [rw] selected_prompt
  #   @return [::String]
  #     Display name of the selected prompt.
  # @!attribute [rw] prompt_templates
  #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::GenerativeSettings::FallbackSettings::PromptTemplate>]
  #     Stored prompts that can be selected, for example default templates like
  #     "conservative" or "chatty", or user defined ones.
  class FallbackSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Prompt template.
    # @!attribute [rw] display_name
    #   @return [::String]
    #     Prompt name.
    # @!attribute [rw] prompt_text
    #   @return [::String]
    #     Prompt text that is sent to a LLM on no-match default, placeholders are
    #     filled downstream. For example: "Here is a conversation $conversation,
    #     a response is: "
    # @!attribute [rw] frozen
    #   @return [::Boolean]
    #     If the flag is true, the prompt is frozen and cannot be modified by
    #     users.
    class PromptTemplate
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Settings for knowledge connector. These parameters are used for LLM prompt
  # like "You are <agent>. You are a helpful and verbose <agent_identity> at
  # <business>, <business_description>. Your task is to help humans on
  # <agent_scope>".
  # @!attribute [rw] business
  #   @return [::String]
  #     Name of the company, organization or other entity that the agent
  #     represents. Used for knowledge connector LLM prompt and for knowledge
  #     search.
  # @!attribute [rw] agent
  #   @return [::String]
  #     Name of the virtual agent. Used for LLM prompt. Can be left empty.
  # @!attribute [rw] agent_identity
  #   @return [::String]
  #     Identity of the agent, e.g. "virtual agent", "AI assistant".
  # @!attribute [rw] business_description
  #   @return [::String]
  #     Company description, used for LLM prompt, e.g. "a family company selling
  #     freshly roasted coffee beans".
  # @!attribute [rw] agent_scope
  #   @return [::String]
  #     Agent scope, e.g. "Example company website", "internal Example
  #     company website for employees", "manual of car owner".
  # @!attribute [rw] disable_data_store_fallback
  #   @return [::Boolean]
  #     Whether to disable fallback to Data Store search results (in case the LLM
  #     couldn't pick a proper answer). Per default the feature is enabled.
  class KnowledgeConnectorSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#language_code ⇒ ::String

Returns Language for this settings.

Returns:

  • (::String) —

    Language for this settings.



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/generative_settings.rb', line 42

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

  # Settings for Generative Fallback.
  # @!attribute [rw] selected_prompt
  #   @return [::String]
  #     Display name of the selected prompt.
  # @!attribute [rw] prompt_templates
  #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::GenerativeSettings::FallbackSettings::PromptTemplate>]
  #     Stored prompts that can be selected, for example default templates like
  #     "conservative" or "chatty", or user defined ones.
  class FallbackSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Prompt template.
    # @!attribute [rw] display_name
    #   @return [::String]
    #     Prompt name.
    # @!attribute [rw] prompt_text
    #   @return [::String]
    #     Prompt text that is sent to a LLM on no-match default, placeholders are
    #     filled downstream. For example: "Here is a conversation $conversation,
    #     a response is: "
    # @!attribute [rw] frozen
    #   @return [::Boolean]
    #     If the flag is true, the prompt is frozen and cannot be modified by
    #     users.
    class PromptTemplate
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Settings for knowledge connector. These parameters are used for LLM prompt
  # like "You are <agent>. You are a helpful and verbose <agent_identity> at
  # <business>, <business_description>. Your task is to help humans on
  # <agent_scope>".
  # @!attribute [rw] business
  #   @return [::String]
  #     Name of the company, organization or other entity that the agent
  #     represents. Used for knowledge connector LLM prompt and for knowledge
  #     search.
  # @!attribute [rw] agent
  #   @return [::String]
  #     Name of the virtual agent. Used for LLM prompt. Can be left empty.
  # @!attribute [rw] agent_identity
  #   @return [::String]
  #     Identity of the agent, e.g. "virtual agent", "AI assistant".
  # @!attribute [rw] business_description
  #   @return [::String]
  #     Company description, used for LLM prompt, e.g. "a family company selling
  #     freshly roasted coffee beans".
  # @!attribute [rw] agent_scope
  #   @return [::String]
  #     Agent scope, e.g. "Example company website", "internal Example
  #     company website for employees", "manual of car owner".
  # @!attribute [rw] disable_data_store_fallback
  #   @return [::Boolean]
  #     Whether to disable fallback to Data Store search results (in case the LLM
  #     couldn't pick a proper answer). Per default the feature is enabled.
  class KnowledgeConnectorSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String

Returns Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/generativeSettings.

Returns:

  • (::String) —

    Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/generativeSettings.



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/generative_settings.rb', line 42

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

  # Settings for Generative Fallback.
  # @!attribute [rw] selected_prompt
  #   @return [::String]
  #     Display name of the selected prompt.
  # @!attribute [rw] prompt_templates
  #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::GenerativeSettings::FallbackSettings::PromptTemplate>]
  #     Stored prompts that can be selected, for example default templates like
  #     "conservative" or "chatty", or user defined ones.
  class FallbackSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Prompt template.
    # @!attribute [rw] display_name
    #   @return [::String]
    #     Prompt name.
    # @!attribute [rw] prompt_text
    #   @return [::String]
    #     Prompt text that is sent to a LLM on no-match default, placeholders are
    #     filled downstream. For example: "Here is a conversation $conversation,
    #     a response is: "
    # @!attribute [rw] frozen
    #   @return [::Boolean]
    #     If the flag is true, the prompt is frozen and cannot be modified by
    #     users.
    class PromptTemplate
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Settings for knowledge connector. These parameters are used for LLM prompt
  # like "You are <agent>. You are a helpful and verbose <agent_identity> at
  # <business>, <business_description>. Your task is to help humans on
  # <agent_scope>".
  # @!attribute [rw] business
  #   @return [::String]
  #     Name of the company, organization or other entity that the agent
  #     represents. Used for knowledge connector LLM prompt and for knowledge
  #     search.
  # @!attribute [rw] agent
  #   @return [::String]
  #     Name of the virtual agent. Used for LLM prompt. Can be left empty.
  # @!attribute [rw] agent_identity
  #   @return [::String]
  #     Identity of the agent, e.g. "virtual agent", "AI assistant".
  # @!attribute [rw] business_description
  #   @return [::String]
  #     Company description, used for LLM prompt, e.g. "a family company selling
  #     freshly roasted coffee beans".
  # @!attribute [rw] agent_scope
  #   @return [::String]
  #     Agent scope, e.g. "Example company website", "internal Example
  #     company website for employees", "manual of car owner".
  # @!attribute [rw] disable_data_store_fallback
  #   @return [::Boolean]
  #     Whether to disable fallback to Data Store search results (in case the LLM
  #     couldn't pick a proper answer). Per default the feature is enabled.
  class KnowledgeConnectorSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end