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

Inherits:
Object
  • Object
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 snippets in a search response.

Instance Attribute Summary collapse

Instance Attribute Details

#max_snippet_count ⇒ ::Integer

Deprecated.

This field is deprecated and may be removed in the next major version update.

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

Returns:

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



456
457
458
459
 
# File 'proto_docs/google/cloud/discoveryengine/v1/search_service.rb', line 456

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

#reference_only ⇒ ::Boolean

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns [DEPRECATED] This field is deprecated and will have no affect on the snippet.

Returns:

  • (::Boolean) —

    [DEPRECATED] This field is deprecated and will have no affect on the snippet.



456
457
458
459
 
# File 'proto_docs/google/cloud/discoveryengine/v1/search_service.rb', line 456

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

#return_snippet ⇒ ::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.

Returns:

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



456
457
458
459
 
# File 'proto_docs/google/cloud/discoveryengine/v1/search_service.rb', line 456

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