com.google.cloud.vertexai.api

Class Retrieval.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<Retrieval.Builder>

com.google.cloud.vertexai.api.Retrieval.Builder

All Implemented Interfaces:

RetrievalOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

Retrieval

public static final class Retrieval.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Retrieval.Builder>
implements RetrievalOrBuilder

 Defines a retrieval tool that model can call to access external knowledge.
 

Protobuf type google.cloud.vertexai.v1.Retrieval

Method Summary

Modifier and Type	Method and Description
Retrieval.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Retrieval	build()
Retrieval	buildPartial()
Retrieval.Builder	clear()
Retrieval.Builder	clearDisableAttribution() Deprecated. google.cloud.vertexai.v1.Retrieval.disable_attribution is deprecated. See google/cloud/vertexai/v1/tool.proto;l=219
Retrieval.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
Retrieval.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
Retrieval.Builder	clearSource()
Retrieval.Builder	clearVertexAiSearch() Set to use data source powered by Vertex AI Search.
Retrieval.Builder	clearVertexRagStore() Set to use data source powered by Vertex RAG store.
Retrieval.Builder	clone()
Retrieval	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
boolean	getDisableAttribution() Deprecated. google.cloud.vertexai.v1.Retrieval.disable_attribution is deprecated. See google/cloud/vertexai/v1/tool.proto;l=219
Retrieval.SourceCase	getSourceCase()
VertexAISearch	getVertexAiSearch() Set to use data source powered by Vertex AI Search.
VertexAISearch.Builder	getVertexAiSearchBuilder() Set to use data source powered by Vertex AI Search.
VertexAISearchOrBuilder	getVertexAiSearchOrBuilder() Set to use data source powered by Vertex AI Search.
VertexRagStore	getVertexRagStore() Set to use data source powered by Vertex RAG store.
VertexRagStore.Builder	getVertexRagStoreBuilder() Set to use data source powered by Vertex RAG store.
VertexRagStoreOrBuilder	getVertexRagStoreOrBuilder() Set to use data source powered by Vertex RAG store.
boolean	hasVertexAiSearch() Set to use data source powered by Vertex AI Search.
boolean	hasVertexRagStore() Set to use data source powered by Vertex RAG store.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
Retrieval.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Retrieval.Builder	mergeFrom(com.google.protobuf.Message other)
Retrieval.Builder	mergeFrom(Retrieval other)
Retrieval.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
Retrieval.Builder	mergeVertexAiSearch(VertexAISearch value) Set to use data source powered by Vertex AI Search.
Retrieval.Builder	mergeVertexRagStore(VertexRagStore value) Set to use data source powered by Vertex RAG store.
Retrieval.Builder	setDisableAttribution(boolean value) Deprecated. google.cloud.vertexai.v1.Retrieval.disable_attribution is deprecated. See google/cloud/vertexai/v1/tool.proto;l=219
Retrieval.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Retrieval.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
Retrieval.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
Retrieval.Builder	setVertexAiSearch(VertexAISearch.Builder builderForValue) Set to use data source powered by Vertex AI Search.
Retrieval.Builder	setVertexAiSearch(VertexAISearch value) Set to use data source powered by Vertex AI Search.
Retrieval.Builder	setVertexRagStore(VertexRagStore.Builder builderForValue) Set to use data source powered by Vertex RAG store.
Retrieval.Builder	setVertexRagStore(VertexRagStore value) Set to use data source powered by Vertex RAG store.

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Retrieval.Builder>

clear

public Retrieval.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<Retrieval.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Retrieval.Builder>

getDefaultInstanceForType

public Retrieval getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public Retrieval build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public Retrieval buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public Retrieval.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<Retrieval.Builder>

setField

public Retrieval.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                  Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<Retrieval.Builder>

clearField

public Retrieval.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Retrieval.Builder>

clearOneof

public Retrieval.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Retrieval.Builder>

setRepeatedField

public Retrieval.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                          int index,
                                          Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Retrieval.Builder>

addRepeatedField

public Retrieval.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                          Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Retrieval.Builder>

mergeFrom

public Retrieval.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Retrieval.Builder>

mergeFrom

public Retrieval.Builder mergeFrom(Retrieval other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Retrieval.Builder>

mergeFrom

public Retrieval.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Retrieval.Builder>

Throws:

IOException

getSourceCase

public Retrieval.SourceCase getSourceCase()

Specified by:

getSourceCase in interface RetrievalOrBuilder

clearSource

public Retrieval.Builder clearSource()

hasVertexAiSearch

public boolean hasVertexAiSearch()

 Set to use data source powered by Vertex AI Search.
 

.google.cloud.vertexai.v1.VertexAISearch vertex_ai_search = 2;

Specified by:

hasVertexAiSearch in interface RetrievalOrBuilder

Returns:

Whether the vertexAiSearch field is set.

getVertexAiSearch

public VertexAISearch getVertexAiSearch()

 Set to use data source powered by Vertex AI Search.
 

.google.cloud.vertexai.v1.VertexAISearch vertex_ai_search = 2;

Specified by:

getVertexAiSearch in interface RetrievalOrBuilder

Returns:

The vertexAiSearch.

setVertexAiSearch

public Retrieval.Builder setVertexAiSearch(VertexAISearch value)

 Set to use data source powered by Vertex AI Search.
 

.google.cloud.vertexai.v1.VertexAISearch vertex_ai_search = 2;

setVertexAiSearch

public Retrieval.Builder setVertexAiSearch(VertexAISearch.Builder builderForValue)

 Set to use data source powered by Vertex AI Search.
 

.google.cloud.vertexai.v1.VertexAISearch vertex_ai_search = 2;

mergeVertexAiSearch

public Retrieval.Builder mergeVertexAiSearch(VertexAISearch value)

 Set to use data source powered by Vertex AI Search.
 

.google.cloud.vertexai.v1.VertexAISearch vertex_ai_search = 2;

clearVertexAiSearch

public Retrieval.Builder clearVertexAiSearch()

 Set to use data source powered by Vertex AI Search.
 

.google.cloud.vertexai.v1.VertexAISearch vertex_ai_search = 2;

getVertexAiSearchBuilder

public VertexAISearch.Builder getVertexAiSearchBuilder()

 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;

Specified by:

getVertexAiSearchOrBuilder in interface RetrievalOrBuilder

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;

Specified by:

hasVertexRagStore in interface RetrievalOrBuilder

Returns:

Whether the vertexRagStore field is set.

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;

Specified by:

getVertexRagStore in interface RetrievalOrBuilder

Returns:

The vertexRagStore.

setVertexRagStore

public Retrieval.Builder setVertexRagStore(VertexRagStore value)

 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;

setVertexRagStore

public Retrieval.Builder setVertexRagStore(VertexRagStore.Builder builderForValue)

 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;

mergeVertexRagStore

public Retrieval.Builder mergeVertexRagStore(VertexRagStore value)

 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;

clearVertexRagStore

public Retrieval.Builder clearVertexRagStore()

 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;

getVertexRagStoreBuilder

public VertexRagStore.Builder getVertexRagStoreBuilder()

 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;

Specified by:

getVertexRagStoreOrBuilder in interface RetrievalOrBuilder

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];

Specified by:

getDisableAttribution in interface RetrievalOrBuilder

Returns:

The disableAttribution.

setDisableAttribution

@Deprecated
public Retrieval.Builder setDisableAttribution(boolean value)

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];

Parameters:

value - The disableAttribution to set.

Returns:

This builder for chaining.

clearDisableAttribution

@Deprecated
public Retrieval.Builder clearDisableAttribution()

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:

This builder for chaining.

setUnknownFields

public final Retrieval.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Retrieval.Builder>

mergeUnknownFields

public final Retrieval.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Retrieval.Builder>