Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class RetrievalMetadata.
Metadata related to retrieval in the grounding flow.
Generated from protobuf message google.cloud.aiplatform.v1.RetrievalMetadata
Namespace
Google \ Cloud \ AIPlatform \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ google_search_dynamic_retrieval_score
float
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.
getGoogleSearchDynamicRetrievalScore
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.
Returns
Type
Description
float
setGoogleSearchDynamicRetrievalScore
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-09-04 UTC."],[],[],null,["# Google Cloud Ai Platform V1 Client - Class RetrievalMetadata (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/php/docs/reference/cloud-ai-platform/latest/V1.RetrievalMetadata)\n- [1.34.0](/php/docs/reference/cloud-ai-platform/1.34.0/V1.RetrievalMetadata)\n- [1.33.0](/php/docs/reference/cloud-ai-platform/1.33.0/V1.RetrievalMetadata)\n- [1.32.1](/php/docs/reference/cloud-ai-platform/1.32.1/V1.RetrievalMetadata)\n- [1.31.0](/php/docs/reference/cloud-ai-platform/1.31.0/V1.RetrievalMetadata)\n- [1.30.0](/php/docs/reference/cloud-ai-platform/1.30.0/V1.RetrievalMetadata)\n- [1.26.0](/php/docs/reference/cloud-ai-platform/1.26.0/V1.RetrievalMetadata)\n- [1.23.0](/php/docs/reference/cloud-ai-platform/1.23.0/V1.RetrievalMetadata)\n- [1.22.0](/php/docs/reference/cloud-ai-platform/1.22.0/V1.RetrievalMetadata)\n- [1.21.0](/php/docs/reference/cloud-ai-platform/1.21.0/V1.RetrievalMetadata)\n- [1.20.0](/php/docs/reference/cloud-ai-platform/1.20.0/V1.RetrievalMetadata)\n- [1.19.0](/php/docs/reference/cloud-ai-platform/1.19.0/V1.RetrievalMetadata)\n- [1.18.0](/php/docs/reference/cloud-ai-platform/1.18.0/V1.RetrievalMetadata)\n- [1.17.0](/php/docs/reference/cloud-ai-platform/1.17.0/V1.RetrievalMetadata)\n- [1.16.0](/php/docs/reference/cloud-ai-platform/1.16.0/V1.RetrievalMetadata)\n- [1.15.0](/php/docs/reference/cloud-ai-platform/1.15.0/V1.RetrievalMetadata)\n- [1.14.0](/php/docs/reference/cloud-ai-platform/1.14.0/V1.RetrievalMetadata)\n- [1.13.1](/php/docs/reference/cloud-ai-platform/1.13.1/V1.RetrievalMetadata)\n- [1.12.0](/php/docs/reference/cloud-ai-platform/1.12.0/V1.RetrievalMetadata)\n- [1.11.0](/php/docs/reference/cloud-ai-platform/1.11.0/V1.RetrievalMetadata)\n- [1.10.0](/php/docs/reference/cloud-ai-platform/1.10.0/V1.RetrievalMetadata)\n- [1.9.0](/php/docs/reference/cloud-ai-platform/1.9.0/V1.RetrievalMetadata)\n- [1.8.0](/php/docs/reference/cloud-ai-platform/1.8.0/V1.RetrievalMetadata)\n- [1.7.0](/php/docs/reference/cloud-ai-platform/1.7.0/V1.RetrievalMetadata)\n- [1.6.0](/php/docs/reference/cloud-ai-platform/1.6.0/V1.RetrievalMetadata)\n- [1.5.0](/php/docs/reference/cloud-ai-platform/1.5.0/V1.RetrievalMetadata)\n- [1.4.0](/php/docs/reference/cloud-ai-platform/1.4.0/V1.RetrievalMetadata)\n- [1.3.0](/php/docs/reference/cloud-ai-platform/1.3.0/V1.RetrievalMetadata)\n- [1.2.0](/php/docs/reference/cloud-ai-platform/1.2.0/V1.RetrievalMetadata)\n- [1.1.0](/php/docs/reference/cloud-ai-platform/1.1.0/V1.RetrievalMetadata)\n- [1.0.0](/php/docs/reference/cloud-ai-platform/1.0.0/V1.RetrievalMetadata)\n- [0.39.0](/php/docs/reference/cloud-ai-platform/0.39.0/V1.RetrievalMetadata)\n- [0.38.0](/php/docs/reference/cloud-ai-platform/0.38.0/V1.RetrievalMetadata)\n- [0.37.1](/php/docs/reference/cloud-ai-platform/0.37.1/V1.RetrievalMetadata)\n- [0.32.0](/php/docs/reference/cloud-ai-platform/0.32.0/V1.RetrievalMetadata)\n- [0.31.0](/php/docs/reference/cloud-ai-platform/0.31.0/V1.RetrievalMetadata)\n- [0.30.0](/php/docs/reference/cloud-ai-platform/0.30.0/V1.RetrievalMetadata)\n- [0.29.0](/php/docs/reference/cloud-ai-platform/0.29.0/V1.RetrievalMetadata)\n- [0.28.0](/php/docs/reference/cloud-ai-platform/0.28.0/V1.RetrievalMetadata)\n- [0.27.0](/php/docs/reference/cloud-ai-platform/0.27.0/V1.RetrievalMetadata)\n- [0.26.2](/php/docs/reference/cloud-ai-platform/0.26.2/V1.RetrievalMetadata)\n- [0.25.0](/php/docs/reference/cloud-ai-platform/0.25.0/V1.RetrievalMetadata)\n- [0.24.0](/php/docs/reference/cloud-ai-platform/0.24.0/V1.RetrievalMetadata)\n- [0.23.0](/php/docs/reference/cloud-ai-platform/0.23.0/V1.RetrievalMetadata)\n- [0.22.0](/php/docs/reference/cloud-ai-platform/0.22.0/V1.RetrievalMetadata)\n- [0.21.0](/php/docs/reference/cloud-ai-platform/0.21.0/V1.RetrievalMetadata)\n- [0.20.0](/php/docs/reference/cloud-ai-platform/0.20.0/V1.RetrievalMetadata)\n- [0.19.0](/php/docs/reference/cloud-ai-platform/0.19.0/V1.RetrievalMetadata)\n- [0.18.0](/php/docs/reference/cloud-ai-platform/0.18.0/V1.RetrievalMetadata)\n- [0.17.0](/php/docs/reference/cloud-ai-platform/0.17.0/V1.RetrievalMetadata)\n- [0.16.0](/php/docs/reference/cloud-ai-platform/0.16.0/V1.RetrievalMetadata)\n- [0.15.0](/php/docs/reference/cloud-ai-platform/0.15.0/V1.RetrievalMetadata)\n- [0.13.0](/php/docs/reference/cloud-ai-platform/0.13.0/V1.RetrievalMetadata)\n- [0.12.0](/php/docs/reference/cloud-ai-platform/0.12.0/V1.RetrievalMetadata)\n- [0.11.1](/php/docs/reference/cloud-ai-platform/0.11.1/V1.RetrievalMetadata)\n- [0.10.0](/php/docs/reference/cloud-ai-platform/0.10.0/V1.RetrievalMetadata) \nReference documentation and code samples for the Google Cloud Ai Platform V1 Client class RetrievalMetadata.\n\nMetadata related to retrieval in the grounding flow.\n\nGenerated from protobuf message `google.cloud.aiplatform.v1.RetrievalMetadata`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ AIPlatform \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getGoogleSearchDynamicRetrievalScore\n\nOptional. Score indicating how likely information from Google Search could\nhelp answer the prompt. The score is in the range `[0, 1]`, where 0 is the\nleast likely and 1 is the most likely. This score is only populated when\nGoogle Search grounding and dynamic retrieval is enabled. It will be\ncompared to the threshold to determine whether to trigger Google Search.\n\n### setGoogleSearchDynamicRetrievalScore\n\nOptional. Score indicating how likely information from Google Search could\nhelp answer the prompt. The score is in the range `[0, 1]`, where 0 is the\nleast likely and 1 is the most likely. This score is only populated when\nGoogle Search grounding and dynamic retrieval is enabled. It will be\ncompared to the threshold to determine whether to trigger Google Search."]]
