Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::RetrievalMetadata (v0.59.0)

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::RetrievalMetadata.

Metadata related to retrieval in the grounding flow.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#google_search_dynamic_retrieval_score

def google_search_dynamic_retrieval_score() -> ::Float
Returns
  • (::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.

#google_search_dynamic_retrieval_score=

def google_search_dynamic_retrieval_score=(value) -> ::Float
Parameter
  • value (::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.
Returns
  • (::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.