Class: Google::Cloud::DiscoveryEngine::V1::AssistantGroundedContent

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/discoveryengine/v1/assist_answer.rb

Overview

A piece of content and possibly its grounding information.

Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding.

Defined Under Namespace

Classes: TextGroundingMetadata

Instance Attribute Summary collapse

Instance Attribute Details

#content ⇒ ::Google::Cloud::DiscoveryEngine::V1::AssistantContent

Returns The content.

Returns:



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'proto_docs/google/cloud/discoveryengine/v1/assist_answer.rb', line 200

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

  # Grounding details for text sources.
  # @!attribute [rw] segments
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::AssistantGroundedContent::TextGroundingMetadata::Segment>]
  #     Grounding information for parts of the text.
  # @!attribute [rw] references
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::AssistantGroundedContent::TextGroundingMetadata::Reference>]
  #     References for the grounded text.
  class TextGroundingMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Grounding information for a segment of the text.
    # @!attribute [rw] start_index
    #   @return [::Integer]
    #     Zero-based index indicating the start of the segment, measured in bytes
    #     of a UTF-8 string (i.e. characters encoded on multiple bytes have a
    #     length of more than one).
    # @!attribute [rw] end_index
    #   @return [::Integer]
    #     End of the segment, exclusive.
    # @!attribute [rw] reference_indices
    #   @return [::Array<::Integer>]
    #     References for the segment.
    # @!attribute [rw] grounding_score
    #   @return [::Float]
    #     Score for the segment.
    # @!attribute [rw] text
    #   @return [::String]
    #     The text segment itself.
    class Segment
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Referenced content and related document metadata.
    # @!attribute [rw] content
    #   @return [::String]
    #     Referenced text content.
    # @!attribute [rw] document_metadata
    #   @return [::Google::Cloud::DiscoveryEngine::V1::AssistantGroundedContent::TextGroundingMetadata::Reference::DocumentMetadata]
    #     Document metadata.
    class Reference
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Document metadata.
      # @!attribute [rw] document
      #   @return [::String]
      #     Document resource name.
      # @!attribute [rw] uri
      #   @return [::String]
      #     URI for the document. It may contain a URL that redirects to the
      #     actual website.
      # @!attribute [rw] title
      #   @return [::String]
      #     Title.
      # @!attribute [rw] page_identifier
      #   @return [::String]
      #     Page identifier.
      # @!attribute [rw] domain
      #   @return [::String]
      #     Domain name from the document URI. Note that the `uri` field may
      #     contain a URL that redirects to the actual website, in which case
      #     this will contain the domain name of the target site.
      class DocumentMetadata
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end
end

#text_grounding_metadata ⇒ ::Google::Cloud::DiscoveryEngine::V1::AssistantGroundedContent::TextGroundingMetadata

Returns Metadata for grounding based on text sources.

Returns:



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'proto_docs/google/cloud/discoveryengine/v1/assist_answer.rb', line 200

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

  # Grounding details for text sources.
  # @!attribute [rw] segments
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::AssistantGroundedContent::TextGroundingMetadata::Segment>]
  #     Grounding information for parts of the text.
  # @!attribute [rw] references
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::AssistantGroundedContent::TextGroundingMetadata::Reference>]
  #     References for the grounded text.
  class TextGroundingMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Grounding information for a segment of the text.
    # @!attribute [rw] start_index
    #   @return [::Integer]
    #     Zero-based index indicating the start of the segment, measured in bytes
    #     of a UTF-8 string (i.e. characters encoded on multiple bytes have a
    #     length of more than one).
    # @!attribute [rw] end_index
    #   @return [::Integer]
    #     End of the segment, exclusive.
    # @!attribute [rw] reference_indices
    #   @return [::Array<::Integer>]
    #     References for the segment.
    # @!attribute [rw] grounding_score
    #   @return [::Float]
    #     Score for the segment.
    # @!attribute [rw] text
    #   @return [::String]
    #     The text segment itself.
    class Segment
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Referenced content and related document metadata.
    # @!attribute [rw] content
    #   @return [::String]
    #     Referenced text content.
    # @!attribute [rw] document_metadata
    #   @return [::Google::Cloud::DiscoveryEngine::V1::AssistantGroundedContent::TextGroundingMetadata::Reference::DocumentMetadata]
    #     Document metadata.
    class Reference
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Document metadata.
      # @!attribute [rw] document
      #   @return [::String]
      #     Document resource name.
      # @!attribute [rw] uri
      #   @return [::String]
      #     URI for the document. It may contain a URL that redirects to the
      #     actual website.
      # @!attribute [rw] title
      #   @return [::String]
      #     Title.
      # @!attribute [rw] page_identifier
      #   @return [::String]
      #     Page identifier.
      # @!attribute [rw] domain
      #   @return [::String]
      #     Domain name from the document URI. Note that the `uri` field may
      #     contain a URL that redirects to the actual website, in which case
      #     this will contain the domain name of the target site.
      class DocumentMetadata
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end
end