Skip to main content

LlamaIndex Workflows

LlamaIndex Workflows are a framework for orchestrating and chaining together complex systems of steps and events.

What can you build with Workflows?

Workflows shine when you need to orchestrate complex, multi-step processes that involve AI models, APIs, and decision-making. Here are some examples of what you can build:

  • AI Agents - Create intelligent systems that can reason, make decisions, and take actions across multiple steps
  • Document Processing Pipelines - Build systems that ingest, analyze, summarize, and route documents through various processing stages
  • Multi-Model AI Applications - Coordinate between different AI models (LLMs, vision models, etc.) to solve complex tasks
  • Research Assistants - Develop workflows that can search, analyze, synthesize information, and provide comprehensive answers
  • Content Generation Systems - Create pipelines that generate, review, edit, and publish content with human-in-the-loop approval
  • Customer Support Automation - Build intelligent routing systems that can understand, categorize, and respond to customer inquiries

The async-first, event-driven architecture makes it easy to build workflows that can route between different capabilities, implement parallel processing patterns, loop over complex sequences, and maintain state across multiple steps - all the features you need to make your AI applications production-ready.

Key Features

  • async-first - workflows are built around python's async functionality - steps are async functions that process incoming events from an asyncio queue and emit new events to other queues. This also means that workflows work best in your async apps like FastAPI, Jupyter Notebooks, etc.
  • event-driven - workflows consist of steps and events. Organizing your code around events and steps makes it easier to reason about and test.
  • state management - each run of a workflow is self-contained, meaning you can launch a workflow, save information within it, serialize the state of a workflow and resume it later.
  • observability - workflows are automatically instrumented for observability, meaning you can use tools like Arize Phoenix and OpenTelemetry right out of the box.

Quick Start

Install the package:

pip install llama-index-workflows

And create your first workflow:

import asyncio
from pydantic import BaseModel, Field
from workflows import Context, Workflow, step
from workflows.events import Event, StartEvent, StopEvent

class MyEvent(Event):
    msg: list[str]

class RunState(BaseModel):
    num_runs: int = Field(default=0)

class MyWorkflow(Workflow):
    @step
    async def start(self, ctx: Context[RunState], ev: StartEvent) -> MyEvent:
        async with ctx.store.edit_state() as state:
            state.num_runs += 1

            return MyEvent(msg=[ev.input_msg] * state.num_runs)

    @step
    async def process(self, ctx: Context[RunState], ev: MyEvent) -> StopEvent:
        data_length = len("".join(ev.msg))
        new_msg = f"Processed {len(ev.msg)} times, data length: {data_length}"
        return StopEvent(result=new_msg)

async def main():
    workflow = MyWorkflow()

    # [optional] provide a context object to the workflow
    ctx = Context(workflow)
    result = await workflow.run(input_msg="Hello, world!", ctx=ctx)
    print("Workflow result:", result)

    # re-running with the same context will retain the state
    result = await workflow.run(input_msg="Hello, world!", ctx=ctx)
    print("Workflow result:", result)


if __name__ == "__main__":
    asyncio.run(main())

In the example above

  • Steps that accept a StartEvent will be run first.
  • Steps that return a StopEvent will end the workflow.
  • Intermediate events are user defined and can be used to pass information between steps.
  • The Context object is also used to share information between steps.

Visit the complete documentation for more examples using llama-index!

Metadata

Release files for llama-index-workflows 2.26.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for llama-index-workflows 2.26.0
File Size Uploaded
llama_index_workflows-2.26.0.tar.gz 159.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for llama-index-workflows 2.26.0
File Interpreter ABI Platform
llama_index_workflows-2.26.0-py3-none-any.whl Python 3 none any Details

Total release size: 342.4 kB

Release files / llama_index_workflows-2.26.0.tar.gz

Download URL llama_index_workflows-2.26.0.tar.gz
Size 159.2 kB
Tags Source
SHA-256 checksum
How to use checksums
1aa685b678acbbd0a01a22e4d73aecd374cd12f923cf12ea83c5264f68bafa16
BLAKE2b-256 checksum
How to use checksums
1d42d4e1b004a041fcbad1e3acc804090a28161358ac567b0c74be2a3eef760c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.0 {"installer":{"name":"uv","version":"0.13.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / llama_index_workflows-2.26.0-py3-none-any.whl

Download URL llama_index_workflows-2.26.0-py3-none-any.whl
Size 183.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c90cf7562f175f11cef5d5a657c38db0a21ce66bee07573c2c5a1f68cb8ae4df
BLAKE2b-256 checksum
How to use checksums
7435f446e276b94d0602471d575def1407eb5248ac4edd05feef21419cb5149f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.0 {"installer":{"name":"uv","version":"0.13.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release history Release notifications | RSS feed

This release

2.26.0 This release

2 release files

2.25.0

2 release files

2.24.1

2 release files

2.24.0

2 release files

2.23.3

2 release files

2.23.2

2 release files

2.23.1

2 release files

2.22.2

2 release files

2.22.1

2 release files

2.22.0

2 release files

2.21.0

2 release files

2.20.0

2 release files

2.19.1

2 release files

2.19.0

2 release files

2.18.0

2 release files

2.17.1

2 release files

2.17.0

2 release files

2.16.1

2 release files

2.16.0

2 release files

2.15.0

2 release files

2.14.2

2 release files

2.13.1

2 release files

2.13.0

2 release files

2.12.2

2 release files

2.12.1

2 release files

2.12.0

2 release files

2.11.6

2 release files

2.11.5

2 release files

2.11.4

2 release files

2.11.3

2 release files

2.11.2

2 release files

2.10.0

2 release files

2.9.1

2 release files

2.9.0

2 release files

2.8.3

2 release files

2.8.2

2 release files

2.8.1

2 release files

2.8.0

2 release files

2.7.1

2 release files

2.7.0

2 release files

2.6.0

2 release files

2.5.0

2 release files

2.4.0

2 release files

2.3.0

2 release files

2.2.2

2 release files

2.2.1

2 release files

2.2.0

2 release files

2.1.0

2 release files

2.0.1

2 release files

2.0.0

2 release files

1.3.0

2 release files

1.2.0

2 release files

1.1.0

2 release files

1.0.1

2 release files

1.0.0

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page