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

Inherits:

Object

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

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 snippet in the search results.

Instance Attribute Summary

• #max_snippet_count ⇒ ::Integer

  Max number of snippets returned in each search result.

• #reference_only ⇒ ::Boolean

  If true, only snippet reference is returned.

Instance Attribute Details

#max_snippet_count ⇒ ::Integer

Returns 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.

Returns:

• (::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.

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

class SnippetSpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#reference_only ⇒ ::Boolean

Returns if true, only snippet reference is returned.

Returns:

• (::Boolean) —

  if true, only snippet reference is returned.

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

class SnippetSpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end