Class SnippetSpec (0.12.0)

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.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2024-12-13 UTC.

Attributes