Class: Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::SearchSpec::SearchResultList

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

Overview

Search result list.

Defined Under Namespace

Classes: SearchResult

Instance Attribute Summary collapse

Instance Attribute Details

#search_results ⇒ ::Array<::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::SearchSpec::SearchResultList::SearchResult>

Returns Search results.

Returns:



471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/conversational_search_service.rb', line 471

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

  # Search result.
  # @!attribute [rw] unstructured_document_info
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::SearchSpec::SearchResultList::SearchResult::UnstructuredDocumentInfo]
  #     Unstructured document information.
  # @!attribute [rw] chunk_info
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::SearchSpec::SearchResultList::SearchResult::ChunkInfo]
  #     Chunk information.
  class SearchResult
    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] document_contexts
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::SearchSpec::SearchResultList::SearchResult::UnstructuredDocumentInfo::DocumentContext>]
    #     List of document contexts.
    # @!attribute [rw] extractive_segments
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::SearchSpec::SearchResultList::SearchResult::UnstructuredDocumentInfo::ExtractiveSegment>]
    #     List of extractive segments.
    # @!attribute [rw] extractive_answers
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::SearchSpec::SearchResultList::SearchResult::UnstructuredDocumentInfo::ExtractiveAnswer>]
    #     List of extractive answers.
    class UnstructuredDocumentInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Document context.
      # @!attribute [rw] page_identifier
      #   @return [::String]
      #     Page identifier.
      # @!attribute [rw] content
      #   @return [::String]
      #     Document content.
      class DocumentContext
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Extractive segment.
      # [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments)
      # @!attribute [rw] page_identifier
      #   @return [::String]
      #     Page identifier.
      # @!attribute [rw] content
      #   @return [::String]
      #     Extractive segment content.
      class ExtractiveSegment
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Extractive answer.
      # [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#get-answers)
      # @!attribute [rw] page_identifier
      #   @return [::String]
      #     Page identifier.
      # @!attribute [rw] content
      #   @return [::String]
      #     Extractive answer content.
      class ExtractiveAnswer
        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.
    class ChunkInfo
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end