com.google.cloud.aiplatform.v1

Class Tool.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

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

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

com.google.cloud.aiplatform.v1.Tool.Builder

All Implemented Interfaces:

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

Enclosing class:

Tool

public static final class Tool.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Tool.Builder>
implements ToolOrBuilder

 Tool details that the model may use to generate response.

 A `Tool` is a piece of code that enables the system to interact with
 external systems to perform an action, or set of actions, outside of
 knowledge and scope of the model. A Tool object should contain exactly
 one type of Tool (e.g FunctionDeclaration, Retrieval or
 GoogleSearchRetrieval).
 

Protobuf type google.cloud.aiplatform.v1.Tool

Method Summary

Modifier and Type	Method and Description
Tool.Builder	addAllFunctionDeclarations(Iterable<? extends FunctionDeclaration> values) Optional.
Tool.Builder	addFunctionDeclarations(FunctionDeclaration.Builder builderForValue) Optional.
Tool.Builder	addFunctionDeclarations(FunctionDeclaration value) Optional.
Tool.Builder	addFunctionDeclarations(int index, FunctionDeclaration.Builder builderForValue) Optional.
Tool.Builder	addFunctionDeclarations(int index, FunctionDeclaration value) Optional.
FunctionDeclaration.Builder	addFunctionDeclarationsBuilder() Optional.
FunctionDeclaration.Builder	addFunctionDeclarationsBuilder(int index) Optional.
Tool.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Tool	build()
Tool	buildPartial()
Tool.Builder	clear()
Tool.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
Tool.Builder	clearFunctionDeclarations() Optional.
Tool.Builder	clearGoogleSearchRetrieval() Optional.
Tool.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
Tool.Builder	clearRetrieval() Optional.
Tool.Builder	clone()
Tool	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
FunctionDeclaration	getFunctionDeclarations(int index) Optional.
FunctionDeclaration.Builder	getFunctionDeclarationsBuilder(int index) Optional.
List<FunctionDeclaration.Builder>	getFunctionDeclarationsBuilderList() Optional.
int	getFunctionDeclarationsCount() Optional.
List<FunctionDeclaration>	getFunctionDeclarationsList() Optional.
FunctionDeclarationOrBuilder	getFunctionDeclarationsOrBuilder(int index) Optional.
List<? extends FunctionDeclarationOrBuilder>	getFunctionDeclarationsOrBuilderList() Optional.
GoogleSearchRetrieval	getGoogleSearchRetrieval() Optional.
GoogleSearchRetrieval.Builder	getGoogleSearchRetrievalBuilder() Optional.
GoogleSearchRetrievalOrBuilder	getGoogleSearchRetrievalOrBuilder() Optional.
Retrieval	getRetrieval() Optional.
Retrieval.Builder	getRetrievalBuilder() Optional.
RetrievalOrBuilder	getRetrievalOrBuilder() Optional.
boolean	hasGoogleSearchRetrieval() Optional.
boolean	hasRetrieval() Optional.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
Tool.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Tool.Builder	mergeFrom(com.google.protobuf.Message other)
Tool.Builder	mergeFrom(Tool other)
Tool.Builder	mergeGoogleSearchRetrieval(GoogleSearchRetrieval value) Optional.
Tool.Builder	mergeRetrieval(Retrieval value) Optional.
Tool.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
Tool.Builder	removeFunctionDeclarations(int index) Optional.
Tool.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Tool.Builder	setFunctionDeclarations(int index, FunctionDeclaration.Builder builderForValue) Optional.
Tool.Builder	setFunctionDeclarations(int index, FunctionDeclaration value) Optional.
Tool.Builder	setGoogleSearchRetrieval(GoogleSearchRetrieval.Builder builderForValue) Optional.
Tool.Builder	setGoogleSearchRetrieval(GoogleSearchRetrieval value) Optional.
Tool.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
Tool.Builder	setRetrieval(Retrieval.Builder builderForValue) Optional.
Tool.Builder	setRetrieval(Retrieval value) Optional.
Tool.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

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<Tool.Builder>

clear

public Tool.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<Tool.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<Tool.Builder>

getDefaultInstanceForType

public Tool getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public Tool build()

Specified by:

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

Specified by:

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

buildPartial

public Tool buildPartial()

Specified by:

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

Specified by:

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

clone

public Tool.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<Tool.Builder>

setField

public Tool.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<Tool.Builder>

clearField

public Tool.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<Tool.Builder>

clearOneof

public Tool.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<Tool.Builder>

setRepeatedField

public Tool.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<Tool.Builder>

addRepeatedField

public Tool.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<Tool.Builder>

mergeFrom

public Tool.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<Tool.Builder>

mergeFrom

public Tool.Builder mergeFrom(Tool other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

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

mergeFrom

public Tool.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<Tool.Builder>

Throws:

IOException

getFunctionDeclarationsList

public List<FunctionDeclaration> getFunctionDeclarationsList()

 Optional. Function tool type.
 One or more function declarations to be passed to the model along with the
 current user query. Model may decide to call a subset of these functions
 by populating [FunctionCall][content.part.function_call] in the response.
 User should provide a [FunctionResponse][content.part.function_response]
 for each function call in the next turn. Based on the function responses,
 Model will generate the final response back to the user.
 Maximum 64 function declarations can be provided.
 

repeated .google.cloud.aiplatform.v1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getFunctionDeclarationsList in interface ToolOrBuilder

getFunctionDeclarationsCount

public int getFunctionDeclarationsCount()

 Optional. Function tool type.
 One or more function declarations to be passed to the model along with the
 current user query. Model may decide to call a subset of these functions
 by populating [FunctionCall][content.part.function_call] in the response.
 User should provide a [FunctionResponse][content.part.function_response]
 for each function call in the next turn. Based on the function responses,
 Model will generate the final response back to the user.
 Maximum 64 function declarations can be provided.
 

repeated .google.cloud.aiplatform.v1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getFunctionDeclarationsCount in interface ToolOrBuilder

getFunctionDeclarations

public FunctionDeclaration getFunctionDeclarations(int index)

 Optional. Function tool type.
 One or more function declarations to be passed to the model along with the
 current user query. Model may decide to call a subset of these functions
 by populating [FunctionCall][content.part.function_call] in the response.
 User should provide a [FunctionResponse][content.part.function_response]
 for each function call in the next turn. Based on the function responses,
 Model will generate the final response back to the user.
 Maximum 64 function declarations can be provided.
 

repeated .google.cloud.aiplatform.v1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getFunctionDeclarations in interface ToolOrBuilder

setFunctionDeclarations

public Tool.Builder setFunctionDeclarations(int index,
                                            FunctionDeclaration value)

 Optional. Function tool type.
 One or more function declarations to be passed to the model along with the
 current user query. Model may decide to call a subset of these functions
 by populating [FunctionCall][content.part.function_call] in the response.
 User should provide a [FunctionResponse][content.part.function_response]
 for each function call in the next turn. Based on the function responses,
 Model will generate the final response back to the user.
 Maximum 64 function declarations can be provided.
 

repeated .google.cloud.aiplatform.v1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL];

setFunctionDeclarations

public Tool.Builder setFunctionDeclarations(int index,
                                            FunctionDeclaration.Builder builderForValue)

 Optional. Function tool type.
 One or more function declarations to be passed to the model along with the
 current user query. Model may decide to call a subset of these functions
 by populating [FunctionCall][content.part.function_call] in the response.
 User should provide a [FunctionResponse][content.part.function_response]
 for each function call in the next turn. Based on the function responses,
 Model will generate the final response back to the user.
 Maximum 64 function declarations can be provided.
 

repeated .google.cloud.aiplatform.v1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL];

addFunctionDeclarations

public Tool.Builder addFunctionDeclarations(FunctionDeclaration value)

 Optional. Function tool type.
 One or more function declarations to be passed to the model along with the
 current user query. Model may decide to call a subset of these functions
 by populating [FunctionCall][content.part.function_call] in the response.
 User should provide a [FunctionResponse][content.part.function_response]
 for each function call in the next turn. Based on the function responses,
 Model will generate the final response back to the user.
 Maximum 64 function declarations can be provided.
 

repeated .google.cloud.aiplatform.v1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL];

addFunctionDeclarations

public Tool.Builder addFunctionDeclarations(int index,
                                            FunctionDeclaration value)

 Optional. Function tool type.
 One or more function declarations to be passed to the model along with the
 current user query. Model may decide to call a subset of these functions
 by populating [FunctionCall][content.part.function_call] in the response.
 User should provide a [FunctionResponse][content.part.function_response]
 for each function call in the next turn. Based on the function responses,
 Model will generate the final response back to the user.
 Maximum 64 function declarations can be provided.
 

repeated .google.cloud.aiplatform.v1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL];

addFunctionDeclarations

public Tool.Builder addFunctionDeclarations(FunctionDeclaration.Builder builderForValue)

 Optional. Function tool type.
 One or more function declarations to be passed to the model along with the
 current user query. Model may decide to call a subset of these functions
 by populating [FunctionCall][content.part.function_call] in the response.
 User should provide a [FunctionResponse][content.part.function_response]
 for each function call in the next turn. Based on the function responses,
 Model will generate the final response back to the user.
 Maximum 64 function declarations can be provided.
 

repeated .google.cloud.aiplatform.v1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL];

addFunctionDeclarations

public Tool.Builder addFunctionDeclarations(int index,
                                            FunctionDeclaration.Builder builderForValue)

 Optional. Function tool type.
 One or more function declarations to be passed to the model along with the
 current user query. Model may decide to call a subset of these functions
 by populating [FunctionCall][content.part.function_call] in the response.
 User should provide a [FunctionResponse][content.part.function_response]
 for each function call in the next turn. Based on the function responses,
 Model will generate the final response back to the user.
 Maximum 64 function declarations can be provided.
 

repeated .google.cloud.aiplatform.v1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL];

addAllFunctionDeclarations

public Tool.Builder addAllFunctionDeclarations(Iterable<? extends FunctionDeclaration> values)

 Optional. Function tool type.
 One or more function declarations to be passed to the model along with the
 current user query. Model may decide to call a subset of these functions
 by populating [FunctionCall][content.part.function_call] in the response.
 User should provide a [FunctionResponse][content.part.function_response]
 for each function call in the next turn. Based on the function responses,
 Model will generate the final response back to the user.
 Maximum 64 function declarations can be provided.
 

repeated .google.cloud.aiplatform.v1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL];

clearFunctionDeclarations

public Tool.Builder clearFunctionDeclarations()

 Optional. Function tool type.
 One or more function declarations to be passed to the model along with the
 current user query. Model may decide to call a subset of these functions
 by populating [FunctionCall][content.part.function_call] in the response.
 User should provide a [FunctionResponse][content.part.function_response]
 for each function call in the next turn. Based on the function responses,
 Model will generate the final response back to the user.
 Maximum 64 function declarations can be provided.
 

repeated .google.cloud.aiplatform.v1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL];

removeFunctionDeclarations

public Tool.Builder removeFunctionDeclarations(int index)

 Optional. Function tool type.
 One or more function declarations to be passed to the model along with the
 current user query. Model may decide to call a subset of these functions
 by populating [FunctionCall][content.part.function_call] in the response.
 User should provide a [FunctionResponse][content.part.function_response]
 for each function call in the next turn. Based on the function responses,
 Model will generate the final response back to the user.
 Maximum 64 function declarations can be provided.
 

repeated .google.cloud.aiplatform.v1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL];

getFunctionDeclarationsBuilder

public FunctionDeclaration.Builder getFunctionDeclarationsBuilder(int index)

 Optional. Function tool type.
 One or more function declarations to be passed to the model along with the
 current user query. Model may decide to call a subset of these functions
 by populating [FunctionCall][content.part.function_call] in the response.
 User should provide a [FunctionResponse][content.part.function_response]
 for each function call in the next turn. Based on the function responses,
 Model will generate the final response back to the user.
 Maximum 64 function declarations can be provided.
 

repeated .google.cloud.aiplatform.v1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL];

getFunctionDeclarationsOrBuilder

public FunctionDeclarationOrBuilder getFunctionDeclarationsOrBuilder(int index)

 Optional. Function tool type.
 One or more function declarations to be passed to the model along with the
 current user query. Model may decide to call a subset of these functions
 by populating [FunctionCall][content.part.function_call] in the response.
 User should provide a [FunctionResponse][content.part.function_response]
 for each function call in the next turn. Based on the function responses,
 Model will generate the final response back to the user.
 Maximum 64 function declarations can be provided.
 

repeated .google.cloud.aiplatform.v1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getFunctionDeclarationsOrBuilder in interface ToolOrBuilder

getFunctionDeclarationsOrBuilderList

public List<? extends FunctionDeclarationOrBuilder> getFunctionDeclarationsOrBuilderList()

 Optional. Function tool type.
 One or more function declarations to be passed to the model along with the
 current user query. Model may decide to call a subset of these functions
 by populating [FunctionCall][content.part.function_call] in the response.
 User should provide a [FunctionResponse][content.part.function_response]
 for each function call in the next turn. Based on the function responses,
 Model will generate the final response back to the user.
 Maximum 64 function declarations can be provided.
 

repeated .google.cloud.aiplatform.v1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getFunctionDeclarationsOrBuilderList in interface ToolOrBuilder

addFunctionDeclarationsBuilder

public FunctionDeclaration.Builder addFunctionDeclarationsBuilder()

 Optional. Function tool type.
 One or more function declarations to be passed to the model along with the
 current user query. Model may decide to call a subset of these functions
 by populating [FunctionCall][content.part.function_call] in the response.
 User should provide a [FunctionResponse][content.part.function_response]
 for each function call in the next turn. Based on the function responses,
 Model will generate the final response back to the user.
 Maximum 64 function declarations can be provided.
 

repeated .google.cloud.aiplatform.v1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL];

addFunctionDeclarationsBuilder

public FunctionDeclaration.Builder addFunctionDeclarationsBuilder(int index)

 Optional. Function tool type.
 One or more function declarations to be passed to the model along with the
 current user query. Model may decide to call a subset of these functions
 by populating [FunctionCall][content.part.function_call] in the response.
 User should provide a [FunctionResponse][content.part.function_response]
 for each function call in the next turn. Based on the function responses,
 Model will generate the final response back to the user.
 Maximum 64 function declarations can be provided.
 

repeated .google.cloud.aiplatform.v1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL];

getFunctionDeclarationsBuilderList

public List<FunctionDeclaration.Builder> getFunctionDeclarationsBuilderList()

 Optional. Function tool type.
 One or more function declarations to be passed to the model along with the
 current user query. Model may decide to call a subset of these functions
 by populating [FunctionCall][content.part.function_call] in the response.
 User should provide a [FunctionResponse][content.part.function_response]
 for each function call in the next turn. Based on the function responses,
 Model will generate the final response back to the user.
 Maximum 64 function declarations can be provided.
 

repeated .google.cloud.aiplatform.v1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL];

hasRetrieval

public boolean hasRetrieval()

 Optional. Retrieval tool type.
 System will always execute the provided retrieval tool(s) to get external
 knowledge to answer the prompt. Retrieval results are presented to the
 model for generation.
 

.google.cloud.aiplatform.v1.Retrieval retrieval = 2 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasRetrieval in interface ToolOrBuilder

Returns:

Whether the retrieval field is set.

getRetrieval

public Retrieval getRetrieval()

 Optional. Retrieval tool type.
 System will always execute the provided retrieval tool(s) to get external
 knowledge to answer the prompt. Retrieval results are presented to the
 model for generation.
 

.google.cloud.aiplatform.v1.Retrieval retrieval = 2 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getRetrieval in interface ToolOrBuilder

Returns:

The retrieval.

setRetrieval

public Tool.Builder setRetrieval(Retrieval value)

 Optional. Retrieval tool type.
 System will always execute the provided retrieval tool(s) to get external
 knowledge to answer the prompt. Retrieval results are presented to the
 model for generation.
 

.google.cloud.aiplatform.v1.Retrieval retrieval = 2 [(.google.api.field_behavior) = OPTIONAL];

setRetrieval

public Tool.Builder setRetrieval(Retrieval.Builder builderForValue)

 Optional. Retrieval tool type.
 System will always execute the provided retrieval tool(s) to get external
 knowledge to answer the prompt. Retrieval results are presented to the
 model for generation.
 

.google.cloud.aiplatform.v1.Retrieval retrieval = 2 [(.google.api.field_behavior) = OPTIONAL];

mergeRetrieval

public Tool.Builder mergeRetrieval(Retrieval value)

 Optional. Retrieval tool type.
 System will always execute the provided retrieval tool(s) to get external
 knowledge to answer the prompt. Retrieval results are presented to the
 model for generation.
 

.google.cloud.aiplatform.v1.Retrieval retrieval = 2 [(.google.api.field_behavior) = OPTIONAL];

clearRetrieval

public Tool.Builder clearRetrieval()

 Optional. Retrieval tool type.
 System will always execute the provided retrieval tool(s) to get external
 knowledge to answer the prompt. Retrieval results are presented to the
 model for generation.
 

.google.cloud.aiplatform.v1.Retrieval retrieval = 2 [(.google.api.field_behavior) = OPTIONAL];

getRetrievalBuilder

public Retrieval.Builder getRetrievalBuilder()

 Optional. Retrieval tool type.
 System will always execute the provided retrieval tool(s) to get external
 knowledge to answer the prompt. Retrieval results are presented to the
 model for generation.
 

.google.cloud.aiplatform.v1.Retrieval retrieval = 2 [(.google.api.field_behavior) = OPTIONAL];

getRetrievalOrBuilder

public RetrievalOrBuilder getRetrievalOrBuilder()

 Optional. Retrieval tool type.
 System will always execute the provided retrieval tool(s) to get external
 knowledge to answer the prompt. Retrieval results are presented to the
 model for generation.
 

.google.cloud.aiplatform.v1.Retrieval retrieval = 2 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getRetrievalOrBuilder in interface ToolOrBuilder

hasGoogleSearchRetrieval

public boolean hasGoogleSearchRetrieval()

 Optional. GoogleSearchRetrieval tool type.
 Specialized retrieval tool that is powered by Google search.
 

.google.cloud.aiplatform.v1.GoogleSearchRetrieval google_search_retrieval = 3 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasGoogleSearchRetrieval in interface ToolOrBuilder

Returns:

Whether the googleSearchRetrieval field is set.

getGoogleSearchRetrieval

public GoogleSearchRetrieval getGoogleSearchRetrieval()

 Optional. GoogleSearchRetrieval tool type.
 Specialized retrieval tool that is powered by Google search.
 

.google.cloud.aiplatform.v1.GoogleSearchRetrieval google_search_retrieval = 3 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getGoogleSearchRetrieval in interface ToolOrBuilder

Returns:

The googleSearchRetrieval.

setGoogleSearchRetrieval

public Tool.Builder setGoogleSearchRetrieval(GoogleSearchRetrieval value)

 Optional. GoogleSearchRetrieval tool type.
 Specialized retrieval tool that is powered by Google search.
 

.google.cloud.aiplatform.v1.GoogleSearchRetrieval google_search_retrieval = 3 [(.google.api.field_behavior) = OPTIONAL];

setGoogleSearchRetrieval

public Tool.Builder setGoogleSearchRetrieval(GoogleSearchRetrieval.Builder builderForValue)

 Optional. GoogleSearchRetrieval tool type.
 Specialized retrieval tool that is powered by Google search.
 

.google.cloud.aiplatform.v1.GoogleSearchRetrieval google_search_retrieval = 3 [(.google.api.field_behavior) = OPTIONAL];

mergeGoogleSearchRetrieval

public Tool.Builder mergeGoogleSearchRetrieval(GoogleSearchRetrieval value)

 Optional. GoogleSearchRetrieval tool type.
 Specialized retrieval tool that is powered by Google search.
 

.google.cloud.aiplatform.v1.GoogleSearchRetrieval google_search_retrieval = 3 [(.google.api.field_behavior) = OPTIONAL];

clearGoogleSearchRetrieval

public Tool.Builder clearGoogleSearchRetrieval()

 Optional. GoogleSearchRetrieval tool type.
 Specialized retrieval tool that is powered by Google search.
 

.google.cloud.aiplatform.v1.GoogleSearchRetrieval google_search_retrieval = 3 [(.google.api.field_behavior) = OPTIONAL];

getGoogleSearchRetrievalBuilder

public GoogleSearchRetrieval.Builder getGoogleSearchRetrievalBuilder()

 Optional. GoogleSearchRetrieval tool type.
 Specialized retrieval tool that is powered by Google search.
 

.google.cloud.aiplatform.v1.GoogleSearchRetrieval google_search_retrieval = 3 [(.google.api.field_behavior) = OPTIONAL];

getGoogleSearchRetrievalOrBuilder

public GoogleSearchRetrievalOrBuilder getGoogleSearchRetrievalOrBuilder()

 Optional. GoogleSearchRetrieval tool type.
 Specialized retrieval tool that is powered by Google search.
 

.google.cloud.aiplatform.v1.GoogleSearchRetrieval google_search_retrieval = 3 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getGoogleSearchRetrievalOrBuilder in interface ToolOrBuilder

setUnknownFields

public final Tool.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<Tool.Builder>

mergeUnknownFields

public final Tool.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<Tool.Builder>