Class: Google::Cloud::DiscoveryEngine::V1beta::Answer::Step::Action::Observation::SearchResult

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

Defined Under Namespace

Classes: ChunkInfo, SnippetInfo

Instance Attribute Summary collapse

Instance Attribute Details

#chunk_info ⇒ ::Array<::Google::Cloud::DiscoveryEngine::V1beta::Answer::Step::Action::Observation::SearchResult::ChunkInfo>

Returns If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.

Returns:



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

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

  # Snippet information.
  # @!attribute [rw] snippet
  #   @return [::String]
  #     Snippet content.
  # @!attribute [rw] snippet_status
  #   @return [::String]
  #     Status of the snippet defined by the search team.
  class SnippetInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  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]
  #     Relevance score.
  class ChunkInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#document ⇒ ::String

Returns Document resource name.

Returns:

  • (::String) —

    Document resource name.



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

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

  # Snippet information.
  # @!attribute [rw] snippet
  #   @return [::String]
  #     Snippet content.
  # @!attribute [rw] snippet_status
  #   @return [::String]
  #     Status of the snippet defined by the search team.
  class SnippetInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  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]
  #     Relevance score.
  class ChunkInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#snippet_info ⇒ ::Array<::Google::Cloud::DiscoveryEngine::V1beta::Answer::Step::Action::Observation::SearchResult::SnippetInfo>

Returns If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.

Returns:



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

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

  # Snippet information.
  # @!attribute [rw] snippet
  #   @return [::String]
  #     Snippet content.
  # @!attribute [rw] snippet_status
  #   @return [::String]
  #     Status of the snippet defined by the search team.
  class SnippetInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  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]
  #     Relevance score.
  class ChunkInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#title ⇒ ::String

Returns Title.

Returns:

  • (::String) —

    Title.



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

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

  # Snippet information.
  # @!attribute [rw] snippet
  #   @return [::String]
  #     Snippet content.
  # @!attribute [rw] snippet_status
  #   @return [::String]
  #     Status of the snippet defined by the search team.
  class SnippetInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  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]
  #     Relevance score.
  class ChunkInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#uri ⇒ ::String

Returns URI for the document.

Returns:

  • (::String) —

    URI for the document.



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

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

  # Snippet information.
  # @!attribute [rw] snippet
  #   @return [::String]
  #     Snippet content.
  # @!attribute [rw] snippet_status
  #   @return [::String]
  #     Status of the snippet defined by the search team.
  class SnippetInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  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]
  #     Relevance score.
  class ChunkInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end