fix(openai_agents): Fixed the completion issue

[adharshctr]

BEFORE

AFTER

• I have added tests that cover my changes.
• If adding a new instrumentation or changing an existing one, I've added screenshots from some observability platform showing the change.
• PR name follows conventional commits format: feat(instrumentation): ... or fix(instrumentation): ....
• (If applicable) I have updated the documentation accordingly.

---

Important

Fixes attribute setting for output messages in set_response_content_span_attribute() and updates tests accordingly.

• Behavior:
  • Fixes attribute setting in set_response_content_span_attribute() in __init__.py to handle each output message individually.
  • Updates test_agent_spans() in test_openai_agents.py to check for individual message attributes.
• Tests:
  • Modifies assertions in test_agent_spans() to verify new attribute structure.
  • Ensures tests cover role, type, and content attributes for each message.
• Misc:
  • Adds screenshots to PR description for before and after changes.

^{This description was created by for 850fc89. You can customize this summary. It will automatically update as commits are pushed.}

Summary by CodeRabbit

• Refactor

  • Enhanced response tracking by providing detailed, indexed information for each message and its content.

• Tests

  • Updated tests to verify the new detailed attribute structure for message information.

• Documentation

  • Added OpenAI Agents to the list of supported frameworks for instrumentation.

[coderabbitai]

Walkthrough

The logic for setting span attributes in response handling was refactored to use granular, indexed keys per message and content part, instead of aggregating values into lists. Corresponding test assertions were updated to verify the new indexed attribute keys, replacing checks on plural, aggregated attributes. Additionally, the README was updated to include "OpenAI Agents" as a newly supported instrumentation framework.

Changes

Files	Change Summary
.../openai_agents/init.py	Refactored set_response_content_span_attribute to set indexed span attributes for roles, types, and content per message, instead of aggregated lists.
.../tests/test_openai_agents.py	Updated test assertions to check for the new indexed attribute keys (e.g., .0.role, .0.type, .0.content).
README.md	Added "OpenAI Agents" to the list of instrumented frameworks with a link to its documentation.

Poem

In the garden of code, a change took root,
No more lists of roles in a single attribute suit!
Each message now shines with its own little key,
Indexed and tidy, as clear as can be.
The tests all agree, with a hop and a cheer—
“Granular details are finally here!”
🥕

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6ab4083 and 1097ce7.

📒 Files selected for processing (1)

• README.md (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• README.md

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (6)

• GitHub Check: Test Packages (3.9)
• GitHub Check: Test Packages (3.10)
• GitHub Check: Test Packages (3.11)
• GitHub Check: Test Packages (3.12)
• GitHub Check: Lint
• GitHub Check: Build Packages (3.11)

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[ellipsis-dev]

Caution

Changes requested ❌

Reviewed everything up to 850fc89 in 1 minute and 46 seconds. Click for details.

• Reviewed 112 lines of code in 2 files
• Skipped 0 files when reviewing.
• Skipped posting 1 draft comments. View those below.
• Modify your settings and rules to customize what types of comments Ellipsis leaves. And don't forget to react with 👍 or 👎 to teach Ellipsis.

1. packages/opentelemetry-instrumentation-openai-agents/tests/test_openai_agents.py:67

• Draft comment:
  Test assertions have been updated to check for indexed attribute keys (e.g. '.0.content', '.0.role', '.0.type') instead of aggregated lists. Ensure that this new naming convention is compatible with downstream consumers.
• Reason this comment was not posted:
  Comment did not seem useful. Confidence is useful = 0% <= threshold 50% The comment is asking the PR author to ensure compatibility with downstream consumers, which violates the rule against asking the author to ensure behavior is intended or tested. It doesn't provide a specific suggestion or ask for a specific test to be written.

Workflow ID: wflow_sU5NgRTMfTvpe4e3

^{You can customize by changing your verbosity settings, reacting with 👍 or 👎, replying to comments, or adding code review rules.}