public sealed class RetrievalMetadata : IMessage<RetrievalMetadata>, IEquatable<RetrievalMetadata>, IDeepCloneable<RetrievalMetadata>, IBufferMessage, IMessage
Reference documentation and code samples for the Vertex AI v1beta1 API class RetrievalMetadata.
Metadata related to retrieval in the grounding flow.
public float GoogleSearchDynamicRetrievalScore { get; set; }
Optional. Score indicating how likely information from Google Search could
help answer the prompt. The score is in the range [0, 1], where 0 is the
least likely and 1 is the most likely. This score is only populated when
Google Search grounding and dynamic retrieval is enabled. It will be
compared to the threshold to determine whether to trigger Google Search.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-14 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eRetrievalMetadata\u003c/code\u003e class, part of the Vertex AI v1beta1 API, provides metadata for retrieval in the grounding flow, specifically within the namespace \u003ccode\u003eGoogle.Cloud.AIPlatform.V1Beta1\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThis class implements several interfaces, including \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, and \u003ccode\u003eIBufferMessage\u003c/code\u003e, and inherits from \u003ccode\u003eobject\u003c/code\u003e, providing it with base functionalities.\u003c/p\u003e\n"],["\u003cp\u003eTwo constructors are available for creating instances of \u003ccode\u003eRetrievalMetadata\u003c/code\u003e: a default constructor and one that takes another \u003ccode\u003eRetrievalMetadata\u003c/code\u003e object as a parameter for copying.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eRetrievalMetadata\u003c/code\u003e class features a property called \u003ccode\u003eGoogleSearchDynamicRetrievalScore\u003c/code\u003e, a float that represents the likelihood that Google Search can assist in answering a prompt, within a scale of 0 to 1.\u003c/p\u003e\n"],["\u003cp\u003eThe latest version available for the class \u003ccode\u003eRetrievalMetadata\u003c/code\u003e is \u003ccode\u003e1.0.0-beta21\u003c/code\u003e, while an older version, \u003ccode\u003e1.0.0-beta20\u003c/code\u003e, is also listed.\u003c/p\u003e\n"]]],[],null,[]]
