Skip to main content

A lightweight framework for building LLM-powered agents with pluggable backends.

Project description

FlatAgents Python SDK

Status: Prototype

Python SDK for FlatAgents—a declarative format for defining AI agents. Write your agent config once, run it anywhere. See the spec.

In Progress

  • Unify input/output adapters for agent chaining
  • Simplify output adapters
  • Add declarative workflows (flatworkflows)
  • TypeScript SDK

Why FlatAgents?

Agent configs are portable. Write your agent YAML once, run it with any SDK that implements the spec. Share agents across teams, languages, and frameworks. Want an SDK for your language? Build one—the spec is simple.

Agent Definition

Define agents in YAML or JSON. Both formats are first-class.

agent.yml

spec: declarative_agent
spec_version: "0.4.0"

data:
  name: summarizer
  model:
    provider: openai
    name: gpt-4o-mini
  system: You summarize text concisely.
  user: "Summarize this: {{ input.text }}"
  output:
    summary:
      type: str
      description: A concise summary

agent.json

{
  "spec": "declarative_agent",
  "spec_version": "0.4.0",
  "data": {
    "name": "summarizer",
    "model": {
      "provider": "openai",
      "name": "gpt-4o-mini"
    },
    "system": "You summarize text concisely.",
    "user": "Summarize this: {{ input.text }}",
    "output": {
      "summary": {
        "type": "str",
        "description": "A concise summary"
      }
    }
  }
}
from flatagents import DeclarativeAgent

agent = DeclarativeAgent(config_file="agent.yml")  # or agent.json
result = await agent.execute(input={"text": "Long article here..."})
print(result["summary"])

Quick Start

pip install flatagents[litellm]

writer.yaml

spec: declarative_agent
spec_version: "0.4.0"

data:
  name: writer
  model:
    provider: openai
    name: gpt-4o-mini
  system: You write short, punchy marketing copy.
  user: |
    Product: {{ input.product }}
    {% if input.feedback %}Previous attempt: {{ input.tagline }}
    Feedback: {{ input.feedback }}
    Write an improved tagline.{% else %}Write a tagline.{% endif %}
  output:
    tagline:
      type: str
      description: The tagline

critic.yaml

spec: declarative_agent
spec_version: "0.4.0"

data:
  name: critic
  model:
    provider: openai
    name: gpt-4o-mini
  system: You critique marketing copy. Be constructive but direct.
  user: |
    Product: {{ input.product }}
    Tagline: {{ input.tagline }}
  output:
    feedback:
      type: str
      description: Constructive feedback
    score:
      type: int
      description: Score from 1-10

run.py

import asyncio
from flatagents import DeclarativeAgent

async def main():
    writer = DeclarativeAgent(config_file="writer.yaml")
    critic = DeclarativeAgent(config_file="critic.yaml")

    product = "a CLI tool for AI agents"
    draft = await writer.execute(input={"product": product})

    for round in range(4):
        review = await critic.execute(input={"product": product, **draft})
        print(f"Round {round + 1}: \"{draft['tagline']}\" - {review['score']}/10")

        if review["score"] >= 8:
            break
        draft = await writer.execute(input={"product": product, **review, **draft})

    print(f"Final: {draft['tagline']}")

asyncio.run(main())
export OPENAI_API_KEY="your-key"
python run.py

Usage

From Dictionary

from flatagents import DeclarativeAgent

config = {
    "spec": "declarative_agent",
    "spec_version": "0.4.0",
    "data": {
        "name": "calculator",
        "model": {"provider": "openai", "name": "gpt-4"},
        "system": "You are a calculator.",
        "user": "Calculate: {{ input.expression }}",
        "output": {
            "result": {"type": "float", "description": "The calculated result"}
        }
    }
}

agent = DeclarativeAgent(config_dict=config)
result = await agent.execute(input={"expression": "2 + 2"})

Custom Agent (Subclass FlatAgent)

from flatagents import FlatAgent

class MyAgent(FlatAgent):
    def create_initial_state(self):
        return {"count": 0}

    def generate_step_prompt(self, state):
        return f"Count is {state['count']}. What's next?"

    def update_state(self, state, result):
        return {**state, "count": int(result)}

    def is_solved(self, state):
        return state["count"] >= 10

agent = MyAgent(config_file="config.yaml")
trace = await agent.execute()

LLM Backends

Two backends available:

from flatagents import LiteLLMBackend, AISuiteBackend

# LiteLLM - model format: provider/model
backend = LiteLLMBackend(model="openai/gpt-4o", temperature=0.7)

# AISuite - model format: provider:model
backend = AISuiteBackend(model="openai:gpt-4o", temperature=0.7)

Custom Backend

Implement the LLMBackend protocol:

class MyBackend:
    total_cost: float = 0.0
    total_api_calls: int = 0

    async def call(self, messages: list, **kwargs) -> str:
        self.total_api_calls += 1
        return "response"

agent = MyAgent(backend=MyBackend())

Examples

More examples are available in the examples/ directory:

License

MIT License - see LICENSE for details.

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

flatagents-0.1.2.tar.gz (2.1 MB view details)

Uploaded Source

Built Distribution

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

flatagents-0.1.2-py3-none-any.whl (12.5 kB view details)

Uploaded Python 3

File details

Details for the file flatagents-0.1.2.tar.gz.

File metadata

  • Download URL: flatagents-0.1.2.tar.gz
  • Upload date:
  • Size: 2.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.9

File hashes

Hashes for flatagents-0.1.2.tar.gz
Algorithm Hash digest
SHA256 6c19c02f59a2589573bbb4da572fed969881cfaf04e31dfdd0fd8562e35f4a60
MD5 b455b0f6628f92ad933edaadb4c0bf19
BLAKE2b-256 4db92e3e3392cc084a26c87149a4879c7baed01f85a156c4ee0728b53f796052

See more details on using hashes here.

File details

Details for the file flatagents-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: flatagents-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 12.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.9

File hashes

Hashes for flatagents-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 4aa39a5b00c128a194693d2de7bb6b18f57c48668234cd3e07d7b7574dae71d4
MD5 465b74692d54a76050cdf8bfce5018e5
BLAKE2b-256 a2cc6b5fd0d79e737e2d7e0c18e35ab1aa26ea14829c5c602203ebb97a20d239

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