Google Cloud Ai Platform V1 Client - Class RetrievalMetadata (1.37.0)

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.

Parameter
Name Description
var float
Returns
Type Description
$this