Class: Google::Cloud::DiscoveryEngine::V1::Answer::Step::Action

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

Overview

Action.

Defined Under Namespace

Classes: Observation, SearchAction

Instance Attribute Summary collapse

Instance Attribute Details

#observation ⇒ ::Google::Cloud::DiscoveryEngine::V1::Answer::Step::Action::Observation

Returns Observation.

Returns:



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
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'proto_docs/google/cloud/discoveryengine/v1/answer.rb', line 225

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

  # Search action.
  # @!attribute [rw] query
  #   @return [::String]
  #     The query to search.
  class SearchAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Observation.
  # @!attribute [rw] search_results
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Answer::Step::Action::Observation::SearchResult>]
  #     Search results observed by the search action, it can be snippets info
  #     or chunk info, depending on the citation type set by the user.
  class Observation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!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] snippet_info
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Answer::Step::Action::Observation::SearchResult::SnippetInfo>]
    #     If citation_type is DOCUMENT_LEVEL_CITATION, populate document
    #     level snippets.
    # @!attribute [rw] chunk_info
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Answer::Step::Action::Observation::SearchResult::ChunkInfo>]
    #     If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on,
    #     populate chunk info.
    # @!attribute [rw] struct_data
    #   @return [::Google::Protobuf::Struct]
    #     Data representation.
    #     The structured JSON data for the document.
    #     It's populated from the struct data from the Document, or the
    #     Chunk in search result.
    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]
      #     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 ChunkInfo
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end
end

#search_action ⇒ ::Google::Cloud::DiscoveryEngine::V1::Answer::Step::Action::SearchAction

Returns Search action.

Returns:



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
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'proto_docs/google/cloud/discoveryengine/v1/answer.rb', line 225

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

  # Search action.
  # @!attribute [rw] query
  #   @return [::String]
  #     The query to search.
  class SearchAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Observation.
  # @!attribute [rw] search_results
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Answer::Step::Action::Observation::SearchResult>]
  #     Search results observed by the search action, it can be snippets info
  #     or chunk info, depending on the citation type set by the user.
  class Observation
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!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] snippet_info
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Answer::Step::Action::Observation::SearchResult::SnippetInfo>]
    #     If citation_type is DOCUMENT_LEVEL_CITATION, populate document
    #     level snippets.
    # @!attribute [rw] chunk_info
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Answer::Step::Action::Observation::SearchResult::ChunkInfo>]
    #     If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on,
    #     populate chunk info.
    # @!attribute [rw] struct_data
    #   @return [::Google::Protobuf::Struct]
    #     Data representation.
    #     The structured JSON data for the document.
    #     It's populated from the struct data from the Document, or the
    #     Chunk in search result.
    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]
      #     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 ChunkInfo
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end
end