Class Retrieval.Builder (3.42.0)

Version 3.42.0

• 3.56.0 (latest)
• 3.55.0
• 3.54.0
• 3.53.0
• 3.52.0
• 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 static final class Retrieval.Builder extends GeneratedMessageV3.Builder<Retrieval.Builder> implements RetrievalOrBuilder

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

Protobuf type google.cloud.aiplatform.v1.Retrieval

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Retrieval.Builder

Implements

RetrievalOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Retrieval.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public Retrieval build()

Returns
Type	Description
Retrieval

buildPartial()

public Retrieval buildPartial()

Returns
Type	Description
Retrieval

clear()

public Retrieval.Builder clear()

Returns
Type	Description
Retrieval.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearDisableAttribution()

public Retrieval.Builder clearDisableAttribution()

Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation.

bool disable_attribution = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Retrieval.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Retrieval.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
Retrieval.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public Retrieval.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
Retrieval.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearSource()

public Retrieval.Builder clearSource()

Returns
Type	Description
Retrieval.Builder

clearVertexAiSearch()

public Retrieval.Builder clearVertexAiSearch()

Set to use data source powered by Vertex AI Search.

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

Returns
Type	Description
Retrieval.Builder

clone()

public Retrieval.Builder clone()

Returns
Type	Description
Retrieval.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public Retrieval getDefaultInstanceForType()

Returns
Type	Description
Retrieval

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDisableAttribution()

public boolean getDisableAttribution()

Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation.

bool disable_attribution = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The disableAttribution.

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.v1.VertexAISearch vertex_ai_search = 2;

Returns
Type	Description
VertexAISearch	The vertexAiSearch.

getVertexAiSearchBuilder()

public VertexAISearch.Builder getVertexAiSearchBuilder()

Set to use data source powered by Vertex AI Search.

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

Returns
Type	Description
VertexAISearch.Builder

getVertexAiSearchOrBuilder()

public VertexAISearchOrBuilder getVertexAiSearchOrBuilder()

Set to use data source powered by Vertex AI Search.

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

Returns
Type	Description
VertexAISearchOrBuilder

hasVertexAiSearch()

public boolean hasVertexAiSearch()

Set to use data source powered by Vertex AI Search.

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

Returns
Type	Description
boolean	Whether the vertexAiSearch field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(Retrieval other)

public Retrieval.Builder mergeFrom(Retrieval other)

Parameter
Name	Description
other	Retrieval

Returns
Type	Description
Retrieval.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Retrieval.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Retrieval.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public Retrieval.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
Retrieval.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Retrieval.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Retrieval.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

mergeVertexAiSearch(VertexAISearch value)

public Retrieval.Builder mergeVertexAiSearch(VertexAISearch value)

Set to use data source powered by Vertex AI Search.

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

Parameter
Name	Description
value	VertexAISearch

Returns
Type	Description
Retrieval.Builder

setDisableAttribution(boolean value)

public Retrieval.Builder setDisableAttribution(boolean value)

Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation.

bool disable_attribution = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	boolean The disableAttribution to set.

Returns
Type	Description
Retrieval.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Retrieval.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
Retrieval.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final Retrieval.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Retrieval.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setVertexAiSearch(VertexAISearch value)

public Retrieval.Builder setVertexAiSearch(VertexAISearch value)

Set to use data source powered by Vertex AI Search.

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

Parameter
Name	Description
value	VertexAISearch

Returns
Type	Description
Retrieval.Builder

setVertexAiSearch(VertexAISearch.Builder builderForValue)

public Retrieval.Builder setVertexAiSearch(VertexAISearch.Builder builderForValue)

Set to use data source powered by Vertex AI Search.

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

Parameter
Name	Description
builderForValue	VertexAISearch.Builder

Returns
Type	Description
Retrieval.Builder