Class RetrievalMetadata (3.77.0) 
  
  
  
   
  
    
  
  
    
    
    
    
  Version 3.77.0keyboard_arrow_down  
  
 
    
    
    
    
      
  
  
  
    
public   final   class  RetrievalMetadata   extends   GeneratedMessageV3   implements   RetrievalMetadataOrBuilder  
   Metadata related to retrieval in the grounding flow.
 Protobuf type google.cloud.aiplatform.v1beta1.RetrievalMetadata
    Inherited Members 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
      com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT) 
    
    
      com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int) 
    
    
    
    
    
    
    
    
      com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>) 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
      com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int) 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
   
  Static Fields
   
  
  
    
public   static   final   int   GOOGLE_SEARCH_DYNAMIC_RETRIEVAL_SCORE_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  Static Methods
   
  
    
public   static   RetrievalMetadata   getDefaultInstance ()  
  
  
    
public   static   final   Descriptors . Descriptor   getDescriptor ()  
  
  
    
public   static   RetrievalMetadata . Builder   newBuilder ()  
  
  
    
public   static   RetrievalMetadata . Builder   newBuilder ( RetrievalMetadata   prototype )  
  
  
  
    
public   static   RetrievalMetadata   parseDelimitedFrom ( InputStream   input )  
  
  
  
  
    
public   static   RetrievalMetadata   parseDelimitedFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  
    
public   static   RetrievalMetadata   parseFrom ( byte []   data )  
  
    
      
        Parameter  
      
        Name Description  
      
        databyte [] 
     
  
  
  
  
    
public   static   RetrievalMetadata   parseFrom ( byte []   data ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  
    
public   static   RetrievalMetadata   parseFrom ( ByteString   data )  
  
  
  
  
    
public   static   RetrievalMetadata   parseFrom ( ByteString   data ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  
    
public   static   RetrievalMetadata   parseFrom ( CodedInputStream   input )  
  
  
  
  
    
public   static   RetrievalMetadata   parseFrom ( CodedInputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  
    
public   static   RetrievalMetadata   parseFrom ( InputStream   input )  
  
  
  
  
    
public   static   RetrievalMetadata   parseFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  
    
public   static   RetrievalMetadata   parseFrom ( ByteBuffer   data )  
  
  
  
  
    
public   static   RetrievalMetadata   parseFrom ( ByteBuffer   data ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  
    
public   static   Parser<RetrievalMetadata>   parser ()  
  
  Methods
   
  
    
public   boolean   equals ( Object   obj )  
  
    
      
        Parameter  
      
        Name Description  
      
        objObject  
     
  
  
  Overrides 
  
  
    
public   RetrievalMetadata   getDefaultInstanceForType ()  
  
  
    
public   float   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.
 
 float google_search_dynamic_retrieval_score = 2 [(.google.api.field_behavior) = OPTIONAL];
 
    
      
        Returns  
      
        Type Description  
      
        float The googleSearchDynamicRetrievalScore.
 
     
  
  
    
public   Parser<RetrievalMetadata>   getParserForType ()  
  
  Overrides 
  
  
    
public   int   getSerializedSize ()  
  
    
      
        Returns  
      
        Type Description  
      
        int  
     
  
  Overrides 
  
  
    
      
        Returns  
      
        Type Description  
      
        int  
     
  
  Overrides 
  
  
    
protected   GeneratedMessageV3 . FieldAccessorTable   internalGetFieldAccessorTable ()  
  
  Overrides 
  
  
    
public   final   boolean   isInitialized ()  
  
  Overrides 
  
  
    
public   RetrievalMetadata . Builder   newBuilderForType ()  
  
  
    
protected   RetrievalMetadata . Builder   newBuilderForType ( GeneratedMessageV3 . BuilderParent   parent )  
  
  
  Overrides 
  
  
    
protected   Object   newInstance ( GeneratedMessageV3 . UnusedPrivateParameter   unused )  
  
  
    
      
        Returns  
      
        Type Description  
      
        Object  
     
  
  Overrides 
  
  
    
public   RetrievalMetadata . Builder   toBuilder ()  
  
  
    
public   void   writeTo ( CodedOutputStream   output )  
  
  Overrides 
  
  
 
     
    
  
  
  
     
  
    
    
      
       
    
    
  
  
 
  Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
  Last updated 2025-10-29 UTC.
 
 
  
  
  
    
      [[["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-10-29 UTC."],[],[]]