public sealed class SearchRequest.Types.ContentSearchSpec.Types.SnippetSpec : IMessage<SearchRequest.Types.ContentSearchSpec.Types.SnippetSpec>, IEquatable<SearchRequest.Types.ContentSearchSpec.Types.SnippetSpec>, IDeepCloneable<SearchRequest.Types.ContentSearchSpec.Types.SnippetSpec>, IBufferMessage, IMessage
Reference documentation and code samples for the Discovery Engine v1 API class SearchRequest.Types.ContentSearchSpec.Types.SnippetSpec.
A specification for configuring snippets in a search response.
[Obsolete]public int MaxSnippetCount { get; set; }
[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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["\u003cp\u003eThis documentation page covers the \u003ccode\u003eSnippetSpec\u003c/code\u003e class, which is part of the Discovery Engine v1 API, specifically within the \u003ccode\u003eSearchRequest.Types.ContentSearchSpec.Types\u003c/code\u003e namespace.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eSnippetSpec\u003c/code\u003e class is designed to configure snippets in a search response, enabling control over whether snippets are returned and, previously, their quantity, although some properties are now deprecated.\u003c/p\u003e\n"],["\u003cp\u003eThe latest version of the API is 1.6.0, with several previous versions available, including 1.5.0, 1.4.0, 1.3.0, 1.2.0, 1.1.0, and a beta version 1.0.0-beta06.\u003c/p\u003e\n"],["\u003cp\u003eThe class implements multiple interfaces including \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, and \u003ccode\u003eIBufferMessage\u003c/code\u003e, indicating its role in message handling, comparison, deep cloning, and buffer management.\u003c/p\u003e\n"],["\u003cp\u003eKey properties include \u003ccode\u003eReturnSnippet\u003c/code\u003e to control if a snippet is displayed, and the now deprecated \u003ccode\u003eMaxSnippetCount\u003c/code\u003e and \u003ccode\u003eReferenceOnly\u003c/code\u003e properties which previously managed snippet quantities and reference behavior.\u003c/p\u003e\n"]]],[],null,[]]
