Class SnippetSpec (0.10.0)

Version 0.10.0

• 0.13.4 (latest)
• 0.13.3
• 0.12.3
• 0.11.14
• 0.10.0
• 0.9.1
• 0.8.1
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.1
• 0.3.1
• 0.2.1
• 0.1.1

SnippetSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A specification for configuring snippets in a search response.

Attributes
Name	Description
max_snippet_count	int [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.
reference_only	bool [DEPRECATED] This field is deprecated and will have no affect on the snippet.
return_snippet	bool 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.