Skip to content

OpenAI Responses and Compaction APIs #4042

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
iamemilio wants to merge 6 commits into
base: main
Choose a base branch
from
+14,910 −3,045
Draft

OpenAI Responses and Compaction APIs #4042

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
762fb1a
OpenAI Responses and Compaction APIs
iamemilio Dec 17, 2025
f5d746f
test: responses API gracefully handles None input
iamemilio Dec 17, 2025
d87745d
fix: OpenAI Types Normalized with Cast
iamemilio Dec 17, 2025
456aafc
openaiv2: clarify streaming contract and test corner cases
iamemilio Dec 18, 2025
8913d11
openai_v2: improve readability of responses.py
iamemilio Dec 18, 2025
af4f76a
openai_v2: move responses wrappers into patch.py
iamemilio Dec 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion instrumentation-genai/opentelemetry-instrumentation-openai-v2/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,10 @@ classifiers = [
"Programming Language :: Python :: 3.13",
]
dependencies = [
"openai>=1.109.1",
Copy link
Contributor

@xrmx xrmx Dec 19, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why? If it is the first version having Responses the instrumentation should continue to work with older versions.

"opentelemetry-api ~= 1.37",
"opentelemetry-instrumentation ~= 0.58b0",
"opentelemetry-semantic-conventions ~= 0.58b0"
"opentelemetry-semantic-conventions ~= 0.58b0",
]

[project.optional-dependencies]
Expand Down
63 changes: 57 additions & 6 deletions ...lemetry-instrumentation-openai-v2/src/opentelemetry/instrumentation/openai_v2/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
---
"""

import importlib
from typing import Collection

from wrapt import wrap_function_wrapper
Expand All @@ -59,6 +60,10 @@
async_embeddings_create,
chat_completions_create,
embeddings_create,
async_responses_compact,
async_responses_create,
responses_compact,
responses_create,
)


Expand Down Expand Up @@ -128,10 +133,56 @@ def _instrument(self, **kwargs):
),
)

def _uninstrument(self, **kwargs):
import openai # pylint: disable=import-outside-toplevel # noqa: PLC0415
# Add instrumentation for the Responses API
wrap_function_wrapper(
module="openai.resources.responses",
name="Responses.create",
wrapper=responses_create(
tracer, logger, instruments, is_content_enabled()
),
)

wrap_function_wrapper(
module="openai.resources.responses",
name="AsyncResponses.create",
wrapper=async_responses_create(
tracer, logger, instruments, is_content_enabled()
),
)

# `Responses.compact` was added later in openai-python; guard so older
# supported versions don't fail instrumentation.
try:
wrap_function_wrapper(
module="openai.resources.responses",
name="Responses.compact",
wrapper=responses_compact(
tracer, logger, instruments, is_content_enabled()
),
)
wrap_function_wrapper(
module="openai.resources.responses",
name="AsyncResponses.compact",
wrapper=async_responses_compact(
tracer, logger, instruments, is_content_enabled()
),
)
except AttributeError:
pass

unwrap(openai.resources.chat.completions.Completions, "create")
unwrap(openai.resources.chat.completions.AsyncCompletions, "create")
unwrap(openai.resources.embeddings.Embeddings, "create")
unwrap(openai.resources.embeddings.AsyncEmbeddings, "create")
def _uninstrument(self, **kwargs):
chat_mod = importlib.import_module("openai.resources.chat.completions")
unwrap(chat_mod.Completions, "create")
Copy link
Contributor

@xrmx xrmx Dec 19, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

unwrap takes also strings as the wrap functions, you shouldn't need the importlib usage

unwrap(chat_mod.AsyncCompletions, "create")

embeddings_mod = importlib.import_module("openai.resources.embeddings")
unwrap(embeddings_mod.Embeddings, "create")
unwrap(embeddings_mod.AsyncEmbeddings, "create")

responses_mod = importlib.import_module("openai.resources.responses")
unwrap(responses_mod.Responses, "create")
unwrap(responses_mod.AsyncResponses, "create")
if hasattr(responses_mod.Responses, "compact"):
unwrap(responses_mod.Responses, "compact")
if hasattr(responses_mod.AsyncResponses, "compact"):
unwrap(responses_mod.AsyncResponses, "compact")
Loading