Class AgentConfig (3.100.0)

public final class AgentConfig extends GeneratedMessage implements AgentConfigOrBuilder

Represents configuration for an Agent.

Protobuf type google.cloud.aiplatform.v1beta1.AgentConfig

Static Fields

AGENT_ID_FIELD_NUMBER

public static final int AGENT_ID_FIELD_NUMBER
Field Value
Type Description
int

AGENT_TYPE_FIELD_NUMBER

public static final int AGENT_TYPE_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

INSTRUCTION_FIELD_NUMBER

public static final int INSTRUCTION_FIELD_NUMBER
Field Value
Type Description
int

SUB_AGENTS_FIELD_NUMBER

public static final int SUB_AGENTS_FIELD_NUMBER
Field Value
Type Description
int

TOOLS_FIELD_NUMBER

public static final int TOOLS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AgentConfig getDefaultInstance()
Returns
Type Description
AgentConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static AgentConfig.Builder newBuilder()
Returns
Type Description
AgentConfig.Builder

newBuilder(AgentConfig prototype)

public static AgentConfig.Builder newBuilder(AgentConfig prototype)
Parameter
Name Description
prototype AgentConfig
Returns
Type Description
AgentConfig.Builder

parseDelimitedFrom(InputStream input)

public static AgentConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AgentConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AgentConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AgentConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static AgentConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
AgentConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AgentConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AgentConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AgentConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AgentConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AgentConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AgentConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AgentConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AgentConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AgentConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AgentConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static AgentConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AgentConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AgentConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AgentConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static AgentConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AgentConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AgentConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AgentConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<AgentConfig> parser()
Returns
Type Description
Parser<AgentConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAgentId()

public String getAgentId()

Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the sub_agents field. It must be unique within the agents map.

optional string agent_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The agentId.

getAgentIdBytes()

public ByteString getAgentIdBytes()

Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the sub_agents field. It must be unique within the agents map.

optional string agent_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for agentId.

getAgentType()

public String getAgentType()

Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent.

string agent_type = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The agentType.

getAgentTypeBytes()

public ByteString getAgentTypeBytes()

Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent.

string agent_type = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for agentType.

getDefaultInstanceForType()

public AgentConfig getDefaultInstanceForType()
Returns
Type Description
AgentConfig

getDescription()

public String getDescription()

Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getInstruction()

public String getInstruction()

Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the AgentEvent.state_delta field.

string instruction = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The instruction.

getInstructionBytes()

public ByteString getInstructionBytes()

Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the AgentEvent.state_delta field.

string instruction = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for instruction.

getParserForType()

public Parser<AgentConfig> getParserForType()
Returns
Type Description
Parser<AgentConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSubAgents(int index)

public String getSubAgents(int index)

Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology.

repeated string sub_agents = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The subAgents at the given index.

getSubAgentsBytes(int index)

public ByteString getSubAgentsBytes(int index)

Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology.

repeated string sub_agents = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the subAgents at the given index.

getSubAgentsCount()

public int getSubAgentsCount()

Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology.

repeated string sub_agents = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of subAgents.

getSubAgentsList()

public ProtocolStringList getSubAgentsList()

Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology.

repeated string sub_agents = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the subAgents.

getTools(int index)

public Tool getTools(int index)

Optional. The list of tools available to this agent.

repeated .google.cloud.aiplatform.v1beta1.Tool tools = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Tool

getToolsCount()

public int getToolsCount()

Optional. The list of tools available to this agent.

repeated .google.cloud.aiplatform.v1beta1.Tool tools = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getToolsList()

public List<Tool> getToolsList()

Optional. The list of tools available to this agent.

repeated .google.cloud.aiplatform.v1beta1.Tool tools = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Tool>

getToolsOrBuilder(int index)

public ToolOrBuilder getToolsOrBuilder(int index)

Optional. The list of tools available to this agent.

repeated .google.cloud.aiplatform.v1beta1.Tool tools = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
ToolOrBuilder

getToolsOrBuilderList()

public List<? extends ToolOrBuilder> getToolsOrBuilderList()

Optional. The list of tools available to this agent.

repeated .google.cloud.aiplatform.v1beta1.Tool tools = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.aiplatform.v1beta1.ToolOrBuilder>

hasAgentId()

public boolean hasAgentId()

Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the sub_agents field. It must be unique within the agents map.

optional string agent_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the agentId field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public AgentConfig.Builder newBuilderForType()
Returns
Type Description
AgentConfig.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected AgentConfig.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AgentConfig.Builder
Overrides

toBuilder()

public AgentConfig.Builder toBuilder()
Returns
Type Description
AgentConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException