Class: Google::Cloud::Dialogflow::CX::V3::Generator

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

Overview

Generators contain prompt to be sent to the LLM model to generate text. The prompt can contain parameters which will be resolved before calling the model. It can optionally contain banned phrases to ensure the model responses are safe.

Defined Under Namespace

Classes: Placeholder

Instance Attribute Summary collapse

Instance Attribute Details

#display_name ⇒ ::String

Returns Required. The human-readable name of the generator, unique within the agent. The prompt contains pre-defined parameters such as $conversation, $last-user-utterance, etc. populated by Dialogflow. It can also contain custom placeholders which will be resolved during fulfillment.

Returns:

  • (::String) —

    Required. The human-readable name of the generator, unique within the agent. The prompt contains pre-defined parameters such as $conversation, $last-user-utterance, etc. populated by Dialogflow. It can also contain custom placeholders which will be resolved during fulfillment.



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/generator.rb', line 49

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

  # Represents a custom placeholder in the prompt text.
  # @!attribute [rw] id
  #   @return [::String]
  #     Unique ID used to map custom placeholder to parameters in fulfillment.
  # @!attribute [rw] name
  #   @return [::String]
  #     Custom placeholder value in the prompt text.
  class Placeholder
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String

Returns The unique identifier of the generator. Must be set for the Generators.UpdateGenerator method. [Generators.CreateGenerate][] populates the name automatically. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/generators/<Generator ID>.

Returns:

  • (::String) —

    The unique identifier of the generator. Must be set for the Generators.UpdateGenerator method. [Generators.CreateGenerate][] populates the name automatically. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/generators/<Generator ID>.



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/generator.rb', line 49

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

  # Represents a custom placeholder in the prompt text.
  # @!attribute [rw] id
  #   @return [::String]
  #     Unique ID used to map custom placeholder to parameters in fulfillment.
  # @!attribute [rw] name
  #   @return [::String]
  #     Custom placeholder value in the prompt text.
  class Placeholder
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#placeholders ⇒ ::Array<::Google::Cloud::Dialogflow::CX::V3::Generator::Placeholder>

Returns Optional. List of custom placeholders in the prompt text.

Returns:



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/generator.rb', line 49

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

  # Represents a custom placeholder in the prompt text.
  # @!attribute [rw] id
  #   @return [::String]
  #     Unique ID used to map custom placeholder to parameters in fulfillment.
  # @!attribute [rw] name
  #   @return [::String]
  #     Custom placeholder value in the prompt text.
  class Placeholder
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#prompt_text ⇒ ::Google::Cloud::Dialogflow::CX::V3::Phrase

Returns Required. Prompt for the LLM model.

Returns:



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/generator.rb', line 49

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

  # Represents a custom placeholder in the prompt text.
  # @!attribute [rw] id
  #   @return [::String]
  #     Unique ID used to map custom placeholder to parameters in fulfillment.
  # @!attribute [rw] name
  #   @return [::String]
  #     Custom placeholder value in the prompt text.
  class Placeholder
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end