fix (provider/openai): send sources action as include (#8559)

## Background

`web_search_call.action.sources` was not sent to the OpenAI API.

## Summary

* check if tool is `web_search` or `web_search_preview` and use correct
name in tool calls and results
* automatically add `web_search_call.action.sources` include when either
web search tool is present
* remove redundant tests

## Manual Verification

- [x] run `examples/ai-core/src/generate-text/openai-web-search-tool.ts`

## Tasks

- [x] add include flag automatically
- [x] investigate why there are no tool calls / results in the generate
case
- [x] update generate test (outputs, check flag)
- [x] add easy way to record raw chunks and use them in tests
- [x] investigate why stream does not send sources
- [x] update stream test (outputs, check flag)
- [x] update examples
- [x] changeset

## Related Issues

Closes #8528

Author: lgrammel

.changeset/eighty-buses-raise.md

@@ -0,0 +1,5 @@
+---
+'@ai-sdk/openai': patch
+---
+
+fix (provider/openai): send sources action as include

examples/ai-core/src/generate-text/openai-web-search-tool.ts

@@ -1,10 +1,10 @@
 import { openai } from '@ai-sdk/openai';
 import { generateText } from 'ai';
-import 'dotenv/config';
+import { run } from '../lib/run';
 
-async function main() {
+run(async () => {
   const result = await generateText({
-    model: openai.responses('gpt-5'),
+    model: openai.responses('gpt-5-mini'),
     prompt: 'What happened in tech news today?',
     tools: {
       web_search: openai.tools.webSearch({
@@ -13,13 +13,9 @@ async function main() {
     },
   });
 
-  for (const toolCall of result.toolCalls) {
-    if (toolCall.toolName === 'web_search') {
-      console.log('Search query:', toolCall.input);
-    }
-  }
-
+  console.dir(result.response.body, { depth: Infinity });
+  console.dir(result.toolCalls, { depth: Infinity });
+  console.dir(result.toolResults, { depth: Infinity });
+  console.dir(result.sources, { depth: Infinity });
   console.log(result.text);
-}
-
-main().catch(console.error);
+});

examples/ai-core/src/lib/save-raw-chunks.ts

@@ -0,0 +1,22 @@
+import { StreamTextResult } from 'ai';
+import fs from 'fs';
+
+export async function saveRawChunks({
+  result,
+  filename,
+}: {
+  result: StreamTextResult<any, any>;
+  filename: string;
+}) {
+  const rawChunks: unknown[] = [];
+  for await (const chunk of result.fullStream) {
+    if (chunk.type === 'raw') {
+      rawChunks.push(chunk.rawValue);
+    }
+  }
+
+  fs.writeFileSync(
+    filename,
+    rawChunks.map(chunk => JSON.stringify(chunk)).join('\n'),
+  );
+}

examples/ai-core/src/stream-text/openai-web-search-tool.ts

@@ -1,17 +1,16 @@
 import { openai } from '@ai-sdk/openai';
-import { stepCountIs, streamText } from 'ai';
-import 'dotenv/config';
+import { streamText } from 'ai';
+import { run } from '../lib/run';
 
-async function main() {
+run(async () => {
   const result = streamText({
-    model: openai.responses('gpt-4o-mini'),
+    model: openai.responses('gpt-5-mini'),
+    prompt: 'What happened in tech news today?',
     tools: {
       web_search: openai.tools.webSearch({
-        searchContextSize: 'high',
+        searchContextSize: 'medium',
       }),
     },
-    prompt: 'Look up the company that owns Sonny Angel',
-    stopWhen: stepCountIs(5), // note: should stop after a single step
   });
 
   for await (const chunk of result.fullStream) {
@@ -22,36 +21,30 @@ async function main() {
       }
 
       case 'tool-call': {
-        console.log('Tool call:', JSON.stringify(chunk, null, 2));
+        console.log(
+          `\x1b[32m\x1b[1mTool call:\x1b[22m ${JSON.stringify(chunk, null, 2)}\x1b[0m`,
+        );
         break;
       }
 
       case 'tool-result': {
-        console.log('Tool result:', JSON.stringify(chunk, null, 2));
+        console.log(
+          `\x1b[32m\x1b[1mTool result:\x1b[22m ${JSON.stringify(chunk, null, 2)}\x1b[0m`,
+        );
         break;
       }
 
       case 'source': {
         if (chunk.sourceType === 'url') {
-          process.stdout.write(`\n\n Source: ${chunk.title} (${chunk.url})`);
-        } else {
-          process.stdout.write(`\n\n Document: ${chunk.title}`);
+          process.stdout.write(
+            `\n\n\x1b[36mSource: ${chunk.title} (${chunk.url})\x1b[0m\n\n`,
+          );
         }
         break;
       }
 
-      case 'finish-step': {
-        console.log();
-        console.log();
-        console.log('STEP FINISH');
-        console.log('Finish reason:', chunk.finishReason);
-        console.log('Usage:', chunk.usage);
-        console.log();
-        break;
-      }
-
       case 'finish': {
-        console.log('FINISH');
+        console.log('\n\nFINISH');
         console.log('Finish reason:', chunk.finishReason);
         console.log('Total Usage:', chunk.totalUsage);
         break;
@@ -62,6 +55,4 @@ async function main() {
         break;
     }
   }
-}
-
-main().catch(console.error);
+});

packages/openai/src/responses/openai-responses-api-types.ts

@@ -13,6 +13,19 @@ export type OpenAIResponsesMessage =
   | OpenAIFileSearchCall
   | OpenAIResponsesReasoning;
 
+export type OpenAIResponsesIncludeOptions =
+  | Array<
+      | 'web_search_call.action.sources'
+      | 'code_interpreter_call.outputs'
+      | 'computer_call_output.output.image_url'
+      | 'file_search_call.results'
+      | 'message.input_image.image_url'
+      | 'message.output_text.logprobs'
+      | 'reasoning.encrypted_content'
+    >
+  | undefined
+  | null;
+
 export type OpenAIResponsesSystemMessage = {
   role: 'system' | 'developer';
   content: string;