openai-sdk-helpers 0.0.8

Composable helpers for OpenAI SDK agents, prompts, and storage

openai-sdk-helpers

Shared primitives for composing OpenAI agent workflows: structures, response handling, prompt rendering, and reusable agent factories.

Overview

openai-sdk-helpers packages the common building blocks required to assemble agent-driven applications. The library intentionally focuses on reusable primitives—data structures, configuration helpers, and orchestration utilities—while leaving application-specific prompts and tools to the consuming project.

Features

• Agent wrappers for OpenAI Agents SDK with synchronous and asynchronous entry points.
• Prompt rendering powered by Jinja for dynamic agent instructions.
• Typed structures for prompts, responses, and search workflows to ensure predictable inputs and outputs.
• Vector and web search flows that coordinate planning, execution, and reporting.
• Reusable text agents for summarization and translation tasks.

Installation

Install the package directly from PyPI to reuse it across projects:

pip install openai-sdk-helpers

Type information ships with the published wheel via py.typed, so external projects can rely on the bundled annotations without adding custom stubs.

For local development, install with editable sources and the optional dev dependencies:

pip install -e .
pip install -e . --group dev

Quickstart

Create a basic vector search workflow by wiring your own prompt templates and preferred model configuration:

from pathlib import Path

from openai_sdk_helpers.agent.vector_search import VectorSearch


prompts = Path("./prompts")
vector_search = VectorSearch(prompt_dir=prompts, default_model="gpt-4o-mini")

report = vector_search.run_agent_sync("Explain quantum entanglement for beginners")
print(report.report)

Text utilities

Use the built-in text helpers when you need lightweight single-step agents.

from openai_sdk_helpers.agent import (
    SummarizerAgent,
    TranslatorAgent,
    ValidatorAgent,
)


summarizer = SummarizerAgent(default_model="gpt-4o-mini")
translator = TranslatorAgent(default_model="gpt-4o-mini")
validator = ValidatorAgent(default_model="gpt-4o-mini")

summary = summarizer.run_sync("Long-form content to condense")
translation = translator.run_sync("Bonjour", target_language="English")
guardrails = validator.run_sync(
    "Share meeting notes with names removed", agent_output=summary.text
)

Prompt templates are optional for the built-in text helpers. They already ship with defaults under src/openai_sdk_helpers/prompt, so you do not need to create placeholder files when installing from PyPI. Only pass a prompt_dir when you have real replacements you want to load.

The vector search workflow expects real prompts for each agent (for example, vector_planner.jinja, vector_search.jinja, and vector_writer.jinja). If you point prompt_dir at a folder that does not contain those files, agent construction fails with a FileNotFoundError. Skip prompt_dir entirely unless you have working templates ready.

Centralized OpenAI configuration

openai-sdk-helpers ships with a lightweight OpenAISettings helper so projects can share consistent authentication, routing, and model defaults when using the OpenAI SDK:

from openai_sdk_helpers import OpenAISettings


# Load from environment variables or a local .env file
settings = OpenAISettings.from_env()
client = settings.create_client()

# Reuse the default model across agents
vector_search = VectorSearch(
    prompt_dir=prompts, default_model=settings.default_model or "gpt-4o-mini"
)

The helper reads OPENAI_API_KEY, OPENAI_ORG_ID, OPENAI_PROJECT_ID, OPENAI_BASE_URL, OPENAI_MODEL, OPENAI_TIMEOUT, and OPENAI_MAX_RETRIES by default but supports overrides for custom deployments. Pass uncommon OpenAI client keyword arguments (such as default_headers, http_client, or base_url proxies) through extra_client_kwargs when instantiating OpenAISettings.

Development

The repository is configured for a lightweight Python development workflow. Before opening a pull request, format and validate your changes locally:

# Style and formatting
pydocstyle src
black --check .

# Static type checking
pyright src

# Unit tests with coverage
pytest -q --cov=src --cov-report=term-missing --cov-fail-under=70

Project Structure

• src/openai_sdk_helpers/agent: Agent factories, orchestration helpers, and search workflows.
• src/openai_sdk_helpers/prompt: Prompt rendering utilities backed by Jinja.
• src/openai_sdk_helpers/response: Response parsing and transformation helpers.
• src/openai_sdk_helpers/structure: Typed data structures shared across workflows.
• src/openai_sdk_helpers/vector_storage: Minimal vector store abstraction.
• tests/: Unit tests covering core modules and structures.

Key modules

The package centers around a handful of cohesive building blocks:

• openai_sdk_helpers.agent.project_manager.ProjectManager coordinates prompt creation, plan building, task execution, and summarization while persisting intermediate artifacts to disk.
• openai_sdk_helpers.agent.vector_search.VectorSearch bundles the planners, executors, and summarizers required to run a multi-turn vector search flow from a single entry point.
• openai_sdk_helpers.agent.summarizer.SummarizerAgent, agent.translator.TranslatorAgent, and agent.validator.ValidatorAgent expose streamlined text-processing utilities that reuse shared prompt templates.
• openai_sdk_helpers.response contains the response runners and helpers used to normalize outputs from agents, including streaming responses.
• openai_sdk_helpers.utils holds JSON serialization helpers, logging utilities, and common validation helpers used across modules.

Contributing

Contributions are welcome! Please accompany functional changes with relevant tests and ensure all quality gates pass. Follow the NumPy-style docstring conventions outlined in AGENTS.md to keep the codebase consistent.