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.0.tar.gz (73.4 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.0-py3-none-any.whl (28.8 kB view details)

Uploaded Python 3

File details

Details for the file tfy_assistant_framework-0.1.0.tar.gz.

File metadata

  • Download URL: tfy_assistant_framework-0.1.0.tar.gz
  • Upload date:
  • Size: 73.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for tfy_assistant_framework-0.1.0.tar.gz
Algorithm Hash digest
SHA256 a4385f3b0cedd50846632e9d3a5577261fed2791b547ed636343af62b547d178
MD5 cfe7d4afbdfcc66f77860d0d98f060eb
BLAKE2b-256 a139e0351f5cc67079061829fe27b156c24640c461d8b83fe8079736abaf9af9

See more details on using hashes here.

File details

Details for the file tfy_assistant_framework-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for tfy_assistant_framework-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d5c76c708899c3b3886341893059c2509a1fbc61480e1b00b7cf30bc58e1de91
MD5 a24ba68fe6df218e819979fb8b9769ce
BLAKE2b-256 58a4425b994815dcace703ca700d4904cf5be3b668d5af68dc2e3141ba5b052d

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