Interface ToolOrBuilder (3.38.0)

public interface ToolOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFunctionDeclarations(int index)

public abstract FunctionDeclaration getFunctionDeclarations(int index)

Optional. 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 in the response. User should provide a FunctionResponse 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.v1beta1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint
Returns
TypeDescription
FunctionDeclaration

getFunctionDeclarationsCount()

public abstract int getFunctionDeclarationsCount()

Optional. 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 in the response. User should provide a FunctionResponse 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.v1beta1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

getFunctionDeclarationsList()

public abstract List<FunctionDeclaration> getFunctionDeclarationsList()

Optional. 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 in the response. User should provide a FunctionResponse 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.v1beta1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
List<FunctionDeclaration>

getFunctionDeclarationsOrBuilder(int index)

public abstract FunctionDeclarationOrBuilder getFunctionDeclarationsOrBuilder(int index)

Optional. 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 in the response. User should provide a FunctionResponse 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.v1beta1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint
Returns
TypeDescription
FunctionDeclarationOrBuilder

getFunctionDeclarationsOrBuilderList()

public abstract List<? extends FunctionDeclarationOrBuilder> getFunctionDeclarationsOrBuilderList()

Optional. 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 in the response. User should provide a FunctionResponse 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.v1beta1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
List<? extends com.google.cloud.aiplatform.v1beta1.FunctionDeclarationOrBuilder>

getGoogleSearchRetrieval()

public abstract GoogleSearchRetrieval getGoogleSearchRetrieval()

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

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

Returns
TypeDescription
GoogleSearchRetrieval

The googleSearchRetrieval.

getGoogleSearchRetrievalOrBuilder()

public abstract GoogleSearchRetrievalOrBuilder getGoogleSearchRetrievalOrBuilder()

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

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

Returns
TypeDescription
GoogleSearchRetrievalOrBuilder

getRetrieval()

public abstract Retrieval getRetrieval()

Optional. 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.v1beta1.Retrieval retrieval = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Retrieval

The retrieval.

getRetrievalOrBuilder()

public abstract RetrievalOrBuilder getRetrievalOrBuilder()

Optional. 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.v1beta1.Retrieval retrieval = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
RetrievalOrBuilder

hasGoogleSearchRetrieval()

public abstract boolean hasGoogleSearchRetrieval()

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

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

Returns
TypeDescription
boolean

Whether the googleSearchRetrieval field is set.

hasRetrieval()

public abstract boolean hasRetrieval()

Optional. 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.v1beta1.Retrieval retrieval = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the retrieval field is set.