Discovery Engine V1BETA API - Class Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SnippetSpec (v0.3.0)

Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SnippetSpec.

The specification that configs the snippet in the search results.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#max_snippet_count

def max_snippet_count() -> ::Integer
Returns
  • (::Integer) — Max number of snippets returned in each search result.

    A snippet is an infomartive summary of a content with highlighting for UI rendering.

    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.

#max_snippet_count=

def max_snippet_count=(value) -> ::Integer
Parameter
  • value (::Integer) — Max number of snippets returned in each search result.

    A snippet is an infomartive summary of a content with highlighting for UI rendering.

    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.

Returns
  • (::Integer) — Max number of snippets returned in each search result.

    A snippet is an infomartive summary of a content with highlighting for UI rendering.

    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.

#reference_only

def reference_only() -> ::Boolean
Returns
  • (::Boolean) — if true, only snippet reference is returned.

#reference_only=

def reference_only=(value) -> ::Boolean
Parameter
  • value (::Boolean) — if true, only snippet reference is returned.
Returns
  • (::Boolean) — if true, only snippet reference is returned.