public interface AgentConfigOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getAgentId()
public abstract 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 abstract 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 abstract 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 abstract 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. |
getDescription()
public abstract 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 abstract 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 abstract 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 abstract 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. |
getSubAgents(int index)
public abstract 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 |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The subAgents at the given index. |
getSubAgentsBytes(int index)
public abstract 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 |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the subAgents at the given index. |
getSubAgentsCount()
public abstract 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 abstract List<String> 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 |
List<String> |
A list containing the subAgents. |
getTools(int index)
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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. |