README.md

🧪🤖 openai-responses

Pytest plugin for automatically mocking OpenAI requests. Powered by RESPX.

Supported Endpoints

• Chat
• Embeddings
• Files
• Models
• Moderations
• Assistants
• Threads
• Messages
• Runs
• Run Steps
• Vector Stores
• Vector Store Files
• Vector Store File Batches

View full support coverage here.

Tip

✨ Support for creating streaming responses added in v0.4

Usage

Just decorate any test function that makes a call to the OpenAI API (either using openai-python or with HTTPX).

import openai

import openai_responses


@openai_responses.mock()
def test_create_assistant():
    client = openai.Client(api_key="sk-fake123")

    assistant = client.beta.assistants.create(
        instructions="You are a personal math tutor.",
        name="Math Tutor",
        tools=[{"type": "code_interpreter"}],
        model="gpt-4-turbo",
    )

    assert assistant.name == "Math Tutor"

See examples or docs for more.

Installation

Available on PyPI

pip install openai-responses

Documentation

See the documentation site for more info.

License

See LICENSE for more info.

Contributing

See CONTRIBUTING.md for info on PRs, issues, and feature requests.

Changelog

See CHANGELOG.md for summarized notes on changes or view releases for more details information on changes.