Skip to content

ServiceNow/TapeAgents

Repository files navigation

TapeAgents

GitHub Release PyPI - Version Documentation Build Status Tests Status

TapeAgents is a framework that leverages a structured, replayable log (Tape) of the agent session to facilitate all stages of the LLM Agent development lifecycle. In TapeAgents, the agent reasons by processing the tape and the LLM output to produce new thoughts, actions, control flow steps and append them to the tape. The environment then reacts to the agent’s actions by likewise appending observation steps to the tape.

image

Key features:

  • Build your agent as a low-level state machine, as a high-level multi-agent team configuration, or as a mono-agent guided by multiple prompts
  • Debug your agent with TapeAgent studio or TapeBrowser apps
  • Serve your agent with response streaming
  • Optimize your agent's configuration using successful tapes; finetune the LLM using revised tapes.

The Tape-centric design of TapeAgents will help you at all stages of your project:

  • Build with ultimate flexibility of having access to tape for making prompts and generating next steps
  • Change your prompts or team structure and resume the debug session as long as the new agent can continue from the older tape
  • Fully control the Agent's tape and the Agent's acting when you use a TapeAgent in an app
  • Optimize tapes and agents using the carefully crafted metadata structure that links together tapes, steps, llm calls and agent configurations

Get Started

We highly recommend starting with the introductory Jupyter notebook. The notebook will introduce you to all the core concepts of framework.

Installation

Install the latest release:

pip install TapeAgents

If you want to install the version from the sources:

  1. Clone the repository:
git clone https://github.com/ServiceNow/TapeAgents.git
cd TapeAgents
  1. Create conda environment tapeagents and install the package in editable mode inside the environment:
make setup

Examples

The simplest agent just to show the basic structure of the agent:

from tapeagents.agent import Agent, Node
from tapeagents.core import Prompt
from tapeagents.dialog_tape import AssistantStep, UserStep, DialogTape
from tapeagents.llms import LLMStream, LiteLLM
from tapeagents.prompting import tape_to_messages

llm = LiteLLM(model_name="gpt-4o-mini")


class MainNode(Node):
    def make_prompt(self, agent: Agent, tape: DialogTape) -> Prompt:
        # Render the whole tape into the prompt, each step is converted to message
        return Prompt(messages=tape_to_messages(tape))

    def generate_steps(self, agent: Agent, tape: DialogTape, llm_stream: LLMStream):
        # Generate single tape step from the LLM output messages stream.
        yield AssistantStep(content=llm_stream.get_text())


agent = Agent[DialogTape].create(llm, nodes=[MainNode()])
start_tape = DialogTape(steps=[UserStep(content="Tell me about Montreal in 3 sentences")])
final_tape = agent.run(start_tape).get_final_tape()  # agent will start executing the first node
print(f"Final tape: {final_tape.model_dump_json(indent=2)}")

The examples/ directory contains examples of how to use the TapeAgents framework for building, debugging, serving and improving agents. Each example is a self-contained Python script (or module) that demonstrates how to use the framework to build an agent for a specific task.

Other notable examples that demonstrate the main aspects of the framework:

Learn more

See our technical report on TapeAgents.

Contacts

Feel free to reach out to the team:

Acknowledgements

We acknowledge the inspiration we took from prior frameworks, in particular LangGraph, AutoGen, AIWaves Agents and DSPy.