Class: Google::Cloud::DiscoveryEngine::V1::Answer::Reference::ChunkInfo

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

Overview

Chunk information.

Defined Under Namespace

Classes: DocumentMetadata

Instance Attribute Summary collapse

Instance Attribute Details

#chunk ⇒ ::String

Returns Chunk resource name.

Returns:

  • (::String) —

    Chunk resource name.



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
 
# File 'proto_docs/google/cloud/discoveryengine/v1/answer.rb', line 161

class ChunkInfo
  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.
  # @!attribute [rw] title
  #   @return [::String]
  #     Title.
  # @!attribute [rw] page_identifier
  #   @return [::String]
  #     Page identifier.
  # @!attribute [rw] struct_data
  #   @return [::Google::Protobuf::Struct]
  #     The structured JSON metadata for the document.
  #     It is populated from the struct data from the Chunk in search result.
  class DocumentMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#content ⇒ ::String

Returns Chunk textual content.

Returns:

  • (::String) —

    Chunk textual content.



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
 
# File 'proto_docs/google/cloud/discoveryengine/v1/answer.rb', line 161

class ChunkInfo
  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.
  # @!attribute [rw] title
  #   @return [::String]
  #     Title.
  # @!attribute [rw] page_identifier
  #   @return [::String]
  #     Page identifier.
  # @!attribute [rw] struct_data
  #   @return [::Google::Protobuf::Struct]
  #     The structured JSON metadata for the document.
  #     It is populated from the struct data from the Chunk in search result.
  class DocumentMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#document_metadata ⇒ ::Google::Cloud::DiscoveryEngine::V1::Answer::Reference::ChunkInfo::DocumentMetadata

Returns Document metadata.

Returns:



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
 
# File 'proto_docs/google/cloud/discoveryengine/v1/answer.rb', line 161

class ChunkInfo
  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.
  # @!attribute [rw] title
  #   @return [::String]
  #     Title.
  # @!attribute [rw] page_identifier
  #   @return [::String]
  #     Page identifier.
  # @!attribute [rw] struct_data
  #   @return [::Google::Protobuf::Struct]
  #     The structured JSON metadata for the document.
  #     It is populated from the struct data from the Chunk in search result.
  class DocumentMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#relevance_score ⇒ ::Float

Returns The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.

Returns:

  • (::Float) —

    The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.



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
 
# File 'proto_docs/google/cloud/discoveryengine/v1/answer.rb', line 161

class ChunkInfo
  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.
  # @!attribute [rw] title
  #   @return [::String]
  #     Title.
  # @!attribute [rw] page_identifier
  #   @return [::String]
  #     Page identifier.
  # @!attribute [rw] struct_data
  #   @return [::Google::Protobuf::Struct]
  #     The structured JSON metadata for the document.
  #     It is populated from the struct data from the Chunk in search result.
  class DocumentMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end