Starting April 29, 2025, Gemini 1.5 Pro and Gemini 1.5 Flash models are not available in projects that have no prior usage of these models, including new projects. For details, see
Model versions and lifecycle .
Send feedback Class Retrieval (1.22.0) Stay organized with collections Save and categorize content based on your preferences.
public final class Retrieval extends GeneratedMessageV3 implements RetrievalOrBuilder Defines a retrieval tool that model can call to access external knowledge.
Protobuf type google.cloud.vertexai.v1.Retrieval
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 DISABLE_ATTRIBUTION_FIELD_NUMBER
public static final int DISABLE_ATTRIBUTION_FIELD_NUMBER Field Value Type Description int
VERTEX_AI_SEARCH_FIELD_NUMBER
public static final int VERTEX_AI_SEARCH_FIELD_NUMBER Field Value Type Description int
VERTEX_RAG_STORE_FIELD_NUMBER
public static final int VERTEX_RAG_STORE_FIELD_NUMBER Field Value Type Description int
Static Methods getDefaultInstance()
public static Retrieval getDefaultInstance () getDescriptor()
public static final Descriptors . Descriptor getDescriptor () newBuilder()
public static Retrieval . Builder newBuilder () newBuilder(Retrieval )
public static Retrieval . Builder newBuilder ( Retrieval )
public static Retrieval parseDelimitedFrom ( InputStream input )
public static Retrieval parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry ) parseFrom(byte[] data)
public static Retrieval parseFrom ( byte [] data ) Parameter Name Description databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Retrieval parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry ) parseFrom(ByteString data)
public static Retrieval parseFrom ( ByteString data ) parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Retrieval parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static Retrieval parseFrom ( CodedInputStream input )
public static Retrieval parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static Retrieval parseFrom ( InputStream input )
public static Retrieval parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry ) parseFrom(ByteBuffer data)
public static Retrieval parseFrom ( ByteBuffer data ) parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Retrieval parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry ) parser()
public static Parser<Retrieval> parser () Methods equals(Object obj)
public boolean equals ( Object obj ) Parameter Name Description objObject
Overrides getDefaultInstanceForType()
public Retrieval getDefaultInstanceForType () getDisableAttribution() (deprecated)
public boolean getDisableAttribution () Deprecated. google.cloud.vertexai.v1.Retrieval.disable_attribution is deprecated. See google/cloud/vertexai/v1/tool.proto;l=219
Optional. Deprecated. This option is no longer supported.
bool disable_attribution = 3 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
Returns Type Description boolean The disableAttribution.
getParserForType()
public Parser<Retrieval> getParserForType () Overrides getSerializedSize()
public int getSerializedSize () Returns Type Description int
Overrides getSourceCase()
public Retrieval . SourceCase getSourceCase () getVertexAiSearch()
public VertexAISearch getVertexAiSearch () Set to use data source powered by Vertex AI Search.
.google.cloud.vertexai.v1.VertexAISearch vertex_ai_search = 2;
getVertexAiSearchOrBuilder()
public VertexAISearchOrBuilder getVertexAiSearchOrBuilder () Set to use data source powered by Vertex AI Search.
.google.cloud.vertexai.v1.VertexAISearch vertex_ai_search = 2;
getVertexRagStore()
public VertexRagStore getVertexRagStore () Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
.google.cloud.vertexai.v1.VertexRagStore vertex_rag_store = 4;
getVertexRagStoreOrBuilder()
public VertexRagStoreOrBuilder getVertexRagStoreOrBuilder () Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
.google.cloud.vertexai.v1.VertexRagStore vertex_rag_store = 4;
hasVertexAiSearch()
public boolean hasVertexAiSearch () Set to use data source powered by Vertex AI Search.
.google.cloud.vertexai.v1.VertexAISearch vertex_ai_search = 2;
Returns Type Description boolean Whether the vertexAiSearch field is set.
hasVertexRagStore()
public boolean hasVertexRagStore () Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
.google.cloud.vertexai.v1.VertexRagStore vertex_rag_store = 4;
Returns Type Description boolean Whether the vertexRagStore field is set.
hashCode() Returns Type Description int
Overrides internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable () Overrides isInitialized()
public final boolean isInitialized () Overrides newBuilderForType()
public Retrieval . Builder newBuilderForType () newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Retrieval . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent ) Overrides newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused ) Overrides toBuilder()
public Retrieval . Builder toBuilder () writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output ) Overrides Send feedback
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-05-14 UTC.
Need to tell us more? [[["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-05-14 UTC."],[],[]]
