Class BuiltInCodeExecutor

java.lang.Object

com.google.adk.JsonBaseModel

com.google.adk.codeexecutors.BaseCodeExecutor

com.google.adk.codeexecutors.BuiltInCodeExecutor

public class BuiltInCodeExecutor
extends BaseCodeExecutor

A code executor that uses the Model's built-in code executor.

Currently only supports Gemini 2.0+ models, but will be expanded to other models.

Constructor Summary

Constructors

Constructor	Description
BuiltInCodeExecutor()

Method Summary

Modifier and Type	Method	Description
CodeExecutionUtils.CodeExecutionResult	executeCode(InvocationContext invocationContext, CodeExecutionUtils.CodeExecutionInput codeExecutionInput)	Executes code and return the code execution result.
void	processLlmRequest(LlmRequest.Builder llmRequestBuilder)	Pre-process the LLM request for Gemini 2.0+ models to use the code execution tool.

Methods inherited from class BaseCodeExecutor

codeBlockDelimiters, errorRetryAttempts, executionResultDelimiters, optimizeDataFile, stateful

Modifier and Type	Method	Description
com.google.common.collect.ImmutableList<com.google.common.collect.ImmutableList<String>>	codeBlockDelimiters()	The list of the enclosing delimiters to identify the code blocks.
int	errorRetryAttempts()	The number of attempts to retry on consecutive code execution errors.
com.google.common.collect.ImmutableList<String>	executionResultDelimiters()	The delimiters to format the code execution result.
boolean	optimizeDataFile()	If true, extract and process data files from the model request and attach them to the code executor.
boolean	stateful()	Whether the code executor is stateful.

Methods inherited from class JsonBaseModel

fromJsonNode, fromJsonString, getMapper, toJson, toJsonNode, toJsonString

Modifier and Type	Method	Description
static <T extends JsonBaseModel> T	fromJsonNode(com.fasterxml.jackson.databind.JsonNode jsonNode, Class<T> clazz)	Deserializes a JsonNode to an object of the given type.
static <T extends JsonBaseModel> T	fromJsonString(String jsonString, Class<T> clazz)	Deserializes a Json string to an object of the given type.
static com.fasterxml.jackson.databind.ObjectMapper	getMapper()	Returns the mutable ObjectMapper instance used by ADK.
String	toJson()	Serializes this object (i.e., the ObjectMappper instance used by ADK) to a Json string.
protected static com.fasterxml.jackson.databind.JsonNode	toJsonNode(Object object)	Serializes an object to a JsonNode.
static String	toJsonString(Object object)	Serializes an object to a Json string.

Methods inherited from class Object

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

Constructor Details

BuiltInCodeExecutor

public BuiltInCodeExecutor()

Method Details

executeCode

public CodeExecutionUtils.CodeExecutionResult executeCode(InvocationContext invocationContext,
 CodeExecutionUtils.CodeExecutionInput codeExecutionInput)

Description copied from class: BaseCodeExecutor

Executes code and return the code execution result.

This method may perform blocking operations.

Specified by:

executeCode in class BaseCodeExecutor

Parameters:

invocationContext - The invocation context of the code execution.

codeExecutionInput - The code execution input.

Returns:

The code execution result.

processLlmRequest

public void processLlmRequest(LlmRequest.Builder llmRequestBuilder)

Pre-process the LLM request for Gemini 2.0+ models to use the code execution tool.