Skip to main content

Framework for building AI assistants with streaming updates and user interactions

Project description

Tfy Assistant Framework

Overview

The Tfy Assistant Framework is a framework for building AI assistants with streaming updates and user interactions.

Installation

pip install tfy-assistant-framework

Usage

Simple chat assistant:

from tfy_assistant_framework.swarm import Agent, client

class Chat(Agent[Any]): ...

chat_agent = Chat(
    instructions="Chat with the user",
)

async def run_chat_assistant() -> None:
    async for agent_run in client.run(agent=chat_agent, messages=[], interactive=True):
        agent_run.debug_log()

This can be run in console directly to chat with the assistant. To serve the assistant via FastAPI,

js: JetStreamContext
assistant_serve = AssistantServe()

@asynccontextmanager
async def lifespan(app: FastAPI) -> AsyncIterator[None]:
    global js
    async with nats_connection() as (nc, js_):
        js = js_
        async with assistant_serve.init(nc=nc, app=app):
            yield

app = FastAPI(
    title="LLM Assistants Server",
    lifespan=lifespan,
    docs_url="/",
)

@app.post("/assistants/chat/task")
async def chat_task() -> CreateAssistantTaskRunResult:
    task_id = uuid.uuid4().hex
    return await assistant_serve.create_assistant_task(
        task_id=task_id,
        assistant_awaitable=run_chat_assistant(),
        assistant_update_sink=NATSAssistantUpdateSink(task_id=task_id, js=js),
    )

@app.post("/tasks/{task_id}/message")
async def send_message_to_assistant_task(
    task_id: str,
    message: PostAssistantTaskMessage,
) -> Response:
    return await assistant_serve.send_message_to_assistant_task(task_id, message)

For more examples, see the examples directory.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tfy_assistant_framework-0.1.1rc2.tar.gz (21.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tfy_assistant_framework-0.1.1rc2-py3-none-any.whl (29.0 kB view details)

Uploaded Python 3

File details

Details for the file tfy_assistant_framework-0.1.1rc2.tar.gz.

File metadata

File hashes

Hashes for tfy_assistant_framework-0.1.1rc2.tar.gz
Algorithm Hash digest
SHA256 b243482c186b093b9c9847670c59076fe516976929764e27930ea6dfa9257136
MD5 dbe3d6ce36d4a76bd5507cfebb3ce1c4
BLAKE2b-256 ca688ff151ec16945531f91dbfc6d443946526d08696a154a73658352fd2ff4a

See more details on using hashes here.

File details

Details for the file tfy_assistant_framework-0.1.1rc2-py3-none-any.whl.

File metadata

File hashes

Hashes for tfy_assistant_framework-0.1.1rc2-py3-none-any.whl
Algorithm Hash digest
SHA256 68268c6366c9d169c14acd3b840980e764af1a75ace4e52b02579eaca9005592
MD5 880c8e71393097c8a635e234e8af7381
BLAKE2b-256 5c50dc5e65a17b8aa6431c4655baa601ccb0a53216cbbe743902f735e8aa1b0c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page