@openai/agents-extensions 0.0.16 → 0.1.0

package/dist/aiSdk.js

@@ -1,14 +1,22 @@
-import { createGenerationSpan, resetCurrentSpan, setCurrentSpan, Usage, UserError, withGenerationSpan, getLogger, } from '@openai/agents';
-import { isZodObject } from '@openai/agents/utils';
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AiSdkModel = void 0;
+exports.itemsToLanguageV2Messages = itemsToLanguageV2Messages;
+exports.toolToLanguageV2Tool = toolToLanguageV2Tool;
+exports.getResponseFormat = getResponseFormat;
+exports.aisdk = aisdk;
+exports.parseArguments = parseArguments;
+const agents_1 = require("@openai/agents");
+const utils_1 = require("@openai/agents/utils");
 /**
  * @internal
- * Converts a list of model items to a list of language model v1 messages.
+ * Converts a list of model items to a list of language model V2 messages.
  *
  * @param model - The model to use.
  * @param items - The items to convert.
- * @returns The list of language model v1 messages.
+ * @returns The list of language model V2 messages.
  */
-export function itemsToLanguageV1Messages(model, items) {
+function itemsToLanguageV2Messages(model, items) {
     const messages = [];
     let currentAssistantMessage;
     for (const item of items) {
@@ -18,7 +26,7 @@ export function itemsToLanguageV1Messages(model, items) {
                 messages.push({
                     role: 'system',
                     content: content,
-                    providerMetadata: {
+                    providerOptions: {
                         ...(providerData ?? {}),
                     },
                 });
@@ -35,7 +43,7 @@ export function itemsToLanguageV1Messages(model, items) {
                                 return {
                                     type: 'text',
                                     text: c.text,
-                                    providerMetadata: {
+                                    providerOptions: {
                                         ...(contentProviderData ?? {}),
                                     },
                                 };
@@ -43,30 +51,31 @@ export function itemsToLanguageV1Messages(model, items) {
                             if (c.type === 'input_image') {
                                 const url = new URL(c.image);
                                 return {
-                                    type: 'image',
-                                    image: url,
-                                    providerMetadata: {
+                                    type: 'file',
+                                    data: url,
+                                    mediaType: 'image/*',
+                                    providerOptions: {
                                         ...(contentProviderData ?? {}),
                                     },
                                 };
                             }
                             if (c.type === 'input_file') {
                                 if (typeof c.file !== 'string') {
-                                    throw new UserError('File ID is not supported');
+                                    throw new agents_1.UserError('File ID is not supported');
                                 }
                                 return {
                                     type: 'file',
                                     file: c.file,
-                                    mimeType: 'application/octet-stream',
+                                    mediaType: 'application/octet-stream',
                                     data: c.file,
-                                    providerMetadata: {
+                                    providerOptions: {
                                         ...(contentProviderData ?? {}),
                                     },
                                 };
                             }
-                            throw new UserError(`Unknown content type: ${c.type}`);
+                            throw new agents_1.UserError(`Unknown content type: ${c.type}`);
                         }),
-                    providerMetadata: {
+                    providerOptions: {
                         ...(providerData ?? {}),
                     },
                 });
@@ -86,12 +95,12 @@ export function itemsToLanguageV1Messages(model, items) {
                         return {
                             type: 'text',
                             text: c.text,
-                            providerMetadata: {
+                            providerOptions: {
                                 ...(contentProviderData ?? {}),
                             },
                         };
                     }),
-                    providerMetadata: {
+                    providerOptions: {
                         ...(providerData ?? {}),
                     },
                 });
@@ -105,7 +114,7 @@ export function itemsToLanguageV1Messages(model, items) {
                 currentAssistantMessage = {
                     role: 'assistant',
                     content: [],
-                    providerMetadata: {
+                    providerOptions: {
                         ...(item.providerData ?? {}),
                     },
                 };
@@ -116,8 +125,8 @@ export function itemsToLanguageV1Messages(model, items) {
                     type: 'tool-call',
                     toolCallId: item.callId,
                     toolName: item.name,
-                    args: parseArguments(item.arguments),
-                    providerMetadata: {
+                    input: parseArguments(item.arguments),
+                    providerOptions: {
                         ...(item.providerData ?? {}),
                     },
                 };
@@ -134,28 +143,28 @@ export function itemsToLanguageV1Messages(model, items) {
                 type: 'tool-result',
                 toolCallId: item.callId,
                 toolName: item.name,
-                result: item.output,
-                providerMetadata: {
+                output: convertToAiSdkOutput(item.output),
+                providerOptions: {
                     ...(item.providerData ?? {}),
                 },
             };
             messages.push({
                 role: 'tool',
                 content: [toolResult],
-                providerMetadata: {
+                providerOptions: {
                     ...(item.providerData ?? {}),
                 },
             });
             continue;
         }
         if (item.type === 'hosted_tool_call') {
-            throw new UserError('Hosted tool calls are not supported');
+            throw new agents_1.UserError('Hosted tool calls are not supported');
         }
         if (item.type === 'computer_call') {
-            throw new UserError('Computer calls are not supported');
+            throw new agents_1.UserError('Computer calls are not supported');
         }
         if (item.type === 'computer_call_result') {
-            throw new UserError('Computer call results are not supported');
+            throw new agents_1.UserError('Computer call results are not supported');
         }
         if (item.type === 'reasoning' &&
             item.content.length > 0 &&
@@ -166,10 +175,10 @@ export function itemsToLanguageV1Messages(model, items) {
                     {
                         type: 'reasoning',
                         text: item.content[0].text,
-                        providerMetadata: { ...(item.providerData ?? {}) },
+                        providerOptions: { ...(item.providerData ?? {}) },
                     },
                 ],
-                providerMetadata: {
+                providerOptions: {
                     ...(item.providerData ?? {}),
                 },
             });
@@ -180,10 +189,10 @@ export function itemsToLanguageV1Messages(model, items) {
             continue;
         }
         if (item) {
-            throw new UserError(`Unknown item type: ${item.type}`);
+            throw new agents_1.UserError(`Unknown item type: ${item.type}`);
         }
         const itemType = item;
-        throw new UserError(`Unknown item type: ${itemType}`);
+        throw new agents_1.UserError(`Unknown item type: ${itemType}`);
     }
     if (currentAssistantMessage) {
         messages.push(currentAssistantMessage);
@@ -192,33 +201,54 @@ export function itemsToLanguageV1Messages(model, items) {
 }
 /**
  * @internal
- * Converts a handoff to a language model v1 tool.
+ * Converts a handoff to a language model V2 tool.
  *
  * @param model - The model to use.
  * @param handoff - The handoff to convert.
  */
-function handoffToLanguageV1Tool(model, handoff) {
+function handoffToLanguageV2Tool(model, handoff) {
     return {
         type: 'function',
         name: handoff.toolName,
         description: handoff.toolDescription,
-        parameters: handoff.inputJsonSchema,
+        inputSchema: handoff.inputJsonSchema,
     };
 }
+function convertToAiSdkOutput(output) {
+    const anyOutput = output;
+    if (anyOutput?.type === 'text' && typeof anyOutput.text === 'string') {
+        return { type: 'text', value: anyOutput.text };
+    }
+    if (anyOutput?.type === 'image' &&
+        typeof anyOutput.data === 'string' &&
+        typeof anyOutput.mediaType === 'string') {
+        return {
+            type: 'content',
+            value: [
+                {
+                    type: 'media',
+                    data: anyOutput.data,
+                    mediaType: anyOutput.mediaType,
+                },
+            ],
+        };
+    }
+    throw new agents_1.UserError(`Unsupported tool output type: ${String(anyOutput?.type)}`);
+}
 /**
  * @internal
- * Converts a tool to a language model v1 tool.
+ * Converts a tool to a language model V2 tool.
  *
  * @param model - The model to use.
  * @param tool - The tool to convert.
  */
-export function toolToLanguageV1Tool(model, tool) {
+function toolToLanguageV2Tool(model, tool) {
     if (tool.type === 'function') {
         return {
             type: 'function',
             name: tool.name,
             description: tool.description,
-            parameters: tool.parameters,
+            inputSchema: tool.parameters,
         };
     }
     if (tool.type === 'hosted_tool') {
@@ -246,12 +276,12 @@ export function toolToLanguageV1Tool(model, tool) {
 }
 /**
  * @internal
- * Converts an output type to a language model v1 response format.
+ * Converts an output type to a language model V2 response format.
  *
  * @param outputType - The output type to convert.
- * @returns The language model v1 response format.
+ * @returns The language model V2 response format.
  */
-export function getResponseFormat(outputType) {
+function getResponseFormat(outputType) {
     if (outputType === 'text') {
         return {
             type: 'text',
@@ -264,7 +294,7 @@ export function getResponseFormat(outputType) {
     };
 }
 /**
- * Wraps a model from the AI SDK that adheres to the LanguageModelV1 spec to be used used as a model
+ * Wraps a model from the AI SDK that adheres to the LanguageModelV2 spec to be used used as a model
  * in the OpenAI Agents SDK to use other models.
  *
  * While you can use this with the OpenAI models, it is recommended to use the default OpenAI model
@@ -287,14 +317,14 @@ export function getResponseFormat(outputType) {
  * @param model - The Vercel AI SDK model to wrap.
  * @returns The wrapped model.
  */
-export class AiSdkModel {
+class AiSdkModel {
     #model;
-    #logger = getLogger('openai-agents:extensions:ai-sdk');
+    #logger = (0, agents_1.getLogger)('openai-agents:extensions:ai-sdk');
     constructor(model) {
         this.#model = model;
     }
     async getResponse(request) {
-        return withGenerationSpan(async (span) => {
+        return (0, agents_1.withGenerationSpan)(async (span) => {
             try {
                 span.spanData.model = this.#model.provider + ':' + this.#model.modelId;
                 span.spanData.model_config = {
@@ -308,7 +338,7 @@ export class AiSdkModel {
                             content: [{ type: 'text', text: request.input }],
                         },
                     ]
-                    : itemsToLanguageV1Messages(this.#model, request.input);
+                    : itemsToLanguageV2Messages(this.#model, request.input);
                 if (request.systemInstructions) {
                     input = [
                         {
@@ -318,29 +348,25 @@ export class AiSdkModel {
                         ...input,
                     ];
                 }
-                const tools = request.tools.map((tool) => toolToLanguageV1Tool(this.#model, tool));
+                const tools = request.tools.map((tool) => toolToLanguageV2Tool(this.#model, tool));
                 request.handoffs.forEach((handoff) => {
-                    tools.push(handoffToLanguageV1Tool(this.#model, handoff));
+                    tools.push(handoffToLanguageV2Tool(this.#model, handoff));
                 });
                 if (span && request.tracing === true) {
                     span.spanData.input = input;
                 }
-                if (isZodObject(request.outputType)) {
-                    throw new UserError('Zod output type is not yet supported');
+                if ((0, utils_1.isZodObject)(request.outputType)) {
+                    throw new agents_1.UserError('Zod output type is not yet supported');
                 }
                 const responseFormat = getResponseFormat(request.outputType);
                 const aiSdkRequest = {
-                    inputFormat: 'messages',
-                    mode: {
-                        type: 'regular',
-                        tools,
-                    },
+                    tools,
                     prompt: input,
                     temperature: request.modelSettings.temperature,
                     topP: request.modelSettings.topP,
                     frequencyPenalty: request.modelSettings.frequencyPenalty,
                     presencePenalty: request.modelSettings.presencePenalty,
-                    maxTokens: request.modelSettings.maxTokens,
+                    maxOutputTokens: request.modelSettings.maxTokens,
                     responseFormat,
                     abortSignal: request.signal,
                     ...(request.modelSettings.providerData ?? {}),
@@ -349,52 +375,59 @@ export class AiSdkModel {
                     this.#logger.debug('Request sent');
                 }
                 else {
-                    this.#logger.debug('Request:', aiSdkRequest);
+                    this.#logger.debug('Request:', JSON.stringify(aiSdkRequest, null, 2));
                 }
                 const result = await this.#model.doGenerate(aiSdkRequest);
                 const output = [];
-                result.toolCalls?.forEach((toolCall) => {
+                const resultContent = result.content ?? [];
+                const toolCalls = resultContent.filter((c) => c && c.type === 'tool-call');
+                const hasToolCalls = toolCalls.length > 0;
+                for (const toolCall of toolCalls) {
                     output.push({
                         type: 'function_call',
                         callId: toolCall.toolCallId,
                         name: toolCall.toolName,
-                        arguments: toolCall.args,
+                        arguments: typeof toolCall.input === 'string'
+                            ? toolCall.input
+                            : JSON.stringify(toolCall.input ?? {}),
                         status: 'completed',
-                        providerData: !result.text ? result.providerMetadata : undefined,
+                        providerData: hasToolCalls ? result.providerMetadata : undefined,
                     });
-                });
+                }
                 // Some of other platforms may return both tool calls and text.
                 // Putting a text message here will let the agent loop to complete,
                 // so adding this item only when the tool calls are empty.
                 // Note that the same support is not available for streaming mode.
-                if ((!result.toolCalls || result.toolCalls.length === 0) &&
-                    result.text) {
-                    output.push({
-                        type: 'message',
-                        content: [{ type: 'output_text', text: result.text }],
-                        role: 'assistant',
-                        status: 'completed',
-                        providerData: result.providerMetadata,
-                    });
+                if (!hasToolCalls) {
+                    const textItem = resultContent.find((c) => c && c.type === 'text' && typeof c.text === 'string');
+                    if (textItem) {
+                        output.push({
+                            type: 'message',
+                            content: [{ type: 'output_text', text: textItem.text }],
+                            role: 'assistant',
+                            status: 'completed',
+                            providerData: result.providerMetadata,
+                        });
+                    }
                 }
                 if (span && request.tracing === true) {
                     span.spanData.output = output;
                 }
                 const response = {
                     responseId: result.response?.id ?? 'FAKE_ID',
-                    usage: new Usage({
-                        inputTokens: Number.isNaN(result.usage?.promptTokens)
+                    usage: new agents_1.Usage({
+                        inputTokens: Number.isNaN(result.usage?.inputTokens)
                             ? 0
-                            : (result.usage?.promptTokens ?? 0),
-                        outputTokens: Number.isNaN(result.usage?.completionTokens)
+                            : (result.usage?.inputTokens ?? 0),
+                        outputTokens: Number.isNaN(result.usage?.outputTokens)
                             ? 0
-                            : (result.usage?.completionTokens ?? 0),
-                        totalTokens: (Number.isNaN(result.usage?.promptTokens)
+                            : (result.usage?.outputTokens ?? 0),
+                        totalTokens: (Number.isNaN(result.usage?.inputTokens)
                             ? 0
-                            : (result.usage?.promptTokens ?? 0)) +
-                            (Number.isNaN(result.usage?.completionTokens)
+                            : (result.usage?.inputTokens ?? 0)) +
+                            (Number.isNaN(result.usage?.outputTokens)
                                 ? 0
-                                : (result.usage?.completionTokens ?? 0)),
+                                : (result.usage?.outputTokens ?? 0)) || 0,
                     }),
                     output,
                     providerData: result,
@@ -411,7 +444,7 @@ export class AiSdkModel {
                     this.#logger.debug('Response ready');
                 }
                 else {
-                    this.#logger.debug('Response:', response);
+                    this.#logger.debug('Response:', JSON.stringify(response, null, 2));
                 }
                 return response;
             }
@@ -445,11 +478,11 @@ export class AiSdkModel {
         });
     }
     async *getStreamedResponse(request) {
-        const span = request.tracing ? createGenerationSpan() : undefined;
+        const span = request.tracing ? (0, agents_1.createGenerationSpan)() : undefined;
         try {
             if (span) {
                 span.start();
-                setCurrentSpan(span);
+                (0, agents_1.setCurrentSpan)(span);
             }
             if (span?.spanData) {
                 span.spanData.model = this.#model.provider + ':' + this.#model.modelId;
@@ -465,7 +498,7 @@ export class AiSdkModel {
                         content: [{ type: 'text', text: request.input }],
                     },
                 ]
-                : itemsToLanguageV1Messages(this.#model, request.input);
+                : itemsToLanguageV2Messages(this.#model, request.input);
             if (request.systemInstructions) {
                 input = [
                     {
@@ -475,26 +508,22 @@ export class AiSdkModel {
                     ...input,
                 ];
             }
-            const tools = request.tools.map((tool) => toolToLanguageV1Tool(this.#model, tool));
+            const tools = request.tools.map((tool) => toolToLanguageV2Tool(this.#model, tool));
             request.handoffs.forEach((handoff) => {
-                tools.push(handoffToLanguageV1Tool(this.#model, handoff));
+                tools.push(handoffToLanguageV2Tool(this.#model, handoff));
             });
             if (span && request.tracing === true) {
                 span.spanData.input = input;
             }
             const responseFormat = getResponseFormat(request.outputType);
             const aiSdkRequest = {
-                inputFormat: 'messages',
-                mode: {
-                    type: 'regular',
-                    tools,
-                },
+                tools,
                 prompt: input,
                 temperature: request.modelSettings.temperature,
                 topP: request.modelSettings.topP,
                 frequencyPenalty: request.modelSettings.frequencyPenalty,
                 presencePenalty: request.modelSettings.presencePenalty,
-                maxTokens: request.modelSettings.maxTokens,
+                maxOutputTokens: request.modelSettings.maxTokens,
                 responseFormat,
                 abortSignal: request.signal,
                 ...(request.modelSettings.providerData ?? {}),
@@ -503,7 +532,7 @@ export class AiSdkModel {
                 this.#logger.debug('Request received (streamed)');
             }
             else {
-                this.#logger.debug('Request (streamed):', aiSdkRequest);
+                this.#logger.debug('Request (streamed):', JSON.stringify(aiSdkRequest, null, 2));
             }
             const { stream } = await this.#model.doStream(aiSdkRequest);
             let started = false;
@@ -523,36 +552,23 @@ export class AiSdkModel {
                         if (!textOutput) {
                             textOutput = { type: 'output_text', text: '' };
                         }
-                        textOutput.text += part.textDelta;
-                        yield { type: 'output_text_delta', delta: part.textDelta };
+                        textOutput.text += part.delta;
+                        yield { type: 'output_text_delta', delta: part.delta };
                         break;
                     }
                     case 'tool-call': {
-                        if (part.toolCallType === 'function') {
-                            functionCalls[part.toolCallId] = {
+                        const toolCallId = part.toolCallId;
+                        if (toolCallId) {
+                            functionCalls[toolCallId] = {
                                 type: 'function_call',
-                                callId: part.toolCallId,
+                                callId: toolCallId,
                                 name: part.toolName,
-                                arguments: part.args,
+                                arguments: part.input ?? '',
                                 status: 'completed',
                             };
                         }
                         break;
                     }
-                    case 'tool-call-delta': {
-                        if (part.toolCallType === 'function') {
-                            const fc = functionCalls[part.toolCallId] ?? {
-                                type: 'function_call',
-                                callId: part.toolCallId,
-                                name: '',
-                                arguments: '',
-                            };
-                            fc.name += part.toolName;
-                            fc.arguments += part.argsTextDelta;
-                            functionCalls[part.toolCallId] = fc;
-                        }
-                        break;
-                    }
                     case 'response-metadata': {
                         if (part.id) {
                             responseId = part.id;
@@ -560,12 +576,12 @@ export class AiSdkModel {
                         break;
                     }
                     case 'finish': {
-                        usagePromptTokens = Number.isNaN(part.usage?.promptTokens)
+                        usagePromptTokens = Number.isNaN(part.usage?.inputTokens)
                             ? 0
-                            : (part.usage?.promptTokens ?? 0);
-                        usageCompletionTokens = Number.isNaN(part.usage?.completionTokens)
+                            : (part.usage?.inputTokens ?? 0);
+                        usageCompletionTokens = Number.isNaN(part.usage?.outputTokens)
                             ? 0
-                            : (part.usage?.completionTokens ?? 0);
+                            : (part.usage?.outputTokens ?? 0);
                         break;
                     }
                     case 'error': {
@@ -612,7 +628,7 @@ export class AiSdkModel {
                 this.#logger.debug('Response ready (streamed)');
             }
             else {
-                this.#logger.debug('Response (streamed):', finalEvent.response);
+                this.#logger.debug('Response (streamed):', JSON.stringify(finalEvent.response, null, 2));
             }
             yield finalEvent;
         }
@@ -634,13 +650,14 @@ export class AiSdkModel {
         finally {
             if (span) {
                 span.end();
-                resetCurrentSpan();
+                (0, agents_1.resetCurrentSpan)();
             }
         }
     }
 }
+exports.AiSdkModel = AiSdkModel;
 /**
- * Wraps a model from the AI SDK that adheres to the LanguageModelV1 spec to be used used as a model
+ * Wraps a model from the AI SDK that adheres to the LanguageModelV2 spec to be used used as a model
  * in the OpenAI Agents SDK to use other models.
  *
  * While you can use this with the OpenAI models, it is recommended to use the default OpenAI model
@@ -663,10 +680,10 @@ export class AiSdkModel {
  * @param model - The Vercel AI SDK model to wrap.
  * @returns The wrapped model.
  */
-export function aisdk(model) {
+function aisdk(model) {
     return new AiSdkModel(model);
 }
-export function parseArguments(args) {
+function parseArguments(args) {
     if (!args) {
         return {};
     }