@ai-sdk/openai-compatible 3.0.61 → 3.0.62

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @ai-sdk/openai-compatible
 
+## 3.0.62
+
+### Patch Changes
+
+- 04be48f: fix(openai-compatible): support multipart tool results for compatible providers
+
 ## 3.0.61
 
 ### Patch Changes

package/dist/index.d.ts

@@ -87,6 +87,10 @@ type OpenAICompatibleChatConfig = {
    * Whether the model supports structured outputs.
    */
   supportsStructuredOutputs?: boolean;
+  /**
+   * Whether the model supports multi-part content in tool results.
+   */
+  supportsMultiPartToolContent?: boolean;
   /**
    * The supported URLs for the model.
    */
@@ -368,6 +372,13 @@ interface OpenAICompatibleProviderSettings {
    * Whether the provider supports structured outputs in chat models.
    */
   supportsStructuredOutputs?: boolean;
+  /**
+   * Whether chat models support multi-part content in tool results.
+   *
+   * Enable this for providers that extend the OpenAI Chat Completions API with
+   * structured tool-result content. Defaults to `false`.
+   */
+  supportsMultiPartToolContent?: boolean;
   /**
    * Optional function to transform the request body before sending it to the API.
    * This is useful for proxy providers that may require a different request format

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","names":[],"sources":["../src/openai-compatible-error.ts","../src/chat/openai-compatible-chat-language-model-options.ts","../src/chat/openai-compatible-metadata-extractor.ts","../src/chat/openai-compatible-chat-language-model.ts","../src/completion/openai-compatible-completion-language-model-options.ts","../src/completion/openai-compatible-completion-language-model.ts","../src/embedding/openai-compatible-embedding-model-options.ts","../src/embedding/openai-compatible-embedding-model.ts","../src/image/openai-compatible-image-settings.ts","../src/image/openai-compatible-image-model.ts","../src/image/openai-compatible-image-model-options.ts","../src/openai-compatible-provider.ts","../src/version.ts"],"mappings":";;;;cACa,iCAA+B,EAAA;;;;;;;GAW1C,EAAA,KAAA;KAEU,4BAA4B,EAAE,aACjC;KAGG,uBAAuB;EACjC,aAAa,QAAQ;EACrB,iBAAiB,OAAO;EACxB,eAAe,UAAU,UAAU,QAAQ;;;;KCnBjC;cAEC,0CAAwC,EAAA;;;;;GAyBnD,EAAA,KAAA;KAEU,2CAA2C,EAAE,aAChD;;;;;;;;KCzBG;;;;;;;;;EASV,oBACE;IAEA;QACI,QAAQ;;;;;;;;EASd;;;;;;;IAOE,aAAa;;;;;;;;IASb,iBAAiB;;;;;KCgBT;EACV;EACA,gBAAgB;EAChB,MAAM;IAAW;IAAiB;;EAClC,QAAQ;EACR;EACA,iBAAiB;EACjB,oBAAoB;;;;EAKpB;;;;EAKA,sBAAsB;;;;;;EAOtB,wBAAwB,MAAM,wBAAwB;;;;;EAMtD,gBACE,OAAO,EAAE,aAAa,sCACnB;;qBASM,6CAA6C;WAC/C;WAEA;WAEA,SAAS;qBACC,QAAQ;mBACV;mBACA;UAET,oBAAoB,OAAO;;;;UAO3B,sBAAsB;IAC5B;IACA,QAAQ;MACT;EAQC,YAAA,SAAS,6BACT,QAAQ;MAgBN;cAIQ;MAIR,iBAAa,eAAA,YAAA,YAAA,eAAA;UAIT;UAIA;UASM;EA2JR,WACJ,SAAS,6BACR,QAAQ;EAwGL,SACJ,SAAS,6BACR,QAAQ;;cA+UP,kCAAgC,EAAA,YAAA,EAAA,YAAA,EAAA;;;;;;;;;;;;GAkB1B,EAAA,KAAA;;;KClxBA;cAEC,gDAA8C,EAAA;;;;;GAwBzD,EAAA,KAAA;KAEU,iDAAiD,EAAE,aACtD;;;KCWJ;EACH;EACA;EACA,gBAAgB;EAChB,MAAM;IAAW;IAAiB;;EAClC,QAAQ;EACR,iBAAiB;;;;EAKjB,sBAAsB;;qBAGX,mDAAmD;WACrD;WAEA,SAAS;mBACD;mBACA;mBACA;UAET,oBAAoB,OAAO;;;;UAO3B,sBAAsB;IAC5B;IACA,QAAQ;MACT;EAQC,YAAA,SAAS,mCACT,QAAQ;MAcN;cAIQ;MAIR,iBAAa,eAAA,YAAA,YAAA,eAAA;UAIH;EA8FR,WACJ,SAAS,6BACR,QAAQ;EA+CL,SACJ,SAAS,6BACR,QAAQ;;;;KC5PD;cAEC,uCAAqC,EAAA;;;GAYhD,EAAA,KAAA;KAEU,wCAAwC,EAAE,aAC7C;;;KCQJ;;;;EAIH;;;;EAKA;EAEA;EACA,MAAM;IAAW;IAAiB;;EAClC,gBAAgB;EAChB,QAAQ;EACR,iBAAiB;;qBAGN,0CAA0C;WAC5C;WACA,SAAS;mBAED;MAEb;MAIA;MAIA;UAII,oBAAoB,OAAO;;;;UAO3B,sBAAsB;IAC5B;IACA,QAAQ;MACT;EAKC,YAAA,SAAS,kCACT,QAAQ;cAME;EAIN,UACJ,QACA,SACA,aACA,mBACC,WAAW,kCAAkC,QAC9C,QAAQ,WAAW;;;;KC/FX;;;KCgCA;EACV;EACA,gBAAgB;EAChB,MAAM;IAAW;IAAiB;;EAClC,QAAQ;EACR,iBAAiB;EACjB;IACE,oBAAoB;;;qBAIX,sCAAsC;WAgCtC,SAAS;mBACD;WAhCV;WACA;WACA;WACA;MAEL;;;;cAOQ;UAIJ,oBAAoB,OAAO;;;;UAO3B,sBAAsB;IAC5B;IACA,QAAQ;MACT;EAKU,YAAA,SAAS,8BACD,QAAQ;UAGnB;EAeF,aACJ,QACA,GACA,MACA,aACA,MACA,iBACA,SACA,aACA,OACA,QACC,WAAW,iCAAiC,QAC7C,QAAQ,WAAW;;;;;;;;;cCnGV,mCAAiC,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiC5C,EAAA,KAAA;KAEU,oCAAoC,EAAE,aACzC;;;UCtBQ,yBACf,wCACA,8CACA,6CACA,iDACQ;GACP,SAAS,iBAAiB;EAE3B,cACE,SAAS,gBACT,SAAS,QAAQ,8BAChB;EAEH,UAAU,SAAS,iBAAiB;EAEpC,gBAAgB,SAAS,uBAAuB;EAEhD,eAAe,SAAS,sBAAsB;;;;EAK9C,mBAAmB,SAAS,sBAAsB;EAElD,WAAW,SAAS,kBAAkB;;UAGvB;;;;EAIf;;;;EAKA;;;;;;EAOA;;;;;EAMA,UAAU;;;;EAKV,cAAc;;;;;EAMd,QAAQ;;;;EAKR;;;;EAKA;;;;;;EAOA,wBAAwB,MAAM,wBAAwB;;;;;;EAOtD,oBAAoB;;;;EAKpB,gBAAgB;;;;;EAMhB,eAAe;;;;;wBAMD,uBACd,+BACA,qCACA,oCACA,gCAEA,SAAS,mCACR,yBACD,gBACA,sBACA,qBACA;;;qBCpIW"}
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/openai-compatible-error.ts","../src/chat/openai-compatible-chat-language-model-options.ts","../src/chat/openai-compatible-metadata-extractor.ts","../src/chat/openai-compatible-chat-language-model.ts","../src/completion/openai-compatible-completion-language-model-options.ts","../src/completion/openai-compatible-completion-language-model.ts","../src/embedding/openai-compatible-embedding-model-options.ts","../src/embedding/openai-compatible-embedding-model.ts","../src/image/openai-compatible-image-settings.ts","../src/image/openai-compatible-image-model.ts","../src/image/openai-compatible-image-model-options.ts","../src/openai-compatible-provider.ts","../src/version.ts"],"mappings":";;;;cACa,iCAA+B,EAAA;;;;;;;GAW1C,EAAA,KAAA;KAEU,4BAA4B,EAAE,aACjC;KAGG,uBAAuB;EACjC,aAAa,QAAQ;EACrB,iBAAiB,OAAO;EACxB,eAAe,UAAU,UAAU,QAAQ;;;;KCnBjC;cAEC,0CAAwC,EAAA;;;;;GAyBnD,EAAA,KAAA;KAEU,2CAA2C,EAAE,aAChD;;;;;;;;KCzBG;;;;;;;;;EASV,oBACE;IAEA;QACI,QAAQ;;;;;;;;EASd;;;;;;;IAOE,aAAa;;;;;;;;IASb,iBAAiB;;;;;KCgBT;EACV;EACA,gBAAgB;EAChB,MAAM;IAAW;IAAiB;;EAClC,QAAQ;EACR;EACA,iBAAiB;EACjB,oBAAoB;;;;EAKpB;;;;EAKA;;;;EAKA,sBAAsB;;;;;;EAOtB,wBAAwB,MAAM,wBAAwB;;;;;EAMtD,gBACE,OAAO,EAAE,aAAa,sCACnB;;qBASM,6CAA6C;WAC/C;WAEA;WAEA,SAAS;qBACC,QAAQ;mBACV;mBACA;UAET,oBAAoB,OAAO;;;;UAO3B,sBAAsB;IAC5B;IACA,QAAQ;MACT;EAQC,YAAA,SAAS,6BACT,QAAQ;MAgBN;cAIQ;MAIR,iBAAa,eAAA,YAAA,YAAA,eAAA;UAIT;UAIA;UASM;EA6JR,WACJ,SAAS,6BACR,QAAQ;EAwGL,SACJ,SAAS,6BACR,QAAQ;;cA+UP,kCAAgC,EAAA,YAAA,EAAA,YAAA,EAAA;;;;;;;;;;;;GAkB1B,EAAA,KAAA;;;KCzxBA;cAEC,gDAA8C,EAAA;;;;;GAwBzD,EAAA,KAAA;KAEU,iDAAiD,EAAE,aACtD;;;KCWJ;EACH;EACA;EACA,gBAAgB;EAChB,MAAM;IAAW;IAAiB;;EAClC,QAAQ;EACR,iBAAiB;;;;EAKjB,sBAAsB;;qBAGX,mDAAmD;WACrD;WAEA,SAAS;mBACD;mBACA;mBACA;UAET,oBAAoB,OAAO;;;;UAO3B,sBAAsB;IAC5B;IACA,QAAQ;MACT;EAQC,YAAA,SAAS,mCACT,QAAQ;MAcN;cAIQ;MAIR,iBAAa,eAAA,YAAA,YAAA,eAAA;UAIH;EA8FR,WACJ,SAAS,6BACR,QAAQ;EA+CL,SACJ,SAAS,6BACR,QAAQ;;;;KC5PD;cAEC,uCAAqC,EAAA;;;GAYhD,EAAA,KAAA;KAEU,wCAAwC,EAAE,aAC7C;;;KCQJ;;;;EAIH;;;;EAKA;EAEA;EACA,MAAM;IAAW;IAAiB;;EAClC,gBAAgB;EAChB,QAAQ;EACR,iBAAiB;;qBAGN,0CAA0C;WAC5C;WACA,SAAS;mBAED;MAEb;MAIA;MAIA;UAII,oBAAoB,OAAO;;;;UAO3B,sBAAsB;IAC5B;IACA,QAAQ;MACT;EAKC,YAAA,SAAS,kCACT,QAAQ;cAME;EAIN,UACJ,QACA,SACA,aACA,mBACC,WAAW,kCAAkC,QAC9C,QAAQ,WAAW;;;;KC/FX;;;KCgCA;EACV;EACA,gBAAgB;EAChB,MAAM;IAAW;IAAiB;;EAClC,QAAQ;EACR,iBAAiB;EACjB;IACE,oBAAoB;;;qBAIX,sCAAsC;WAgCtC,SAAS;mBACD;WAhCV;WACA;WACA;WACA;MAEL;;;;cAOQ;UAIJ,oBAAoB,OAAO;;;;UAO3B,sBAAsB;IAC5B;IACA,QAAQ;MACT;EAKU,YAAA,SAAS,8BACD,QAAQ;UAGnB;EAeF,aACJ,QACA,GACA,MACA,aACA,MACA,iBACA,SACA,aACA,OACA,QACC,WAAW,iCAAiC,QAC7C,QAAQ,WAAW;;;;;;;;;cCnGV,mCAAiC,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiC5C,EAAA,KAAA;KAEU,oCAAoC,EAAE,aACzC;;;UCtBQ,yBACf,wCACA,8CACA,6CACA,iDACQ;GACP,SAAS,iBAAiB;EAE3B,cACE,SAAS,gBACT,SAAS,QAAQ,8BAChB;EAEH,UAAU,SAAS,iBAAiB;EAEpC,gBAAgB,SAAS,uBAAuB;EAEhD,eAAe,SAAS,sBAAsB;;;;EAK9C,mBAAmB,SAAS,sBAAsB;EAElD,WAAW,SAAS,kBAAkB;;UAGvB;;;;EAIf;;;;EAKA;;;;;;EAOA;;;;;EAMA,UAAU;;;;EAKV,cAAc;;;;;EAMd,QAAQ;;;;EAKR;;;;EAKA;;;;;;;EAQA;;;;;;EAOA,wBAAwB,MAAM,wBAAwB;;;;;;EAOtD,oBAAoB;;;;EAKpB,gBAAgB;;;;;EAMhB,eAAe;;;;;wBAMD,uBACd,+BACA,qCACA,oCACA,gCAEA,SAAS,mCACR,yBACD,gBACA,sBACA,qBACA;;;qBC5IW"}

package/dist/index.js

@@ -71,7 +71,72 @@ function getAudioFormat(mediaType) {
 		default: return null;
 	}
 }
-function convertToOpenAICompatibleChatMessages(prompt, { providerOptionsKey = "google" } = {}) {
+function convertToOpenAICompatibleContentPart(part) {
+	const partMetadata = getOpenAIMetadata(part);
+	switch (part.type) {
+		case "text": return {
+			type: "text",
+			text: part.text,
+			...partMetadata
+		};
+		case "file": switch (part.data.type) {
+			case "reference": throw new UnsupportedFunctionalityError({ functionality: "file parts with provider references" });
+			case "text": throw new UnsupportedFunctionalityError({ functionality: "text file parts" });
+			case "url":
+			case "data": {
+				const topLevel = getTopLevelMediaType(part.mediaType);
+				if (topLevel === "image") return {
+					type: "image_url",
+					image_url: { url: part.data.type === "url" ? part.data.url.toString() : `data:${resolveFullMediaType({ part })};base64,${convertToBase64(part.data.data)}` },
+					...partMetadata
+				};
+				if (topLevel === "video") return {
+					type: "video_url",
+					video_url: { url: part.data.type === "url" ? part.data.url.toString() : `data:${resolveFullMediaType({ part })};base64,${convertToBase64(part.data.data)}` },
+					...partMetadata
+				};
+				if (topLevel === "audio") {
+					if (part.data.type === "url") throw new UnsupportedFunctionalityError({ functionality: "audio file parts with URLs" });
+					const fullMediaType = resolveFullMediaType({ part });
+					const format = getAudioFormat(fullMediaType);
+					if (format === null) throw new UnsupportedFunctionalityError({ functionality: `audio media type ${fullMediaType}` });
+					return {
+						type: "input_audio",
+						input_audio: {
+							data: convertToBase64(part.data.data),
+							format
+						},
+						...partMetadata
+					};
+				}
+				if (topLevel === "application") {
+					if (part.data.type === "url") throw new UnsupportedFunctionalityError({ functionality: "PDF file parts with URLs" });
+					const fullMediaType = resolveFullMediaType({ part });
+					if (fullMediaType !== "application/pdf") throw new UnsupportedFunctionalityError({ functionality: `file part media type ${fullMediaType}` });
+					return {
+						type: "file",
+						file: {
+							filename: part.filename ?? "document.pdf",
+							file_data: `data:application/pdf;base64,${convertToBase64(part.data.data)}`
+						},
+						...partMetadata
+					};
+				}
+				if (topLevel === "text") return {
+					type: "text",
+					text: part.data.type === "url" ? part.data.url.toString() : typeof part.data.data === "string" ? new TextDecoder().decode(convertBase64ToUint8Array(part.data.data)) : new TextDecoder().decode(part.data.data),
+					...partMetadata
+				};
+				throw new UnsupportedFunctionalityError({ functionality: `file part media type ${part.mediaType}` });
+			}
+		}
+	}
+}
+function convertToolContentPart(part) {
+	if (part.type === "custom") throw new UnsupportedFunctionalityError({ functionality: "custom tool content parts" });
+	return convertToOpenAICompatibleContentPart(part);
+}
+function convertToOpenAICompatibleChatMessages(prompt, { providerOptionsKey = "google", supportsMultiPartToolContent = false } = {}) {
 	const messages = [];
 	for (const { role, content, ...message } of prompt) {
 		const metadata = getOpenAIMetadata({ ...message });
@@ -94,67 +159,7 @@ function convertToOpenAICompatibleChatMessages(prompt, { providerOptionsKey = "g
 				}
 				messages.push({
 					role: "user",
-					content: content.map((part) => {
-						const partMetadata = getOpenAIMetadata(part);
-						switch (part.type) {
-							case "text": return {
-								type: "text",
-								text: part.text,
-								...partMetadata
-							};
-							case "file": switch (part.data.type) {
-								case "reference": throw new UnsupportedFunctionalityError({ functionality: "file parts with provider references" });
-								case "text": throw new UnsupportedFunctionalityError({ functionality: "text file parts" });
-								case "url":
-								case "data": {
-									const topLevel = getTopLevelMediaType(part.mediaType);
-									if (topLevel === "image") return {
-										type: "image_url",
-										image_url: { url: part.data.type === "url" ? part.data.url.toString() : `data:${resolveFullMediaType({ part })};base64,${convertToBase64(part.data.data)}` },
-										...partMetadata
-									};
-									if (topLevel === "video") return {
-										type: "video_url",
-										video_url: { url: part.data.type === "url" ? part.data.url.toString() : `data:${resolveFullMediaType({ part })};base64,${convertToBase64(part.data.data)}` },
-										...partMetadata
-									};
-									if (topLevel === "audio") {
-										if (part.data.type === "url") throw new UnsupportedFunctionalityError({ functionality: "audio file parts with URLs" });
-										const fullMediaType = resolveFullMediaType({ part });
-										const format = getAudioFormat(fullMediaType);
-										if (format === null) throw new UnsupportedFunctionalityError({ functionality: `audio media type ${fullMediaType}` });
-										return {
-											type: "input_audio",
-											input_audio: {
-												data: convertToBase64(part.data.data),
-												format
-											},
-											...partMetadata
-										};
-									}
-									if (topLevel === "application") {
-										if (part.data.type === "url") throw new UnsupportedFunctionalityError({ functionality: "PDF file parts with URLs" });
-										const fullMediaType = resolveFullMediaType({ part });
-										if (fullMediaType !== "application/pdf") throw new UnsupportedFunctionalityError({ functionality: `file part media type ${fullMediaType}` });
-										return {
-											type: "file",
-											file: {
-												filename: part.filename ?? "document.pdf",
-												file_data: `data:application/pdf;base64,${convertToBase64(part.data.data)}`
-											},
-											...partMetadata
-										};
-									}
-									if (topLevel === "text") return {
-										type: "text",
-										text: part.data.type === "url" ? part.data.url.toString() : typeof part.data.data === "string" ? new TextDecoder().decode(convertBase64ToUint8Array(part.data.data)) : new TextDecoder().decode(part.data.data),
-										...partMetadata
-									};
-									throw new UnsupportedFunctionalityError({ functionality: `file part media type ${part.mediaType}` });
-								}
-							}
-						}
-					}),
+					content: content.map(convertToOpenAICompatibleContentPart),
 					...metadata
 				});
 				break;
@@ -209,9 +214,11 @@ function convertToOpenAICompatibleChatMessages(prompt, { providerOptionsKey = "g
 						case "execution-denied":
 							contentValue = output.reason ?? "Tool call execution denied.";
 							break;
-						case "content":
 						case "json":
-						case "error-json": contentValue = JSON.stringify(output.value);
+						case "error-json":
+							contentValue = JSON.stringify(output.value);
+							break;
+						case "content": contentValue = supportsMultiPartToolContent ? output.value.map(convertToolContentPart) : JSON.stringify(output.value);
 					}
 					const toolResponseMetadata = getOpenAIMetadata(toolResponse);
 					messages.push({
@@ -430,7 +437,10 @@ var OpenAICompatibleChatLanguageModel = class OpenAICompatibleChatLanguageModel
 				}).filter(([key]) => !Object.keys(openaiCompatibleLanguageModelChatOptions.shape).includes(key))),
 				reasoning_effort: compatibleOptions.reasoningEffort ?? (isCustomReasoning(reasoning) ? reasoning : void 0),
 				verbosity: compatibleOptions.textVerbosity,
-				messages: convertToOpenAICompatibleChatMessages(prompt, { providerOptionsKey: metadataKey }),
+				messages: convertToOpenAICompatibleChatMessages(prompt, {
+					providerOptionsKey: metadataKey,
+					supportsMultiPartToolContent: this.config.supportsMultiPartToolContent
+				}),
 				tools: openaiTools,
 				tool_choice: openaiToolChoice
 			},
@@ -1407,7 +1417,7 @@ async function fileToBlob(file) {
 }
 //#endregion
 //#region src/version.ts
-const VERSION = "3.0.61";
+const VERSION = "3.0.62";
 //#endregion
 //#region src/openai-compatible-provider.ts
 /**
@@ -1436,6 +1446,7 @@ function createOpenAICompatible(options) {
 		...getCommonModelConfig("chat"),
 		includeUsage: options.includeUsage,
 		supportsStructuredOutputs: options.supportsStructuredOutputs,
+		supportsMultiPartToolContent: options.supportsMultiPartToolContent,
 		supportedUrls: options.supportedUrls,
 		transformRequestBody: options.transformRequestBody,
 		metadataExtractor: options.metadataExtractor,