GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec (google_api_discovery_engine v0.28.0)

A specification for configuring snippets in a search response.

Attributes

maxSnippetCount (type: integer(), default: nil) - [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.
referenceOnly (type: boolean(), default: nil) - [DEPRECATED] This field is deprecated and will have no affect on the snippet.
returnSnippet (type: boolean(), default: nil) - 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.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
  %GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec{
    maxSnippetCount: integer() | nil,
    referenceOnly: boolean() | nil,
    returnSnippet: boolean() | nil
  }

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.