@ai-sdk/openai 3.0.0-beta.58 → 3.0.0-beta.60

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @ai-sdk/openai
 
+## 3.0.0-beta.60
+
+### Patch Changes
+
+- 0877683: feat(provider/openai): support conversations api
+
+## 3.0.0-beta.59
+
+### Patch Changes
+
+- d0f1baf: feat(openai): Add support for 'promptCacheRetention: 24h' for gpt5.1 series
+
 ## 3.0.0-beta.58
 
 ### Patch Changes

package/dist/index.d.mts

@@ -19,6 +19,7 @@ declare const openaiChatLanguageModelOptions: _ai_sdk_provider_utils.LazySchema<
     strictJsonSchema?: boolean | undefined;
     textVerbosity?: "low" | "medium" | "high" | undefined;
     promptCacheKey?: string | undefined;
+    promptCacheRetention?: "in_memory" | "24h" | undefined;
     safetyIdentifier?: string | undefined;
 }>;
 type OpenAIChatLanguageModelOptions = InferSchema<typeof openaiChatLanguageModelOptions>;
@@ -381,6 +382,7 @@ declare const openaiTools: {
 
 type OpenAIResponsesModelId = 'chatgpt-4o-latest' | 'gpt-3.5-turbo-0125' | 'gpt-3.5-turbo-1106' | 'gpt-3.5-turbo' | 'gpt-4-0613' | 'gpt-4-turbo-2024-04-09' | 'gpt-4-turbo' | 'gpt-4.1-2025-04-14' | 'gpt-4.1-mini-2025-04-14' | 'gpt-4.1-mini' | 'gpt-4.1-nano-2025-04-14' | 'gpt-4.1-nano' | 'gpt-4.1' | 'gpt-4' | 'gpt-4o-2024-05-13' | 'gpt-4o-2024-08-06' | 'gpt-4o-2024-11-20' | 'gpt-4o-mini-2024-07-18' | 'gpt-4o-mini' | 'gpt-4o' | 'gpt-5.1' | 'gpt-5.1-chat-latest' | 'gpt-5.1-codex-mini' | 'gpt-5.1-codex' | 'gpt-5-2025-08-07' | 'gpt-5-chat-latest' | 'gpt-5-codex' | 'gpt-5-mini-2025-08-07' | 'gpt-5-mini' | 'gpt-5-nano-2025-08-07' | 'gpt-5-nano' | 'gpt-5-pro-2025-10-06' | 'gpt-5-pro' | 'gpt-5' | 'o1-2024-12-17' | 'o1' | 'o3-2025-04-16' | 'o3-mini-2025-01-31' | 'o3-mini' | 'o3' | (string & {});
 declare const openaiResponsesProviderOptionsSchema: _ai_sdk_provider_utils.LazySchema<{
+    conversation?: string | null | undefined;
     include?: ("file_search_call.results" | "message.output_text.logprobs" | "reasoning.encrypted_content")[] | null | undefined;
     instructions?: string | null | undefined;
     logprobs?: number | boolean | undefined;
@@ -389,6 +391,7 @@ declare const openaiResponsesProviderOptionsSchema: _ai_sdk_provider_utils.LazyS
     parallelToolCalls?: boolean | null | undefined;
     previousResponseId?: string | null | undefined;
     promptCacheKey?: string | null | undefined;
+    promptCacheRetention?: "in_memory" | "24h" | null | undefined;
     reasoningEffort?: string | null | undefined;
     reasoningSummary?: string | null | undefined;
     safetyIdentifier?: string | null | undefined;

package/dist/index.d.ts

@@ -19,6 +19,7 @@ declare const openaiChatLanguageModelOptions: _ai_sdk_provider_utils.LazySchema<
     strictJsonSchema?: boolean | undefined;
     textVerbosity?: "low" | "medium" | "high" | undefined;
     promptCacheKey?: string | undefined;
+    promptCacheRetention?: "in_memory" | "24h" | undefined;
     safetyIdentifier?: string | undefined;
 }>;
 type OpenAIChatLanguageModelOptions = InferSchema<typeof openaiChatLanguageModelOptions>;
@@ -381,6 +382,7 @@ declare const openaiTools: {
 
 type OpenAIResponsesModelId = 'chatgpt-4o-latest' | 'gpt-3.5-turbo-0125' | 'gpt-3.5-turbo-1106' | 'gpt-3.5-turbo' | 'gpt-4-0613' | 'gpt-4-turbo-2024-04-09' | 'gpt-4-turbo' | 'gpt-4.1-2025-04-14' | 'gpt-4.1-mini-2025-04-14' | 'gpt-4.1-mini' | 'gpt-4.1-nano-2025-04-14' | 'gpt-4.1-nano' | 'gpt-4.1' | 'gpt-4' | 'gpt-4o-2024-05-13' | 'gpt-4o-2024-08-06' | 'gpt-4o-2024-11-20' | 'gpt-4o-mini-2024-07-18' | 'gpt-4o-mini' | 'gpt-4o' | 'gpt-5.1' | 'gpt-5.1-chat-latest' | 'gpt-5.1-codex-mini' | 'gpt-5.1-codex' | 'gpt-5-2025-08-07' | 'gpt-5-chat-latest' | 'gpt-5-codex' | 'gpt-5-mini-2025-08-07' | 'gpt-5-mini' | 'gpt-5-nano-2025-08-07' | 'gpt-5-nano' | 'gpt-5-pro-2025-10-06' | 'gpt-5-pro' | 'gpt-5' | 'o1-2024-12-17' | 'o1' | 'o3-2025-04-16' | 'o3-mini-2025-01-31' | 'o3-mini' | 'o3' | (string & {});
 declare const openaiResponsesProviderOptionsSchema: _ai_sdk_provider_utils.LazySchema<{
+    conversation?: string | null | undefined;
     include?: ("file_search_call.results" | "message.output_text.logprobs" | "reasoning.encrypted_content")[] | null | undefined;
     instructions?: string | null | undefined;
     logprobs?: number | boolean | undefined;
@@ -389,6 +391,7 @@ declare const openaiResponsesProviderOptionsSchema: _ai_sdk_provider_utils.LazyS
     parallelToolCalls?: boolean | null | undefined;
     previousResponseId?: string | null | undefined;
     promptCacheKey?: string | null | undefined;
+    promptCacheRetention?: "in_memory" | "24h" | null | undefined;
     reasoningEffort?: string | null | undefined;
     reasoningSummary?: string | null | undefined;
     safetyIdentifier?: string | null | undefined;

package/dist/index.js

@@ -496,6 +496,15 @@ var openaiChatLanguageModelOptions = (0, import_provider_utils4.lazySchema)(
        * Useful for improving cache hit rates and working around automatic caching issues.
        */
       promptCacheKey: import_v43.z.string().optional(),
+      /**
+       * The retention policy for the prompt cache.
+       * - 'in_memory': Default. Standard prompt caching behavior.
+       * - '24h': Extended prompt caching that keeps cached prefixes active for up to 24 hours.
+       *          Currently only available for 5.1 series models.
+       *
+       * @default 'in_memory'
+       */
+      promptCacheRetention: import_v43.z.enum(["in_memory", "24h"]).optional(),
       /**
        * A stable identifier used to help detect users of your application
        * that may be violating OpenAI's usage policies. The IDs should be a
@@ -662,6 +671,7 @@ var OpenAIChatLanguageModel = class {
       reasoning_effort: openaiOptions.reasoningEffort,
       service_tier: openaiOptions.serviceTier,
       prompt_cache_key: openaiOptions.promptCacheKey,
+      prompt_cache_retention: openaiOptions.promptCacheRetention,
       safety_identifier: openaiOptions.safetyIdentifier,
       // messages:
       messages
@@ -3147,6 +3157,7 @@ var openaiResponsesModelIds = [
 var openaiResponsesProviderOptionsSchema = (0, import_provider_utils23.lazySchema)(
   () => (0, import_provider_utils23.zodSchema)(
     import_v418.z.object({
+      conversation: import_v418.z.string().nullish(),
       include: import_v418.z.array(
         import_v418.z.enum([
           "reasoning.encrypted_content",
@@ -3179,6 +3190,15 @@ var openaiResponsesProviderOptionsSchema = (0, import_provider_utils23.lazySchem
       parallelToolCalls: import_v418.z.boolean().nullish(),
       previousResponseId: import_v418.z.string().nullish(),
       promptCacheKey: import_v418.z.string().nullish(),
+      /**
+       * The retention policy for the prompt cache.
+       * - 'in_memory': Default. Standard prompt caching behavior.
+       * - '24h': Extended prompt caching that keeps cached prefixes active for up to 24 hours.
+       *          Currently only available for 5.1 series models.
+       *
+       * @default 'in_memory'
+       */
+      promptCacheRetention: import_v418.z.enum(["in_memory", "24h"]).nullish(),
       reasoningEffort: import_v418.z.string().nullish(),
       reasoningSummary: import_v418.z.string().nullish(),
       safetyIdentifier: import_v418.z.string().nullish(),
@@ -3421,6 +3441,13 @@ var OpenAIResponsesLanguageModel = class {
       providerOptions,
       schema: openaiResponsesProviderOptionsSchema
     });
+    if ((openaiOptions == null ? void 0 : openaiOptions.conversation) && (openaiOptions == null ? void 0 : openaiOptions.previousResponseId)) {
+      warnings.push({
+        type: "unsupported-setting",
+        setting: "conversation",
+        details: "conversation and previousResponseId cannot be used together"
+      });
+    }
     const { input, warnings: inputWarnings } = await convertToOpenAIResponsesInput({
       prompt,
       systemMessageMode: modelConfig.systemMessageMode,
@@ -3483,6 +3510,7 @@ var OpenAIResponsesLanguageModel = class {
         }
       },
       // provider options:
+      conversation: openaiOptions == null ? void 0 : openaiOptions.conversation,
       max_tool_calls: openaiOptions == null ? void 0 : openaiOptions.maxToolCalls,
       metadata: openaiOptions == null ? void 0 : openaiOptions.metadata,
       parallel_tool_calls: openaiOptions == null ? void 0 : openaiOptions.parallelToolCalls,
@@ -3493,6 +3521,7 @@ var OpenAIResponsesLanguageModel = class {
       service_tier: openaiOptions == null ? void 0 : openaiOptions.serviceTier,
       include,
       prompt_cache_key: openaiOptions == null ? void 0 : openaiOptions.promptCacheKey,
+      prompt_cache_retention: openaiOptions == null ? void 0 : openaiOptions.promptCacheRetention,
       safety_identifier: openaiOptions == null ? void 0 : openaiOptions.safetyIdentifier,
       top_logprobs: topLogprobs,
       truncation: openaiOptions == null ? void 0 : openaiOptions.truncation,
@@ -4941,7 +4970,7 @@ var OpenAITranscriptionModel = class {
 };
 
 // src/version.ts
-var VERSION = true ? "3.0.0-beta.58" : "0.0.0-test";
+var VERSION = true ? "3.0.0-beta.60" : "0.0.0-test";
 
 // src/openai-provider.ts
 function createOpenAI(options = {}) {