Class: Google::Cloud::Dialogflow::V2::Conversation::ContextReference

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

Overview

Represents a section of ingested context information.

Defined Under Namespace

Modules: UpdateMode Classes: ContextContent

Instance Attribute Summary collapse

Instance Attribute Details

#context_contents ⇒ ::Array<::Google::Cloud::Dialogflow::V2::Conversation::ContextReference::ContextContent>

Returns Required. The list of content updates for a context reference.

Returns:



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'proto_docs/google/cloud/dialogflow/v2/conversation.rb', line 139

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

  # Contents ingested.
  # @!attribute [rw] content
  #   @return [::String]
  #     Required. The information ingested in a single request.
  # @!attribute [rw] content_format
  #   @return [::Google::Cloud::Dialogflow::V2::Conversation::ContextReference::ContextContent::ContentFormat]
  #     Required. The format of the ingested string.
  # @!attribute [r] ingestion_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when this information was incorporated into the
  #     relevant context reference.
  # @!attribute [rw] answer_record
  #   @return [::String]
  #     If the context content was generated from a tool call, specify the
  #     answer record associated with the tool call.
  #     Format: `projects/<Project ID>/locations/<Location
  #     ID>/answerRecords/<Answer Record ID>`.
  class ContextContent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents the format of the ingested string.
    module ContentFormat
      # Unspecified content format.
      CONTENT_FORMAT_UNSPECIFIED = 0

      # Content was provided in JSON format.
      JSON = 1

      # Content was provided as plain text.
      PLAIN_TEXT = 2
    end
  end

  # Represents the mode in which context reference contents are updated.
  module UpdateMode
    # Unspecified update mode.
    UPDATE_MODE_UNSPECIFIED = 0

    # Context content updates are applied in append mode.
    APPEND = 1

    # Context content updates are applied in overwrite mode.
    OVERWRITE = 2
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time the context reference was first created.

Returns:



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'proto_docs/google/cloud/dialogflow/v2/conversation.rb', line 139

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

  # Contents ingested.
  # @!attribute [rw] content
  #   @return [::String]
  #     Required. The information ingested in a single request.
  # @!attribute [rw] content_format
  #   @return [::Google::Cloud::Dialogflow::V2::Conversation::ContextReference::ContextContent::ContentFormat]
  #     Required. The format of the ingested string.
  # @!attribute [r] ingestion_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when this information was incorporated into the
  #     relevant context reference.
  # @!attribute [rw] answer_record
  #   @return [::String]
  #     If the context content was generated from a tool call, specify the
  #     answer record associated with the tool call.
  #     Format: `projects/<Project ID>/locations/<Location
  #     ID>/answerRecords/<Answer Record ID>`.
  class ContextContent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents the format of the ingested string.
    module ContentFormat
      # Unspecified content format.
      CONTENT_FORMAT_UNSPECIFIED = 0

      # Content was provided in JSON format.
      JSON = 1

      # Content was provided as plain text.
      PLAIN_TEXT = 2
    end
  end

  # Represents the mode in which context reference contents are updated.
  module UpdateMode
    # Unspecified update mode.
    UPDATE_MODE_UNSPECIFIED = 0

    # Context content updates are applied in append mode.
    APPEND = 1

    # Context content updates are applied in overwrite mode.
    OVERWRITE = 2
  end
end

#language_code ⇒ ::String

Returns Optional. The language of the information ingested, defaults to "en-US" if not set.

Returns:

  • (::String) —

    Optional. The language of the information ingested, defaults to "en-US" if not set.



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'proto_docs/google/cloud/dialogflow/v2/conversation.rb', line 139

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

  # Contents ingested.
  # @!attribute [rw] content
  #   @return [::String]
  #     Required. The information ingested in a single request.
  # @!attribute [rw] content_format
  #   @return [::Google::Cloud::Dialogflow::V2::Conversation::ContextReference::ContextContent::ContentFormat]
  #     Required. The format of the ingested string.
  # @!attribute [r] ingestion_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when this information was incorporated into the
  #     relevant context reference.
  # @!attribute [rw] answer_record
  #   @return [::String]
  #     If the context content was generated from a tool call, specify the
  #     answer record associated with the tool call.
  #     Format: `projects/<Project ID>/locations/<Location
  #     ID>/answerRecords/<Answer Record ID>`.
  class ContextContent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents the format of the ingested string.
    module ContentFormat
      # Unspecified content format.
      CONTENT_FORMAT_UNSPECIFIED = 0

      # Content was provided in JSON format.
      JSON = 1

      # Content was provided as plain text.
      PLAIN_TEXT = 2
    end
  end

  # Represents the mode in which context reference contents are updated.
  module UpdateMode
    # Unspecified update mode.
    UPDATE_MODE_UNSPECIFIED = 0

    # Context content updates are applied in append mode.
    APPEND = 1

    # Context content updates are applied in overwrite mode.
    OVERWRITE = 2
  end
end

#update_mode ⇒ ::Google::Cloud::Dialogflow::V2::Conversation::ContextReference::UpdateMode

Returns Required. The mode in which context reference contents are updated.

Returns:



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'proto_docs/google/cloud/dialogflow/v2/conversation.rb', line 139

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

  # Contents ingested.
  # @!attribute [rw] content
  #   @return [::String]
  #     Required. The information ingested in a single request.
  # @!attribute [rw] content_format
  #   @return [::Google::Cloud::Dialogflow::V2::Conversation::ContextReference::ContextContent::ContentFormat]
  #     Required. The format of the ingested string.
  # @!attribute [r] ingestion_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Output only. The time when this information was incorporated into the
  #     relevant context reference.
  # @!attribute [rw] answer_record
  #   @return [::String]
  #     If the context content was generated from a tool call, specify the
  #     answer record associated with the tool call.
  #     Format: `projects/<Project ID>/locations/<Location
  #     ID>/answerRecords/<Answer Record ID>`.
  class ContextContent
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents the format of the ingested string.
    module ContentFormat
      # Unspecified content format.
      CONTENT_FORMAT_UNSPECIFIED = 0

      # Content was provided in JSON format.
      JSON = 1

      # Content was provided as plain text.
      PLAIN_TEXT = 2
    end
  end

  # Represents the mode in which context reference contents are updated.
  module UpdateMode
    # Unspecified update mode.
    UPDATE_MODE_UNSPECIFIED = 0

    # Context content updates are applied in append mode.
    APPEND = 1

    # Context content updates are applied in overwrite mode.
    OVERWRITE = 2
  end
end