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

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

Overview

Step information.

Defined Under Namespace

Modules: State Classes: Action

Instance Attribute Summary collapse

Instance Attribute Details

#actions ⇒ ::Array<::Google::Cloud::DiscoveryEngine::V1::Answer::Step::Action>

Returns Actions.

Returns:



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
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
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'proto_docs/google/cloud/discoveryengine/v1/answer.rb', line 214

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

  # Action.
  # @!attribute [rw] search_action
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Answer::Step::Action::SearchAction]
  #     Search action.
  # @!attribute [rw] observation
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Answer::Step::Action::Observation]
  #     Observation.
  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

  # Enumeration of the state of the step.
  module State
    # Unknown.
    STATE_UNSPECIFIED = 0

    # Step is currently in progress.
    IN_PROGRESS = 1

    # Step currently failed.
    FAILED = 2

    # Step has succeeded.
    SUCCEEDED = 3
  end
end

#description ⇒ ::String

Returns The description of the step.

Returns:

  • (::String) —

    The description of the step.



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
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
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'proto_docs/google/cloud/discoveryengine/v1/answer.rb', line 214

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

  # Action.
  # @!attribute [rw] search_action
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Answer::Step::Action::SearchAction]
  #     Search action.
  # @!attribute [rw] observation
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Answer::Step::Action::Observation]
  #     Observation.
  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

  # Enumeration of the state of the step.
  module State
    # Unknown.
    STATE_UNSPECIFIED = 0

    # Step is currently in progress.
    IN_PROGRESS = 1

    # Step currently failed.
    FAILED = 2

    # Step has succeeded.
    SUCCEEDED = 3
  end
end

#state ⇒ ::Google::Cloud::DiscoveryEngine::V1::Answer::Step::State

Returns The state of the step.

Returns:



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
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
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'proto_docs/google/cloud/discoveryengine/v1/answer.rb', line 214

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

  # Action.
  # @!attribute [rw] search_action
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Answer::Step::Action::SearchAction]
  #     Search action.
  # @!attribute [rw] observation
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Answer::Step::Action::Observation]
  #     Observation.
  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

  # Enumeration of the state of the step.
  module State
    # Unknown.
    STATE_UNSPECIFIED = 0

    # Step is currently in progress.
    IN_PROGRESS = 1

    # Step currently failed.
    FAILED = 2

    # Step has succeeded.
    SUCCEEDED = 3
  end
end

#thought ⇒ ::String

Returns The thought of the step.

Returns:

  • (::String) —

    The thought of the step.



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
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
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'proto_docs/google/cloud/discoveryengine/v1/answer.rb', line 214

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

  # Action.
  # @!attribute [rw] search_action
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Answer::Step::Action::SearchAction]
  #     Search action.
  # @!attribute [rw] observation
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Answer::Step::Action::Observation]
  #     Observation.
  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

  # Enumeration of the state of the step.
  module State
    # Unknown.
    STATE_UNSPECIFIED = 0

    # Step is currently in progress.
    IN_PROGRESS = 1

    # Step currently failed.
    FAILED = 2

    # Step has succeeded.
    SUCCEEDED = 3
  end
end