ref(docs): Restructure OpenAI integration documentation #16044
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
| ## Configuration | ||
|
|
||
| By default this integration adds tracing support to OpenAI API method calls including: | ||
| By default, tracing support is added to the following OpenAI API method calls: |
There was a problem hiding this comment.
updated this to be abstract as it can either be an integration or helper
| This integration is **enabled by default for Node.js-based platforms** and automatically captures spans for OpenAI API method calls. You don't need to add it to your `integrations` array in `Sentry.init` unless you want to configure input and output recording with the `recordInputs` and `recordOutputs` options: | ||
|
|
||
| ```javascript | ||
| Sentry.init({ | ||
| dsn: "____PUBLIC_DSN____", | ||
| tracesSampleRate: 1.0, | ||
| integrations: [ | ||
| // This integration is enabled by default. | ||
| // Only add this if you want to configure options. | ||
| Sentry.openAIIntegration({ | ||
| recordInputs: true, | ||
| recordOutputs: true, | ||
| }), | ||
| ], | ||
| }); | ||
| ``` |
There was a problem hiding this comment.
If this integration is enabled by default, we should give that instruction at the base level, and only give the instructions for options under the subheading. This paragraph also doesn't really tell me what "configuring input and output recording" does for me, so it feels a bit vague right now
There was a problem hiding this comment.
I moved the Options and code snippet under Configuration and the a couple of other things. An image says more than a thousand words:
What do you think?
|
@RulaKhaled I noticed that we do not have a separate section about Runtime for NextJS + OpenAI. should we add something? https://docs.sentry.io/platforms/javascript/guides/nextjs/configuration/integrations/openai/ |
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
closes https://linear.app/getsentry/issue/TET-1719/browser-javascript-ai-agent-onboarding