- 3.52.0 (latest)
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.2
- 3.3.0
- 3.2.0
- 3.0.0
- 2.9.8
- 2.8.9
- 2.7.4
- 2.5.3
- 2.4.0
public final class Retrieval extends GeneratedMessageV3 implements RetrievalOrBuilder
Defines a retrieval tool that model can call to access external knowledge.
Protobuf type google.cloud.aiplatform.v1beta1.Retrieval
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > RetrievalImplements
RetrievalOrBuilderStatic 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()
Returns | |
---|---|
Type | Description |
Retrieval |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
newBuilder()
public static Retrieval.Builder newBuilder()
Returns | |
---|---|
Type | Description |
Retrieval.Builder |
newBuilder(Retrieval prototype)
public static Retrieval.Builder newBuilder(Retrieval prototype)
Parameter | |
---|---|
Name | Description |
prototype |
Retrieval |
Returns | |
---|---|
Type | Description |
Retrieval.Builder |
parseDelimitedFrom(InputStream input)
public static Retrieval parseDelimitedFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
Retrieval |
Exceptions | |
---|---|
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Retrieval parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Retrieval |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(byte[] data)
public static Retrieval parseFrom(byte[] data)
Parameter | |
---|---|
Name | Description |
data |
byte[] |
Returns | |
---|---|
Type | Description |
Retrieval |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Retrieval parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Retrieval |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static Retrieval parseFrom(ByteString data)
Parameter | |
---|---|
Name | Description |
data |
ByteString |
Returns | |
---|---|
Type | Description |
Retrieval |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Retrieval parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Retrieval |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static Retrieval parseFrom(CodedInputStream input)
Parameter | |
---|---|
Name | Description |
input |
CodedInputStream |
Returns | |
---|---|
Type | Description |
Retrieval |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Retrieval parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Retrieval |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input)
public static Retrieval parseFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
Retrieval |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Retrieval parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Retrieval |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static Retrieval parseFrom(ByteBuffer data)
Parameter | |
---|---|
Name | Description |
data |
ByteBuffer |
Returns | |
---|---|
Type | Description |
Retrieval |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Retrieval parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Retrieval |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<Retrieval> parser()
Returns | |
---|---|
Type | Description |
Parser<Retrieval> |
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter | |
---|---|
Name | Description |
obj |
Object |
Returns | |
---|---|
Type | Description |
boolean |
getDefaultInstanceForType()
public Retrieval getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
Retrieval |
getDisableAttribution() (deprecated)
public boolean getDisableAttribution()
Deprecated. google.cloud.aiplatform.v1beta1.Retrieval.disable_attribution is deprecated. See google/cloud/aiplatform/v1beta1/tool.proto;l=177
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()
Returns | |
---|---|
Type | Description |
Parser<Retrieval> |
getSerializedSize()
public int getSerializedSize()
Returns | |
---|---|
Type | Description |
int |
getSourceCase()
public Retrieval.SourceCase getSourceCase()
Returns | |
---|---|
Type | Description |
Retrieval.SourceCase |
getVertexAiSearch()
public VertexAISearch getVertexAiSearch()
Set to use data source powered by Vertex AI Search.
.google.cloud.aiplatform.v1beta1.VertexAISearch vertex_ai_search = 2;
Returns | |
---|---|
Type | Description |
VertexAISearch |
The vertexAiSearch. |
getVertexAiSearchOrBuilder()
public VertexAISearchOrBuilder getVertexAiSearchOrBuilder()
Set to use data source powered by Vertex AI Search.
.google.cloud.aiplatform.v1beta1.VertexAISearch vertex_ai_search = 2;
Returns | |
---|---|
Type | Description |
VertexAISearchOrBuilder |
getVertexRagStore()
public VertexRagStore getVertexRagStore()
Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
.google.cloud.aiplatform.v1beta1.VertexRagStore vertex_rag_store = 4;
Returns | |
---|---|
Type | Description |
VertexRagStore |
The vertexRagStore. |
getVertexRagStoreOrBuilder()
public VertexRagStoreOrBuilder getVertexRagStoreOrBuilder()
Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
.google.cloud.aiplatform.v1beta1.VertexRagStore vertex_rag_store = 4;
Returns | |
---|---|
Type | Description |
VertexRagStoreOrBuilder |
hasVertexAiSearch()
public boolean hasVertexAiSearch()
Set to use data source powered by Vertex AI Search.
.google.cloud.aiplatform.v1beta1.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.aiplatform.v1beta1.VertexRagStore vertex_rag_store = 4;
Returns | |
---|---|
Type | Description |
boolean |
Whether the vertexRagStore field is set. |
hashCode()
public int hashCode()
Returns | |
---|---|
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
newBuilderForType()
public Retrieval.Builder newBuilderForType()
Returns | |
---|---|
Type | Description |
Retrieval.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Retrieval.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter | |
---|---|
Name | Description |
parent |
BuilderParent |
Returns | |
---|---|
Type | Description |
Retrieval.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter | |
---|---|
Name | Description |
unused |
UnusedPrivateParameter |
Returns | |
---|---|
Type | Description |
Object |
toBuilder()
public Retrieval.Builder toBuilder()
Returns | |
---|---|
Type | Description |
Retrieval.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter | |
---|---|
Name | Description |
output |
CodedOutputStream |
Exceptions | |
---|---|
Type | Description |
IOException |