Class: Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec

Inherits:

Object

Object
Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb

Overview

The specification that configs the desired behavior of the UCS content search.

Defined Under Namespace

Classes: SnippetSpec, SummarySpec

Instance Attribute Summary collapse

#snippet_spec ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SnippetSpec
If there is no snippet spec provided, there will be no snippet in the search result.
#summary_spec ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec
If there is no summary spec provided, there will be no summary in the search response.

Instance Attribute Details

#snippet_spec ⇒ `::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SnippetSpec`

Returns If there is no snippet spec provided, there will be no snippet in the search result.

Returns:

(::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SnippetSpec) —
If there is no snippet spec provided, there will be no snippet in the search result.

# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 418

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

  # The specification that configs the snippet in the search results.
  # @!attribute [rw] max_snippet_count
  #   @return [::Integer]
  #     Max number of snippets returned in each search result.
  #     If the matching snippets is less than the max_snippet_count, return all
  #     of the snippets; otherwise, return the max_snippet_count.
  #
  #     At most 5 snippets will be returned for each SearchResult.
  # @!attribute [rw] reference_only
  #   @return [::Boolean]
  #     if true, only snippet reference is returned.
  class SnippetSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The specification that configs the summary in the search response.
  # @!attribute [rw] summary_result_count
  #   @return [::Integer]
  #     The number of top results the summary should be generated from.
  #     If the number of returned results is less than summary_result_count,
  #     then the summary would be derived from all the results; otherwise, the
  #     summary would be derived from the top results.
  #
  #     At most 5 results can be used for generating summary.
  class SummarySpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#summary_spec ⇒ `::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec`

Returns If there is no summary spec provided, there will be no summary in the search response.