Class: A2A::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/a2a/client.rb

Constant Summary collapse

SUPPORTED_BINDINGS = 
[AgentInterface::JSONRPC, AgentInterface::HTTP_JSON].freeze

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(protocol:, capabilities: nil) ⇒ Client

Returns a new instance of Client.



31
32
33
34
 
# File 'lib/a2a/client.rb', line 31

def initialize(protocol:, capabilities: nil)
  @protocol = protocol
  @capabilities = capabilities
end

Class Method Details

.from_agent_card(card, headers: {}, extensions: [], preference: SUPPORTED_BINDINGS) ⇒ Object

§5.2, §8.3.2 — constructs a Client from an AgentCard by negotiating the protocol binding. The agent’s supportedInterfaces order is respected: the first interface whose protocolBinding appears in ‘preference` wins.



10
11
12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/a2a/client.rb', line 10

def self.from_agent_card(card, headers: {}, extensions: [], preference: SUPPORTED_BINDINGS)
  iface = card.preferred_interface(preference: preference)

  unless iface
    found = card.supported_interfaces.map(&:protocol_binding).join(", ")
    raise UnsupportedOperationError, "no supported interface in agent card (available: #{found})"
  end

  Versioning.validate!(iface.protocol_version)

  protocol = build_protocol(iface, headers: headers, extensions: extensions)
  new(protocol: protocol, capabilities: card.capabilities)
end

Instance Method Details

#cancel_task(id, metadata: nil, tenant: nil) ⇒ Object 



53
54
55
56
57
58
59
60
 
# File 'lib/a2a/client.rb', line 53

def cancel_task(id, metadata: nil, tenant: nil)
  if id.is_a?(Task) && id.terminal?
    raise TaskNotCancelableError, "task #{id.id} is already in a terminal state (#{id.status.state})"
  end

  task_id = id.is_a?(Task) ? id.id : id
  run Operation::CancelTask.new(id: task_id, metadata:, tenant:)
end

#create_task_push_notification_config(config, tenant: nil) ⇒ Object 



66
67
68
69
 
# File 'lib/a2a/client.rb', line 66

def create_task_push_notification_config(config, tenant: nil)
  require_push_notifications!
  run Operation::CreateTaskPushNotificationConfig.new(config, tenant:)
end

#delete_task_push_notification_config(task_id:, id:, tenant: nil) ⇒ Object 



81
82
83
84
 
# File 'lib/a2a/client.rb', line 81

def delete_task_push_notification_config(task_id:, id:, tenant: nil)
  require_push_notifications!
  run Operation::DeleteTaskPushNotificationConfig.new(task_id:, id:, tenant:)
end

#get_extended_agent_card(tenant: nil) ⇒ Object 



86
87
88
89
 
# File 'lib/a2a/client.rb', line 86

def get_extended_agent_card(tenant: nil)
  require_extended_agent_card!
  run Operation::GetExtendedAgentCard.new(tenant:)
end

#get_task(id, history_length: nil, tenant: nil) ⇒ Object 



45
46
47
 
# File 'lib/a2a/client.rb', line 45

def get_task(id, history_length: nil, tenant: nil)
  run Operation::GetTask.new(id:, history_length:, tenant:)
end

#get_task_push_notification_config(task_id:, id:, tenant: nil) ⇒ Object 



71
72
73
74
 
# File 'lib/a2a/client.rb', line 71

def get_task_push_notification_config(task_id:, id:, tenant: nil)
  require_push_notifications!
  run Operation::GetTaskPushNotificationConfig.new(task_id:, id:, tenant:)
end

#list_task_push_notification_configs(task_id:, page_size: nil, page_token: nil, tenant: nil) ⇒ Object 



76
77
78
79
 
# File 'lib/a2a/client.rb', line 76

def list_task_push_notification_configs(task_id:, page_size: nil, page_token: nil, tenant: nil)
  require_push_notifications!
  run Operation::ListTaskPushNotificationConfigs.new(task_id:, page_size:, page_token:, tenant:)
end

#list_tasks(**kwargs) ⇒ Object 



49
50
51
 
# File 'lib/a2a/client.rb', line 49

def list_tasks(**kwargs)
  run Operation::ListTasks.new(**kwargs)
end

#send_message(message, configuration: {}, metadata: nil, tenant: nil) ⇒ Object 



36
37
38
 
# File 'lib/a2a/client.rb', line 36

def send_message(message, configuration: {}, metadata: nil, tenant: nil)
  run Operation::SendMessage.new(message, configuration: configuration, metadata: metadata, tenant: tenant)
end

#send_streaming_message(message, configuration: {}, metadata: nil, tenant: nil, &block) ⇒ Object 



40
41
42
43
 
# File 'lib/a2a/client.rb', line 40

def send_streaming_message(message, configuration: {}, metadata: nil, tenant: nil, &block)
  op = Operation::SendStreamingMessage.new(message, configuration: configuration, metadata: metadata, tenant: tenant)
  run op, &block
end

#subscribe_to_task(id, tenant: nil, &block) ⇒ Object 



62
63
64
 
# File 'lib/a2a/client.rb', line 62

def subscribe_to_task(id, tenant: nil, &block)
  run Operation::SubscribeToTask.new(id:, tenant:), &block
end