-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Add OpenAI docs #9376
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.
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
Merged
Merged
Add OpenAI docs #9376
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
5616626
Add OpenAI docs
colin-sentry 0cb4517
Change semantics of "send or do not send prompts"
colin-sentry c61ad24
Added OpenAI integration to the list of integrations
antonpirker 8cf92fe
openai is auto enabled
antonpirker a077732
Update docs/platforms/python/integrations/openai/index.mdx
colin-sentry fb81708
Update docs/platforms/python/integrations/openai/index.mdx
colin-sentry 76a2a57
Update index.mdx
colin-sentry File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,99 @@ | ||
--- | ||
title: OpenAI | ||
description: "Learn about using Sentry for OpenAI." | ||
--- | ||
|
||
This integration connects Sentry with the [OpenAI Python SDK](https://github.com/openai/openai-python). | ||
The integration has been confirmed to work with OpenAI 1.13.3. | ||
|
||
## Install | ||
|
||
Install `sentry-sdk` from PyPI with the `openai` extra: | ||
|
||
```bash | ||
pip install --upgrade 'sentry-sdk[openai]' | ||
``` | ||
|
||
## Configure | ||
|
||
If you have the `openai` package in your dependencies, the OpenAI integration will be enabled automatically when you initialize the Sentry SDK. | ||
|
||
An additional dependency, `tiktoken`, is required if you want to calculate token usage for streaming chat responses. | ||
|
||
<SignInNote /> | ||
|
||
```python | ||
from openai import OpenAI | ||
|
||
import sentry_sdk | ||
|
||
sentry_sdk.init( | ||
dsn="___PUBLIC_DSN___", | ||
enable_tracing=True, | ||
traces_sample_rate=1.0, | ||
) | ||
|
||
client = OpenAI() | ||
``` | ||
|
||
## Verify | ||
|
||
Verify that the integration works by inducing an error. The error and performance transaction should appear in your Sentry project. | ||
```python | ||
from openai import OpenAI | ||
import sentry_sdk | ||
|
||
sentry_sdk.init(...) # same as above | ||
|
||
client = OpenAI(api_key="a bad API key") | ||
with sentry_sdk.start_transaction(op="ai-inference", name="The result of the AI inference"): | ||
response = ( | ||
client.chat.completions.create( | ||
model="some-model", messages=[{"role": "system", "content": "hello"}] | ||
) | ||
.choices[0] | ||
.message.content | ||
) | ||
print(response) | ||
``` | ||
|
||
After running this script, a transaction will be created in the Performance section of [sentry.io](https://sentry.io). Additionally, an error event (about the bad API key) will be sent to [sentry.io](https://sentry.io) and will be connected to the transaction. | ||
|
||
It takes a couple of moments for the data to appear in [sentry.io](https://sentry.io). | ||
|
||
## Behavior | ||
|
||
- The OpenAI integration will connect Sentry with all supported OpenAI methods automatically. | ||
|
||
- All exceptions leading to an OpenAIException are reported. | ||
|
||
- The supported modules are currently `chat.completions.create` and `embeddings.create`. | ||
|
||
- Sentry is configured not to consider LLM and tokenizer inputs/outputs as PII. If you want to include them, set `send_default_pii=True` in the `sentry_sdk.init()` call. To explicitly exclude prompts despite `send_default_pii=True`, configure the integration with `include_prompts=False` like in the Options section. | ||
|
||
## Options | ||
|
||
By adding `OpenAIIntegration` to your `sentry_sdk.init()` call explicitly, you can set options for `OpenAIIntegration` to change its behavior: | ||
|
||
```python | ||
import sentry_sdk | ||
from sentry_sdk.integrations.openai import OpenAIIntegration | ||
|
||
sentry_sdk.init( | ||
dsn="___PUBLIC_DSN___", | ||
enable_tracing=True, | ||
send_default_pii=True, | ||
traces_sample_rate=1.0, | ||
integrations = [ | ||
OpenAIIntegration( | ||
include_prompts=False, # LLM/tokenizer inputs/outputs will be not sent to Sentry, despite send_default_pii=True | ||
), | ||
], | ||
) | ||
``` | ||
|
||
## Supported Versions | ||
|
||
- OpenAI: 1.0+ | ||
- tiktoken: 0.6.0+ | ||
- Python: 3.9+ |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.