Class Retrieval.Builder (1.6.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.vertexai.v1.Retrieval

Implements

RetrievalOrBuilder

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

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

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

clearOneof(Descriptors.OneofDescriptor oneof)

public Retrieval.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Retrieval.Builder
Overrides

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

Returns
Type Description
Retrieval.Builder

clone()

public Retrieval.Builder clone()
Returns
Type Description
Retrieval.Builder
Overrides

getDefaultInstanceForType()

public Retrieval getDefaultInstanceForType()
Returns
Type Description
Retrieval

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.vertexai.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.vertexai.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.vertexai.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.vertexai.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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Retrieval.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Retrieval.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Retrieval.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Retrieval.Builder
Overrides

mergeVertexAiSearch(VertexAISearch value)

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;

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

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

setUnknownFields(UnknownFieldSet unknownFields)

public final Retrieval.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Retrieval.Builder
Overrides

setVertexAiSearch(VertexAISearch value)

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;

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

Parameter
Name Description
builderForValue VertexAISearch.Builder
Returns
Type Description
Retrieval.Builder