From ed8533f80a8419caf16c4299adc1cb44a9bb0fa3 Mon Sep 17 00:00:00 2001 From: Abhijeet Prasad Date: Thu, 5 Jun 2025 11:59:55 -0400 Subject: [PATCH 1/2] feat: Document input/output options for vercel ai integration --- .../configuration/integrations/vercelai.mdx | 41 ++++++++++++++++++- 1 file changed, 39 insertions(+), 2 deletions(-) diff --git a/docs/platforms/javascript/common/configuration/integrations/vercelai.mdx b/docs/platforms/javascript/common/configuration/integrations/vercelai.mdx index 533505b14f672..bfb4ec41206e1 100644 --- a/docs/platforms/javascript/common/configuration/integrations/vercelai.mdx +++ b/docs/platforms/javascript/common/configuration/integrations/vercelai.mdx @@ -46,7 +46,44 @@ To enhance the spans collected by this integration, we recommend providing a `fu ```javascript const result = await generateText({ model: openai("gpt-4-turbo"), - experimental_telemetry: { functionId: "my-awesome-function" }, + experimental_telemetry: { + isEnabled: true, + functionId: "my-awesome-function", + }, +}); +``` + +## Options + +### `recordInputs` + +Requires SDK version `9.27.0` or higher. + +_Type: `boolean`_ + +Records inputs to the ai function call. + +Defaults to `true` if `sendDefaultPii` is `true` or if you explicitly set `experimental_telemetry.isEnabled` to `true` in your `ai` function callsites. + +```javascript +Sentry.init({ + integrations: [Sentry.vercelAIIntegration({ recordInputs: true })], +}); +``` + +### `recordOutputs` + +Requires SDK version `9.27.0` or higher. + +_Type: `boolean`_ + +Records outputs to the ai function call. + +Defaults to `true` if `sendDefaultPii` is `true` or if you explicitly set `experimental_telemetry.isEnabled` to `true` in your `ai` function callsites. + +```javascript +Sentry.init({ + integrations: [Sentry.vercelAIIntegration({ recordOutputs: true })], }); ``` @@ -61,7 +98,7 @@ const result = await generateText({ }); ``` -If you want to collect inputs and outputs for a specific call, you must specifically opt-in to each function call by setting `experimental_telemetry.recordInputs` and `experimental_telemetry.recordOutputs` to `true`. +If you set `experimental_telemetry.recordInputs` and `experimental_telemetry.recordOutputs` it will override the default behavior of collecting inputs and outputs for that function call. ```javascript const result = await generateText({ From 05ba40548c0a50e658f8d9673257ae29c7e96440 Mon Sep 17 00:00:00 2001 From: Abhijeet Prasad Date: Fri, 6 Jun 2025 11:42:25 -0400 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: Lukas Stracke --- .../javascript/common/configuration/integrations/vercelai.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/platforms/javascript/common/configuration/integrations/vercelai.mdx b/docs/platforms/javascript/common/configuration/integrations/vercelai.mdx index bfb4ec41206e1..39dd1fb478df0 100644 --- a/docs/platforms/javascript/common/configuration/integrations/vercelai.mdx +++ b/docs/platforms/javascript/common/configuration/integrations/vercelai.mdx @@ -61,7 +61,7 @@ Requires SDK version `9.27.0` or higher. _Type: `boolean`_ -Records inputs to the ai function call. +Records inputs to the `ai` function call. Defaults to `true` if `sendDefaultPii` is `true` or if you explicitly set `experimental_telemetry.isEnabled` to `true` in your `ai` function callsites. @@ -77,7 +77,7 @@ Requires SDK version `9.27.0` or higher. _Type: `boolean`_ -Records outputs to the ai function call. +Records outputs to the `ai` function call. Defaults to `true` if `sendDefaultPii` is `true` or if you explicitly set `experimental_telemetry.isEnabled` to `true` in your `ai` function callsites.