Skip to main content

Library for building prompts for LLMs

Project description

Prompt Builder

Library for building prompts and agents with LLMs.

Installation

From PyPI:

pip install promptbuilder

From source:

git clone https://github.com/kapulkin/promptbuilder.git
cd promptbuilder
pip install -e .

Features

  • Prompt templates with variables and content tags
  • Structured output with TypeScript-like schema definition
  • LLM client with native structured output support and caching option
  • Integration with multiple LLM providers through aisuite
  • Agents with routing based on tools
  • Tools as agent for flexibility and scalability

Quick Start

Basic Prompt Usage

from promptbuilder.llm_client import LLMClient
from promptbuilder.prompt_builder import PromptBuilder

# Build prompt template
prompt_template = PromptBuilder() \
    .text("What is the capital of ").variable("country").text("?") \
    .build()

# Use with LLM
llm_client = LLMClient(model="your-model", api_key="your-api-key")
response = llm_client.from_text(
    prompt_template.render(country="France")
)
print(response)

Using Agents

from typing import List
from pydantic import BaseModel, Field
from promptbuilder.agent.agent import AgentRouter
from promptbuilder.agent.context import Context, InMemoryDialogHistory
from promptbuilder.agent.message import Message
from promptbuilder.llm_client import LLMClient

# Define tool arguments
class AddTodoArgs(BaseModel):
    item: TodoItem = Field(..., description="Todo item to add")

# Create custom context
class TodoItem(BaseModel):
    description: str = Field(..., description="Description of the todo item")

class TodoListContext(Context[InMemoryDialogHistory]):
    todos: List[TodoItem] = []

# Create agent with tools
class TodoListAgent(AgentRouter[InMemoryDialogHistory, TodoListContext]):
    def __init__(self, llm_client: LLMClient, context: TodoListContext):
        super().__init__(llm_client=llm_client, context=context)
    
llm_client = LLMClient(model="your-model", api_key="your-api-key")
agent = TodoListAgent(llm_client=llm_client, context=TodoListContext())

@agent.tool(description="Add a new todo item to the list", args_model=AddTodoArgs)
async def add_todo(message: Message, args: AddTodoArgs, context: TodoListContext) -> str:
    context.todos.append(args.item)
    return f"Added todo item: {args.item.description}"

# Use the agent
async def main():
    response = await agent(Message(role="user", content="Add a todo: Buy groceries"))
    print(response)

See the examples directory for more detailed examples, including a complete todo list manager.

License

MIT License - see LICENSE file for details.

Contributing

Contributions are welcome! Please feel free to submit a pull request.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

promptbuilder-0.4.3.tar.gz (23.7 kB view details)

Uploaded Source

Built Distribution

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

promptbuilder-0.4.3-py3-none-any.whl (26.5 kB view details)

Uploaded Python 3

File details

Details for the file promptbuilder-0.4.3.tar.gz.

File metadata

  • Download URL: promptbuilder-0.4.3.tar.gz
  • Upload date:
  • Size: 23.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.3

File hashes

Hashes for promptbuilder-0.4.3.tar.gz
Algorithm Hash digest
SHA256 53a24e4601bfd9b6e5f3d8f92c709160f18294fa08385fba47d07a7f648ee552
MD5 cfa5ec1e42e6331ff0645df1f0cd9880
BLAKE2b-256 e767c19ae03793d4a673665ff66344d4452c3db75eb283b7e4d735a36493276b

See more details on using hashes here.

File details

Details for the file promptbuilder-0.4.3-py3-none-any.whl.

File metadata

  • Download URL: promptbuilder-0.4.3-py3-none-any.whl
  • Upload date:
  • Size: 26.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.3

File hashes

Hashes for promptbuilder-0.4.3-py3-none-any.whl
Algorithm Hash digest
SHA256 0abd76dc964c0574ce2483eed25e748e858369459af29cf35ceaa3ee0ef1480e
MD5 d8a47b232582455d5038d9ee485d9d7d
BLAKE2b-256 82ead18777679d802beb61766a34854db2ab83186f1c232fcca848ccff3dd01d

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