Class: Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec

Inherits:

Object

Object
Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

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

Overview

A specification for configuring the behavior of content search.

Defined Under Namespace

Classes: SnippetSpec, SummarySpec

Instance Attribute Summary collapse

#snippet_spec ⇒ ::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SnippetSpec
If snippetSpec is not specified, snippets are not included in the search response.
#summary_spec ⇒ ::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SummarySpec
If summarySpec is not specified, summaries are not included in the search response.

Instance Attribute Details

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

Returns If snippetSpec is not specified, snippets are not included in the search response.

Returns:

(::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SnippetSpec) —
If snippetSpec is not specified, snippets are not included in the search response.

# File 'proto_docs/google/cloud/discoveryengine/v1/search_service.rb', line 435

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

  # A specification for configuring snippets in a search response.
  # @!attribute [rw] max_snippet_count
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Integer]
  #     [DEPRECATED] This field is deprecated. To control snippet return, use
  #     `return_snippet` field. For backwards compatibility, we will return
  #     snippet if max_snippet_count > 0.
  # @!attribute [rw] reference_only
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  #     [DEPRECATED] This field is deprecated and will have no affect on the
  #     snippet.
  # @!attribute [rw] return_snippet
  #   @return [::Boolean]
  #     If `true`, then return snippet. If no snippet can be generated, we
  #     return "No snippet is available for this page." A `snippet_status` with
  #     `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.
  class SnippetSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A specification for configuring a summary returned in a search
  # response.
  # @!attribute [rw] summary_result_count
  #   @return [::Integer]
  #     The number of top results to generate the summary from. If the number
  #     of results returned is less than `summaryResultCount`, the summary is
  #     generated from all of the results.
  #
  #     At most five results can be used to generate a summary.
  # @!attribute [rw] include_citations
  #   @return [::Boolean]
  #     Specifies whether to include citations in the summary. The default
  #     value is `false`.
  #
  #     When this field is set to `true`, summaries include in-line citation
  #     numbers.
  #
  #     Example summary including citations:
  #
  #     BigQuery is Google Cloud's fully managed and completely serverless
  #     enterprise data warehouse [1]. BigQuery supports all data types, works
  #     across clouds, and has built-in machine learning and business
  #     intelligence, all within a unified platform [2, 3].
  #
  #     The citation numbers refer to the returned search results and are
  #     1-indexed. For example, [1] means that the sentence is attributed to
  #     the first search result. [2, 3] means that the sentence is attributed
  #     to both the second and third search results.
  # @!attribute [rw] ignore_adversarial_query
  #   @return [::Boolean]
  #     Specifies whether to filter out adversarial queries. The default value
  #     is `false`.
  #
  #     Google employs search-query classification to detect adversarial
  #     queries. No summary is returned if the search query is classified as an
  #     adversarial query. For example, a user might ask a question regarding
  #     negative comments about the company or submit a query designed to
  #     generate unsafe, policy-violating output. If this field is set to
  #     `true`, we skip generating summaries for adversarial queries and return
  #     fallback messages instead.
  # @!attribute [rw] ignore_non_summary_seeking_query
  #   @return [::Boolean]
  #     Specifies whether to filter out queries that are not summary-seeking.
  #     The default value is `false`.
  #
  #     Google employs search-query classification to detect summary-seeking
  #     queries. No summary is returned if the search query is classified as a
  #     non-summary seeking query. For example, `why is the sky blue` and `Who
  #     is the best soccer player in the world?` are summary-seeking queries,
  #     but `SFO airport` and `world cup 2026` are not. They are most likely
  #     navigational queries. If this field is set to `true`, we skip
  #     generating summaries for non-summary seeking queries and return
  #     fallback messages instead.
  # @!attribute [rw] language_code
  #   @return [::String]
  #     Language code for Summary. Use language tags defined by
  #     [BCP47][https://www.rfc-editor.org/rfc/bcp/bcp47.txt].
  class SummarySpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

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

Returns If summarySpec is not specified, summaries are not included in the search response.