Skip to content
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

Jump to bottom

OpenAI instrumentation docs fixes #2988

Open
wants to merge 13 commits into
base: main
Choose a base branch
from
Open

OpenAI instrumentation docs fixes #2988

wants to merge 13 commits into from

Conversation

lmolkova
Copy link
Contributor

@lmolkova lmolkova commented Nov 9, 2024 •
edited
Loading

@lmolkova lmolkova requested a review from a team as a code owner November 9, 2024 02:06
@lmolkova lmolkova mentioned this pull request Nov 9, 2024
Open
3 tasks
@alizenhom alizenhom mentioned this pull request Nov 9, 2024
Merged
8 tasks
@lmolkova lmolkova mentioned this pull request Nov 10, 2024
Open
gyliu513
gyliu513 reviewed Nov 11, 2024
View reviewed changes
instrumentation-genai/opentelemetry-instrumentation-openai-v2/README.rst Outdated
*************************

When using the instrumentor, all clients will automatically trace OpenAI chat completion operations
and capture prompts and completions as events.
Copy link
Member

Choose a reason for hiding this comment

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

This only happens when OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT is set as true, right? Can we highlight the parameter here as well?

Copy link

@dasiths dasiths Nov 12, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Might be worthwhile putting the example (json) format of the content shape that is emitted.

Also might be worth stating that if doing this you may have to configure your pipeline to redact any sensitive info contained in the content.

Copy link
Contributor Author

@lmolkova lmolkova Nov 21, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

All examples can be found in semantic conventions - https://github.com/open-telemetry/semantic-conventions/blob/main/docs/gen-ai/gen-ai-events.md and it'd be hard to keep them in sync if we duplicate.

I don't think we should have a redaction example specific to OpenAI instrumentation.

@lzchen lzchen added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Nov 12, 2024
@lmolkova lmolkova force-pushed the openai-docs-fixes branch 2 times, most recently from 2299149 to 26c92b5 Compare November 21, 2024 04:26
lzchen
lzchen requested changes Nov 21, 2024
View reviewed changes
Copy link
Contributor

@lzchen lzchen left a comment

Choose a reason for hiding this comment

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

Some additional comments.

@lmolkova lmolkova mentioned this pull request Nov 22, 2024
Open
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dasiths dasiths dasiths approved these changes

@gyliu513 gyliu513 gyliu513 left review comments

@codefromthecrypt codefromthecrypt codefromthecrypt left review comments

@alizenhom alizenhom alizenhom approved these changes

@karthikscale3 karthikscale3 karthikscale3 approved these changes

@lzchen lzchen lzchen approved these changes

@nirga nirga Awaiting requested review from nirga

Assignees

@codefromthecrypt codefromthecrypt

@lmolkova lmolkova

@nirga nirga

@gyliu513 gyliu513

@lzchen lzchen

@karthikscale3 karthikscale3

Labels
Skip Changelog PRs that do not require a CHANGELOG.md entry
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
8 participants
@lmolkova @codefromthecrypt @gyliu513 @lzchen @dasiths @karthikscale3 @alizenhom @nirga