Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1AgentConfig

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/aiplatform_v1/classes.rb,
lib/google/apis/aiplatform_v1/representations.rb,
lib/google/apis/aiplatform_v1/representations.rb

Overview

Represents configuration for an Agent.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1AgentConfig

Returns a new instance of GoogleCloudAiplatformV1AgentConfig.



1242
1243
1244
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 1242

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#agent_id ⇒ String

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. Corresponds to the JSON property agentId

Returns:

  • (String) 


1208
1209
1210
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 1208

def agent_id
  @agent_id
end

#agent_type ⇒ String

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. Corresponds to the JSON property agentType

Returns:

  • (String) 


1215
1216
1217
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 1215

def agent_type
  @agent_type
end

#description ⇒ String

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

Returns:

  • (String) 


1221
1222
1223
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 1221

def description
  @description
end

#instruction ⇒ String

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. Corresponds to the JSON property instruction

Returns:

  • (String) 


1229
1230
1231
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 1229

def instruction
  @instruction
end

#sub_agents ⇒ Array<String>

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. Corresponds to the JSON property subAgents

Returns:

  • (Array<String>) 


1235
1236
1237
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 1235

def sub_agents
  @sub_agents
end

#tools ⇒ Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Tool>

Optional. The list of tools available to this agent. Corresponds to the JSON property tools

Returns:



1240
1241
1242
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 1240

def tools
  @tools
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1247
1248
1249
1250
1251
1252
1253
1254
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 1247

def update!(**args)
  @agent_id = args[:agent_id] if args.key?(:agent_id)
  @agent_type = args[:agent_type] if args.key?(:agent_type)
  @description = args[:description] if args.key?(:description)
  @instruction = args[:instruction] if args.key?(:instruction)
  @sub_agents = args[:sub_agents] if args.key?(:sub_agents)
  @tools = args[:tools] if args.key?(:tools)
end