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

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

Overview

Reference.

Defined Under Namespace

Classes: ChunkInfo, StructuredDocumentInfo, UnstructuredDocumentInfo

Instance Attribute Summary collapse

Instance Attribute Details

#chunk_info ⇒ ::Google::Cloud::DiscoveryEngine::V1::Answer::Reference::ChunkInfo

Returns Chunk information.

Note: The following fields are mutually exclusive: chunk_info, unstructured_document_info, structured_document_info. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



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
189
190
191
192
193
194
195
196
197
198
199
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
 
# File 'proto_docs/google/cloud/discoveryengine/v1/answer.rb', line 147

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

  # Unstructured document information.
  # @!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] chunk_contents
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Answer::Reference::UnstructuredDocumentInfo::ChunkContent>]
  #     List of cited chunk contents derived from document content.
  # @!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 UnstructuredDocumentInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Chunk content.
    # @!attribute [rw] content
    #   @return [::String]
    #     Chunk textual content.
    # @!attribute [rw] page_identifier
    #   @return [::String]
    #     Page identifier.
    # @!attribute [rw] relevance_score
    #   @return [::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.
    class ChunkContent
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Chunk information.
  # @!attribute [rw] chunk
  #   @return [::String]
  #     Chunk resource name.
  # @!attribute [rw] content
  #   @return [::String]
  #     Chunk textual content.
  # @!attribute [rw] relevance_score
  #   @return [::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.
  # @!attribute [rw] document_metadata
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Answer::Reference::ChunkInfo::DocumentMetadata]
  #     Document metadata.
  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

  # Structured search information.
  # @!attribute [rw] document
  #   @return [::String]
  #     Document resource name.
  # @!attribute [rw] struct_data
  #   @return [::Google::Protobuf::Struct]
  #     Structured search data.
  # @!attribute [r] title
  #   @return [::String]
  #     Output only. The title of the document.
  # @!attribute [r] uri
  #   @return [::String]
  #     Output only. The URI of the document.
  class StructuredDocumentInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#structured_document_info ⇒ ::Google::Cloud::DiscoveryEngine::V1::Answer::Reference::StructuredDocumentInfo

Returns Structured document information.

Note: The following fields are mutually exclusive: structured_document_info, unstructured_document_info, chunk_info. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



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
189
190
191
192
193
194
195
196
197
198
199
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
 
# File 'proto_docs/google/cloud/discoveryengine/v1/answer.rb', line 147

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

  # Unstructured document information.
  # @!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] chunk_contents
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Answer::Reference::UnstructuredDocumentInfo::ChunkContent>]
  #     List of cited chunk contents derived from document content.
  # @!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 UnstructuredDocumentInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Chunk content.
    # @!attribute [rw] content
    #   @return [::String]
    #     Chunk textual content.
    # @!attribute [rw] page_identifier
    #   @return [::String]
    #     Page identifier.
    # @!attribute [rw] relevance_score
    #   @return [::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.
    class ChunkContent
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Chunk information.
  # @!attribute [rw] chunk
  #   @return [::String]
  #     Chunk resource name.
  # @!attribute [rw] content
  #   @return [::String]
  #     Chunk textual content.
  # @!attribute [rw] relevance_score
  #   @return [::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.
  # @!attribute [rw] document_metadata
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Answer::Reference::ChunkInfo::DocumentMetadata]
  #     Document metadata.
  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

  # Structured search information.
  # @!attribute [rw] document
  #   @return [::String]
  #     Document resource name.
  # @!attribute [rw] struct_data
  #   @return [::Google::Protobuf::Struct]
  #     Structured search data.
  # @!attribute [r] title
  #   @return [::String]
  #     Output only. The title of the document.
  # @!attribute [r] uri
  #   @return [::String]
  #     Output only. The URI of the document.
  class StructuredDocumentInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#unstructured_document_info ⇒ ::Google::Cloud::DiscoveryEngine::V1::Answer::Reference::UnstructuredDocumentInfo

Returns Unstructured document information.

Note: The following fields are mutually exclusive: unstructured_document_info, chunk_info, structured_document_info. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



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
189
190
191
192
193
194
195
196
197
198
199
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
 
# File 'proto_docs/google/cloud/discoveryengine/v1/answer.rb', line 147

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

  # Unstructured document information.
  # @!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] chunk_contents
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Answer::Reference::UnstructuredDocumentInfo::ChunkContent>]
  #     List of cited chunk contents derived from document content.
  # @!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 UnstructuredDocumentInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Chunk content.
    # @!attribute [rw] content
    #   @return [::String]
    #     Chunk textual content.
    # @!attribute [rw] page_identifier
    #   @return [::String]
    #     Page identifier.
    # @!attribute [rw] relevance_score
    #   @return [::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.
    class ChunkContent
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Chunk information.
  # @!attribute [rw] chunk
  #   @return [::String]
  #     Chunk resource name.
  # @!attribute [rw] content
  #   @return [::String]
  #     Chunk textual content.
  # @!attribute [rw] relevance_score
  #   @return [::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.
  # @!attribute [rw] document_metadata
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Answer::Reference::ChunkInfo::DocumentMetadata]
  #     Document metadata.
  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

  # Structured search information.
  # @!attribute [rw] document
  #   @return [::String]
  #     Document resource name.
  # @!attribute [rw] struct_data
  #   @return [::Google::Protobuf::Struct]
  #     Structured search data.
  # @!attribute [r] title
  #   @return [::String]
  #     Output only. The title of the document.
  # @!attribute [r] uri
  #   @return [::String]
  #     Output only. The URI of the document.
  class StructuredDocumentInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end