Class ContainerCodeExecutor

java.lang.Object

com.google.adk.JsonBaseModel

com.google.adk.codeexecutors.BaseCodeExecutor

com.google.adk.codeexecutors.ContainerCodeExecutor

public class ContainerCodeExecutor
extends BaseCodeExecutor

A code executor that uses a custom container to execute code.

Constructor Summary

Constructors

Constructor	Description
ContainerCodeExecutor(Optional<String> baseUrl, Optional<String> image, Optional<String> dockerPath)	Initializes the ContainerCodeExecutor.

Method Summary

Modifier and Type	Method	Description
CodeExecutionUtils.CodeExecutionResult	executeCode(InvocationContext invocationContext, CodeExecutionUtils.CodeExecutionInput codeExecutionInput)	Executes code and return 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 BaseCodeExecutor

codeBlockDelimiters, errorRetryAttempts, executionResultDelimiters

Methods inherited from class JsonBaseModel

fromJsonNode, fromJsonString, getMapper, toJson, toJsonNode, toJsonString

Methods inherited from class Object

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

Constructor Details

ContainerCodeExecutor

public ContainerCodeExecutor(Optional<String> baseUrl,
 Optional<String> image,
 Optional<String> dockerPath)

Initializes the ContainerCodeExecutor.

Parameters:

baseUrl - Optional. The base url of the user hosted Docker client.

image - The tag of the predefined image or custom image to run on the container. Either dockerPath or image must be set.

dockerPath - The path to the directory containing the Dockerfile. If set, build the image from the dockerfile path instead of using the predefined image. Either dockerPath or image must be set.

Method Details

stateful

public boolean stateful()

Description copied from class: BaseCodeExecutor

Whether the code executor is stateful. Default to False.

Overrides:

stateful in class BaseCodeExecutor

optimizeDataFile

public boolean optimizeDataFile()

Description copied from class: BaseCodeExecutor

If true, extract and process data files from the model request and attach them to the code executor.

Supported data file MimeTypes are [text/csv]. Default to False.

Overrides:

optimizeDataFile in class BaseCodeExecutor

executeCode

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

Description copied from class: BaseCodeExecutor

Executes code and return the code execution result.

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.