Back to packageRELEASE DETAILS

1.1.0

PyPI

agent-protocol-client

Agent Communication Protocol Client

Published2 Jan 2024

Direct dependencies4

Transitive dependenciesNot calculated

README

Version 1.1.0 documentation

Agent Protocol - Python Client

PyPI PyPI - Python Version PyPI - Downloads

Installation

pip install agent-protocol-client

Getting Started

In your own code, to use this library to connect and interact with agent-protocol-client, you can run the following:


import time
import agent_protocol_client
from agent_protocol_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://0.0.0.0:8000
# See configuration.py for a list of all supported configuration parameters.
configuration = agent_protocol_client.Configuration(
    host = "http://0.0.0.0:8000"
)



# Enter a context with an instance of the API client
async with agent_protocol_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = agent_protocol_client.AgentApi(api_client)
    task_request_body = agent_protocol_client.TaskRequestBody() # TaskRequestBody |  (optional)

    try:
        # Creates a task for the agent.
        api_response = await api_instance.create_agent_task(task_request_body=task_request_body)
        print("The response of AgentApi->create_agent_task:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AgentApi->create_agent_task: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://0.0.0.0:8000

Class	Method	HTTP request	Description
AgentApi	create_agent_task	POST /ap/v1/agent/tasks	Creates a task for the agent.
AgentApi	download_agent_task_artifact	GET /ap/v1/agent/tasks/{task_id}/artifacts/{artifact_id}	Download a specified artifact.
AgentApi	execute_agent_task_step	POST /ap/v1/agent/tasks/{task_id}/steps	Execute a step in the specified agent task.
AgentApi	get_agent_task	GET /ap/v1/agent/tasks/{task_id}	Get details about a specified agent task.
AgentApi	get_agent_task_step	GET /ap/v1/agent/tasks/{task_id}/steps/{step_id}	Get details about a specified task step.
AgentApi	list_agent_task_artifacts	GET /ap/v1/agent/tasks/{task_id}/artifacts	List all artifacts that have been created for the given task.
AgentApi	list_agent_task_steps	GET /ap/v1/agent/tasks/{task_id}/steps	List all steps for the specified task.
AgentApi	list_agent_tasks	GET /ap/v1/agent/tasks	List all tasks that have been created for the agent.
AgentApi	upload_agent_task_artifacts	POST /ap/v1/agent/tasks/{task_id}/artifacts	Upload an artifact for the specified task.

Documentation For Models

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Declared dependencies 4

Native requirements

4 direct targetsNot calculated transitive count

Package / target	Requirement	Relationship
urllib3 Environment { "extras": "", "marker": null, "requires_python": ">=3.7,<4.0", "evaluation": "NOT_EVALUATED" }	`urllib3 (>=1.25.3,<2.0.0)`	runtime
aiohttp Environment { "extras": "", "marker": null, "requires_python": ">=3.7,<4.0", "evaluation": "NOT_EVALUATED" }	`aiohttp (>=3.8.4,<4.0.0)`	runtime
pydantic Environment { "extras": "", "marker": null, "requires_python": ">=3.7,<4.0", "evaluation": "NOT_EVALUATED" }	`pydantic (>=1.10.5,<2.0.0)`	runtime
python-dateutil Environment { "extras": "", "marker": null, "requires_python": ">=3.7,<4.0", "evaluation": "NOT_EVALUATED" }	`python-dateutil (>=2.8.2,<3.0.0)`	runtime