feat (provider/google): add promptFeedback outputs

.changeset/poor-clouds-eat.md

@@ -0,0 +1,5 @@
+---
+'@ai-sdk/google': patch
+---
+
+feat (provider/google): add promptFeedback outputs

examples/ai-core/src/generate-text/google.ts

@@ -8,9 +8,15 @@ async function main() {
     prompt: 'Invent a new holiday and describe its traditions.',
   });
 
+  const googleMetadata = result.experimental_providerMetadata?.google;
+
   console.log(result.text);
   console.log();
   console.log('Token usage:', result.usage);
+  console.log('Safety info:', {
+    promptFeedback: googleMetadata?.promptFeedback,
+    safetyRatings: googleMetadata?.safetyRatings,
+  });
   console.log('Finish reason:', result.finishReason);
 }
 

examples/ai-core/src/stream-text/google.ts

@@ -13,8 +13,14 @@ async function main() {
     process.stdout.write(textPart);
   }
 
+  const googleMetadata = (await result.experimental_providerMetadata)?.google;
+
   console.log();
   console.log('Token usage:', await result.usage);
+  console.log('Safety info:', {
+    promptFeedback: googleMetadata?.promptFeedback,
+    safetyRatings: googleMetadata?.safetyRatings,
+  });
   console.log('Finish reason:', await result.finishReason);
 }
 

packages/google/src/google-generative-ai-language-model.test.ts

@@ -798,6 +798,42 @@ describe('doGenerate', () => {
     ),
   );
 
+  it(
+    'should expose PromptFeedback in provider metadata',
+    withTestServer(
+      {
+        url: 'https://generativelanguage.googleapis.com/v1beta/models/gemini-pro:generateContent',
+        type: 'json-value',
+        content: {
+          candidates: [
+            {
+              content: { parts: [{ text: 'No' }], role: 'model' },
+              finishReason: 'SAFETY',
+              index: 0,
+              safetyRatings: SAFETY_RATINGS,
+            },
+          ],
+          promptFeedback: {
+            blockReason: 'SAFETY',
+            safetyRatings: SAFETY_RATINGS,
+          },
+        },
+      },
+      async () => {
+        const { providerMetadata } = await model.doGenerate({
+          inputFormat: 'prompt',
+          mode: { type: 'regular' },
+          prompt: TEST_PROMPT,
+        });
+
+        expect(providerMetadata?.google.promptFeedback).toStrictEqual({
+          blockReason: 'SAFETY',
+          safetyRatings: SAFETY_RATINGS,
+        });
+      },
+    ),
+  );
+
   it(
     'should expose grounding metadata in provider metadata',
     withTestServer(
@@ -1086,6 +1122,7 @@ describe('doStream', () => {
             providerMetadata: {
               google: {
                 groundingMetadata: null,
+                promptFeedback: null,
                 safetyRatings: [
                   {
                     category: 'HARM_CATEGORY_SEXUALLY_EXPLICIT',
@@ -1260,6 +1297,7 @@ describe('doStream', () => {
             providerMetadata: {
               google: {
                 groundingMetadata: null,
+                promptFeedback: null,
                 safetyRatings: [
                   {
                     category: 'HARM_CATEGORY_SEXUALLY_EXPLICIT',
@@ -1326,6 +1364,43 @@ describe('doStream', () => {
       },
     ),
   );
+
+  it(
+    'should expose PromptFeedback in provider metadata on finish',
+    withTestServer(
+      {
+        url: 'https://generativelanguage.googleapis.com/v1beta/models/gemini-pro:streamGenerateContent',
+        type: 'stream-values',
+        content: [
+          `data: {"candidates": [{"content": {"parts": [{"text": "No"}],"role": "model"},` +
+            `"finishReason": "PROHIBITED_CONTENT","index": 0}],` +
+            `"promptFeedback": {"blockReason": "PROHIBITED_CONTENT","safetyRatings": [` +
+            `{"category": "HARM_CATEGORY_SEXUALLY_EXPLICIT","probability": "NEGLIGIBLE"},` +
+            `{"category": "HARM_CATEGORY_HATE_SPEECH","probability": "NEGLIGIBLE"},` +
+            `{"category": "HARM_CATEGORY_HARASSMENT","probability": "NEGLIGIBLE"},` +
+            `{"category": "HARM_CATEGORY_DANGEROUS_CONTENT","probability": "NEGLIGIBLE"}]}}\n\n`,
+        ],
+      },
+      async () => {
+        const { stream } = await model.doStream({
+          inputFormat: 'prompt',
+          mode: { type: 'regular' },
+          prompt: TEST_PROMPT,
+        });
+
+        const events = await convertReadableStreamToArray(stream);
+        const finishEvent = events.find(event => event.type === 'finish');
+
+        expect(
+          finishEvent?.type === 'finish' &&
+            finishEvent.providerMetadata?.google.promptFeedback,
+        ).toStrictEqual({
+          blockReason: 'PROHIBITED_CONTENT',
+          safetyRatings: SAFETY_RATINGS,
+        });
+      },
+    ),
+  );
   describe('search tool selection', () => {
     const provider = createGoogleGenerativeAI({
       apiKey: 'test-api-key',

packages/google/src/google-generative-ai-language-model.ts

@@ -248,6 +248,7 @@ export class GoogleGenerativeAILanguageModel implements LanguageModelV1 {
       warnings,
       providerMetadata: {
         google: {
+          promptFeedback: response.promptFeedback ?? null,
           groundingMetadata: candidate.groundingMetadata ?? null,
           safetyRatings: candidate.safetyRatings ?? null,
         },
@@ -330,6 +331,7 @@ export class GoogleGenerativeAILanguageModel implements LanguageModelV1 {
 
               providerMetadata = {
                 google: {
+                  promptFeedback: value.promptFeedback ?? null,
                   groundingMetadata: candidate.groundingMetadata ?? null,
                   safetyRatings: candidate.safetyRatings ?? null,
                 },
@@ -521,6 +523,12 @@ const responseSchema = z.object({
       groundingMetadata: groundingMetadataSchema.nullish(),
     }),
   ),
+  promptFeedback: z
+    .object({
+      blockReason: z.string().nullish(),
+      safetyRatings: z.array(safetyRatingSchema).nullish(),
+    })
+    .nullish(),
   usageMetadata: z
     .object({
       promptTokenCount: z.number().nullish(),
@@ -543,6 +551,12 @@ const chunkSchema = z.object({
       }),
     )
     .nullish(),
+  promptFeedback: z
+    .object({
+      blockReason: z.string().nullish(),
+      safetyRatings: z.array(safetyRatingSchema).nullish(),
+    })
+    .nullish(),
   usageMetadata: z
     .object({
       promptTokenCount: z.number().nullish(),