swarmauri.core.agent_apis package

Submodules

• swarmauri.core.agent_apis.IAgentCommands module
  • IAgentCommands
    • IAgentCommands.abatch()
    • IAgentCommands.ainvoke()
    • IAgentCommands.batch()
    • IAgentCommands.get_schema_config()
    • IAgentCommands.invoke()
    • IAgentCommands.stream()
• swarmauri.core.agent_apis.IAgentRouterCRUD module
  • IAgentRouterCRUD
    • IAgentRouterCRUD.create_route()
    • IAgentRouterCRUD.delete_route()
    • IAgentRouterCRUD.read_route()
    • IAgentRouterCRUD.update_route()

Module contents

class swarmauri.core.agent_apis.IAgentCommands

Bases: ABC

Interface for the API object that enables a SwarmAgent to host various API routes.

abstract async abatch(requests)

Handles batched invocation requests asynchronously.

Parameters:

requests (List[Any]) – A list of incoming request payloads.

Returns:

A list of responses.

Return type:

List[Any]

abstract async ainvoke(request)

Handles invocation requests asynchronously.

Parameters:

request (Any) – The incoming request payload.

Returns:

The response payload.

Return type:

Any

abstract batch(requests)

Handles batched invocation requests synchronously.

Parameters:

requests (List[Any]) – A list of incoming request payloads.

Returns:

A list of responses.

Return type:

List[Any]

abstract get_schema_config()

Retrieves the schema configuration for the API.

Returns:

The schema configuration.

Return type:

dict

abstract invoke(request)

Handles invocation requests synchronously.

Parameters:

request (Any) – The incoming request payload.

Returns:

The response payload.

Return type:

Any

abstract stream(request)

Handles streaming requests.

Parameters:

request (Any) – The incoming request payload.

Returns:

A streaming response.

Return type:

Any

class swarmauri.core.agent_apis.IAgentRouterCRUD

Bases: ABC

Interface for managing API routes within a SwarmAgent.

abstract create_route(path, method, handler)

Create a new route for the API.

Parameters: - path (str): The URL path for the route. - method (str): The HTTP method (e.g., ‘GET’, ‘POST’). - handler (Callable[[Any], Any]): The function that handles requests to this route.

Return type:

None

abstract delete_route(path, method)

Delete a specific route from the API.

Parameters: - path (str): The URL path for the route. - method (str): The HTTP method.

Return type:

None

abstract read_route(path, method)

Retrieve information about a specific route.

Parameters: - path (str): The URL path for the route. - method (str): The HTTP method.

Returns: - Dict: Information about the route, including path, method, and handler.

Return type:

Dict

abstract update_route(path, method, new_handler)

Update the handler function for an existing route.

Parameters: - path (str): The URL path for the route. - method (str): The HTTP method. - new_handler (Callable[[Any], Any]): The new function that handles requests to this route.

Return type:

None