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 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 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: flatagent
spec_version: "0.5.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": "flatagent",
  "spec_version": "0.5.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 FlatAgent

agent = FlatAgent(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: flatagent
spec_version: "0.5.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: flatagent
spec_version: "0.5.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 FlatAgent

async def main():
    writer = FlatAgent(config_file="writer.yaml")
    critic = FlatAgent(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 FlatAgent

config = {
    "spec": "flatagent",
    "spec_version": "0.5.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 = FlatAgent(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.3.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.3-py3-none-any.whl (12.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: flatagents-0.1.3.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.3.tar.gz
Algorithm Hash digest
SHA256 9240787fa98b98077ba326d68bef6e8a1b46c4617a2554d3b5ddec8981d133b4
MD5 bd30e3f1a53ec8ca9667a457f449127c
BLAKE2b-256 47a471eb02018082757b705e32c30e69a1af8a392e1da673eebd73045dc9226a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: flatagents-0.1.3-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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 5ba10044d9f56d1f095d963e362ec384e2d8b8d804d96c789a55d1a32dbcc3ba
MD5 946518ad93d0a4ce8af2151164cdf70f
BLAKE2b-256 b751274973f3acc950e699e33b9f7aa78948a825c5751c72259b3e31a4c34f42

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