@core-ai/openai 0.25.0 → 0.26.0

package/dist/{chunk-IZPTRJP3.js → chunk-FOVN4IGD.js}

@@ -229,7 +229,8 @@ var openaiResponsesGenerateProviderOptionsSchema = z.object({
   serviceTier: z.enum(["auto", "default", "flex", "scale", "priority"]).optional(),
   include: z.array(z.string()).optional(),
   parallelToolCalls: z.boolean().optional(),
-  user: z.string().optional()
+  user: z.string().optional(),
+  promptCacheKey: z.string().optional()
 }).strict();
 var openaiChatGenerateProviderOptionsSchema = openaiResponsesGenerateProviderOptionsSchema.omit({
   include: true
@@ -260,11 +261,14 @@ function parseOpenAIProviderOptions(providerOptions, key, schema) {
   }
   return schema.parse(rawOptions);
 }
-function parseOpenAIResponsesGenerateProviderOptions(providerOptions) {
+function parseOpenAIResponsesGenerateProviderOptions(providerOptions, config = {
+  key: "openai",
+  schema: openaiResponsesGenerateProviderOptionsSchema
+}) {
   return parseOpenAIProviderOptions(
     providerOptions,
-    "openai",
-    openaiResponsesGenerateProviderOptionsSchema
+    config.key,
+    config.schema
   );
 }
 function parseOpenAIChatGenerateProviderOptions(providerOptions, config = {
@@ -353,6 +357,14 @@ function convertToolChoice(choice) {
   };
 }
 
+// src/shared/usage.ts
+function normalizeOutputTokens(outputTokens, reasoningTokens, accounting = "included") {
+  if (accounting === "separate" && reasoningTokens !== void 0) {
+    return outputTokens + reasoningTokens;
+  }
+  return outputTokens;
+}
+
 // src/shared/utils.ts
 import { ValidationError } from "@core-ai/core-ai";
 function safeParseJsonObject(json) {
@@ -603,7 +615,8 @@ function mapOpenAIProviderOptionsToRequestFields(options) {
     ...options?.stopSequences ? { stop: options.stopSequences } : {},
     ...options?.frequencyPenalty !== void 0 ? { frequency_penalty: options.frequencyPenalty } : {},
     ...options?.presencePenalty !== void 0 ? { presence_penalty: options.presencePenalty } : {},
-    ...options?.seed !== void 0 ? { seed: options.seed } : {}
+    ...options?.seed !== void 0 ? { seed: options.seed } : {},
+    ...options?.promptCacheKey !== void 0 ? { prompt_cache_key: options.promptCacheKey } : {}
   };
 }
 function mapResponseFormatToRequestFields(format) {
@@ -667,7 +680,11 @@ function mapGenerateResponse(response, adapterOptions = {}) {
     finishReason: mapFinishReason(firstChoice.finish_reason),
     usage: {
       inputTokens: response.usage?.prompt_tokens ?? 0,
-      outputTokens: response.usage?.completion_tokens ?? 0,
+      outputTokens: normalizeOutputTokens(
+        response.usage?.completion_tokens ?? 0,
+        reasoningTokens,
+        adapterOptions.reasoningTokenAccounting
+      ),
       inputTokenDetails: {
         cacheReadTokens: response.usage?.prompt_tokens_details?.cached_tokens ?? 0,
         cacheWriteTokens: 0
@@ -766,7 +783,11 @@ async function* transformStream(stream, adapterOptions = {}) {
       const reasoningTokens = chunk.usage.completion_tokens_details?.reasoning_tokens;
       usage = {
         inputTokens: chunk.usage.prompt_tokens ?? 0,
-        outputTokens: chunk.usage.completion_tokens ?? 0,
+        outputTokens: normalizeOutputTokens(
+          chunk.usage.completion_tokens ?? 0,
+          reasoningTokens,
+          adapterOptions.reasoningTokenAccounting
+        ),
         inputTokenDetails: {
           cacheReadTokens: chunk.usage.prompt_tokens_details?.cached_tokens ?? 0,
           cacheWriteTokens: 0
@@ -1361,6 +1382,7 @@ function createOpenAIChatCompletionsModel(client, modelId, modelOptions) {
     capabilities,
     compatibility: compatibilityOptions !== void 0 && compatibilityOptions.reasoning !== false,
     maxTokensParameter: compatibilityOptions?.maxTokensParameter,
+    reasoningTokenAccounting: compatibilityOptions?.reasoningTokenAccounting,
     providerId: provider,
     providerOptions: modelOptions.providerOptions,
     reasoning: typeof compatibilityOptions?.reasoning === "object" ? compatibilityOptions.reasoning : void 0
@@ -1626,7 +1648,8 @@ function createStreamRequest2(modelId, options, adapterOptions = {}) {
 function createRequest2(modelId, options, stream, adapterOptions) {
   const resolved = resolveAdapterOptions(modelId, adapterOptions);
   const openaiOptions = parseOpenAIResponsesGenerateProviderOptions(
-    options.providerOptions
+    options.providerOptions,
+    adapterOptions.providerOptions
   );
   const request = {
     ...createRequestBase2(modelId, options, resolved),
@@ -1634,7 +1657,8 @@ function createRequest2(modelId, options, stream, adapterOptions) {
     ...options.structuredOutputFormat ? { text: { format: options.structuredOutputFormat } } : {},
     ...mapOpenAIProviderOptionsToRequestFields2(openaiOptions)
   };
-  if (options.reasoning && resolved.capabilities.reasoning.mode !== "unsupported") {
+  const reasoningMode = resolved.capabilities.reasoning.mode;
+  if (reasoningMode === "always-on" || options.reasoning && reasoningMode !== "unsupported") {
     request.include = mergeInclude(request.include, [
       ENCRYPTED_REASONING_INCLUDE
     ]);
@@ -1710,7 +1734,8 @@ function mapOpenAIProviderOptionsToRequestFields2(options) {
     ...options?.serviceTier !== void 0 ? { service_tier: options.serviceTier } : {},
     ...options?.include ? { include: options.include } : {},
     ...options?.parallelToolCalls !== void 0 ? { parallel_tool_calls: options.parallelToolCalls } : {},
-    ...options?.user !== void 0 ? { user: options.user } : {}
+    ...options?.user !== void 0 ? { user: options.user } : {},
+    ...options?.promptCacheKey !== void 0 ? { prompt_cache_key: options.promptCacheKey } : {}
   };
 }
 function mapGenerateResponse2(response, adapterOptions = {}) {
@@ -2166,7 +2191,7 @@ function mapReasoningToRequestFields2(options, capabilities) {
   if (!options.reasoning) {
     return {};
   }
-  if (capabilities.reasoning.mode === "unsupported") {
+  if (capabilities.reasoning.mode === "unsupported" || capabilities.reasoning.supportedEfforts.length === 0) {
     return {};
   }
   const effort = toOpenAIReasoningEffort(
@@ -2193,9 +2218,13 @@ function isReasoningItem(item) {
 }
 
 // src/chat-model.ts
-function createOpenAIChatModel(client, modelId, capabilities, providerId = DEFAULT_PROVIDER_ID) {
-  const provider = providerId;
-  const adapterOptions = { capabilities, providerId };
+function createOpenAIChatModel(client, modelId, capabilities, modelOptions = {}) {
+  const provider = modelOptions.providerId ?? DEFAULT_PROVIDER_ID;
+  const adapterOptions = {
+    capabilities,
+    providerId: provider,
+    providerOptions: modelOptions.providerOptions
+  };
   async function callOpenAIResponsesApi(request, signal) {
     try {
       return await client.responses.create(request, {
@@ -2372,7 +2401,13 @@ function createOpenAIProvider(options, factoryOptions = {}) {
     client,
     modelId,
     toOpenAIResponsesCapabilities(resolveCapabilities(modelId)),
-    providerId
+    {
+      providerId,
+      providerOptions: {
+        key: providerId,
+        schema: factoryOptions.responsesProviderOptionsSchema ?? openaiResponsesGenerateProviderOptionsSchema
+      }
+    }
   );
   const createChatCompletionsModel = (modelId) => {
     const capabilities = resolveCapabilities(modelId);
@@ -2382,14 +2417,15 @@ function createOpenAIProvider(options, factoryOptions = {}) {
         providerMetadataKey: compatibilityOptions.reasoning.providerMetadataKey ?? providerId
       } : compatibilityOptions?.reasoning ?? true,
       structuredOutputMode: compatibilityOptions?.structuredOutputMode,
-      maxTokensParameter: compatibilityOptions?.maxTokensParameter
+      maxTokensParameter: compatibilityOptions?.maxTokensParameter,
+      reasoningTokenAccounting: compatibilityOptions?.reasoningTokenAccounting
     } : void 0;
     return createOpenAIChatCompletionsModel(client, modelId, {
       providerId,
       capabilities,
       compatibility,
       providerOptions: {
-        key: factoryOptions.providerOptionsKey ?? providerId,
+        key: providerId,
         schema: factoryOptions.providerOptionsSchema ?? openaiChatGenerateProviderOptionsSchema
       }
     });

package/dist/compat.d.ts

@@ -1,7 +1,7 @@
 import * as _core_ai_core_ai from '@core-ai/core-ai';
 import { ChatModel } from '@core-ai/core-ai';
-import { O as OpenAIChatClient, a as OpenAIProvider, b as OpenAIProviderBaseOptions } from './provider-factory-DaVZWYPo.js';
-export { c as OpenAICompatGenerateProviderOptions, d as OpenAICompatRequestOptions, o as openaiCompatGenerateProviderOptionsSchema, e as openaiCompatProviderOptionsSchema } from './provider-factory-DaVZWYPo.js';
+import { O as OpenAIChatClient, a as OpenAIProvider, b as OpenAIProviderBaseOptions } from './provider-factory-BIr9zZ2d.js';
+export { c as OpenAICompatGenerateProviderOptions, d as OpenAICompatRequestOptions, o as openaiCompatGenerateProviderOptionsSchema, e as openaiCompatProviderOptionsSchema } from './provider-factory-BIr9zZ2d.js';
 import 'openai';
 import 'zod';
 

package/dist/compat.js

@@ -4,7 +4,7 @@ import {
   getOpenAIModelCapabilities,
   openaiCompatGenerateProviderOptionsSchema,
   openaiCompatProviderOptionsSchema
-} from "./chunk-IZPTRJP3.js";
+} from "./chunk-FOVN4IGD.js";
 
 // src/compat/provider.ts
 import OpenAI from "openai";

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { a as OpenAIProvider$1, b as OpenAIProviderBaseOptions } from './provider-factory-DaVZWYPo.js';
-export { O as OpenAIChatClient, f as OpenAIChatCompletionsModelOptions, g as OpenAIChatGenerateProviderOptions, h as OpenAIChatProvider, c as OpenAICompatGenerateProviderOptions, d as OpenAICompatRequestOptions, i as OpenAICompatibility, j as OpenAICompatibilityOptions, k as OpenAIEmbedProviderOptions, l as OpenAIImageProviderOptions, m as OpenAIModelCapabilities, n as OpenAIProviderFactoryOptions, p as OpenAIResponsesGenerateProviderOptions, q as OpenAIResponsesProviderOptions, r as OpenAIStructuredOutputMode, s as createOpenAIChatCompletionsModel, t as createOpenAIProvider, u as getOpenAIModelCapabilities, v as openaiChatGenerateProviderOptionsSchema, o as openaiCompatGenerateProviderOptionsSchema, e as openaiCompatProviderOptionsSchema, w as openaiEmbedProviderOptionsSchema, x as openaiImageProviderOptionsSchema, y as openaiResponsesGenerateProviderOptionsSchema, z as openaiResponsesProviderOptionsSchema } from './provider-factory-DaVZWYPo.js';
+import { a as OpenAIProvider$1, b as OpenAIProviderBaseOptions } from './provider-factory-BIr9zZ2d.js';
+export { O as OpenAIChatClient, f as OpenAIChatCompletionsModelOptions, g as OpenAIChatGenerateProviderOptions, h as OpenAIChatGenerateProviderOptionsConfig, i as OpenAIChatProvider, c as OpenAICompatGenerateProviderOptions, d as OpenAICompatRequestOptions, j as OpenAICompatibility, k as OpenAICompatibilityOptions, l as OpenAIEmbedProviderOptions, m as OpenAIImageProviderOptions, n as OpenAIModelCapabilities, p as OpenAIProviderFactoryOptions, q as OpenAIReasoningTokenAccounting, r as OpenAIResponsesGenerateProviderOptions, s as OpenAIResponsesGenerateProviderOptionsConfig, t as OpenAIResponsesProviderOptions, u as OpenAIStructuredOutputMode, v as createOpenAIChatCompletionsModel, w as createOpenAIProvider, x as getOpenAIModelCapabilities, y as openaiChatGenerateProviderOptionsSchema, o as openaiCompatGenerateProviderOptionsSchema, e as openaiCompatProviderOptionsSchema, z as openaiEmbedProviderOptionsSchema, A as openaiImageProviderOptionsSchema, B as openaiResponsesGenerateProviderOptionsSchema, C as openaiResponsesProviderOptionsSchema } from './provider-factory-BIr9zZ2d.js';
 import 'openai';
 import '@core-ai/core-ai';
 import 'zod';

package/dist/index.js

@@ -10,7 +10,7 @@ import {
   openaiImageProviderOptionsSchema,
   openaiResponsesGenerateProviderOptionsSchema,
   openaiResponsesProviderOptionsSchema
-} from "./chunk-IZPTRJP3.js";
+} from "./chunk-FOVN4IGD.js";
 
 // src/provider.ts
 function createOpenAI(options = {}) {

package/dist/{provider-factory-DaVZWYPo.d.ts → provider-factory-BIr9zZ2d.d.ts}

@@ -12,6 +12,13 @@ declare function getOpenAIModelCapabilities(modelId: string): OpenAIModelCapabil
 
 type OpenAIStructuredOutputMode = 'json-schema' | 'tool' | 'json-object';
 
+/**
+ * How an endpoint reports reasoning tokens relative to its output-token total.
+ * `included` (OpenAI): the output total already contains them. `separate`
+ * (e.g. xAI Chat Completions): they are reported only in the details object.
+ */
+type OpenAIReasoningTokenAccounting = 'included' | 'separate';
+
 type OpenAIReasoningCompatibilityOptions = {
     requestField: 'reasoning_content' | 'reasoning';
     providerMetadataKey?: string;
@@ -20,10 +27,12 @@ type OpenAICompatibilityOptions = {
     reasoning?: boolean | OpenAIReasoningCompatibilityOptions;
     structuredOutputMode?: OpenAIStructuredOutputMode;
     maxTokensParameter?: OpenAIChatCompletionsCapabilities['maxTokensParameter'];
+    /** Chat Completions only. Defaults to `included`. */
+    reasoningTokenAccounting?: OpenAIReasoningTokenAccounting;
 };
 type OpenAICompatibility = boolean | OpenAICompatibilityOptions;
 type OpenAIResolvedReasoningCompatibilityOptions = Required<OpenAIReasoningCompatibilityOptions>;
-type OpenAIResolvedCompatibilityOptions = Pick<OpenAICompatibilityOptions, 'structuredOutputMode' | 'maxTokensParameter'> & {
+type OpenAIResolvedCompatibilityOptions = Pick<OpenAICompatibilityOptions, 'structuredOutputMode' | 'maxTokensParameter' | 'reasoningTokenAccounting'> & {
     reasoning: boolean | OpenAIResolvedReasoningCompatibilityOptions;
 };
 
@@ -39,6 +48,7 @@ declare const openaiResponsesGenerateProviderOptionsSchema: z.ZodObject<{
     include: z.ZodOptional<z.ZodArray<z.ZodString>>;
     parallelToolCalls: z.ZodOptional<z.ZodBoolean>;
     user: z.ZodOptional<z.ZodString>;
+    promptCacheKey: z.ZodOptional<z.ZodString>;
 }, z.core.$strict>;
 type OpenAIResponsesGenerateProviderOptions = z.infer<typeof openaiResponsesGenerateProviderOptionsSchema>;
 declare const openaiChatGenerateProviderOptionsSchema: z.ZodObject<{
@@ -52,12 +62,17 @@ declare const openaiChatGenerateProviderOptionsSchema: z.ZodObject<{
         priority: "priority";
     }>>;
     parallelToolCalls: z.ZodOptional<z.ZodBoolean>;
+    promptCacheKey: z.ZodOptional<z.ZodString>;
     stopSequences: z.ZodOptional<z.ZodArray<z.ZodString>>;
     frequencyPenalty: z.ZodOptional<z.ZodNumber>;
     presencePenalty: z.ZodOptional<z.ZodNumber>;
     seed: z.ZodOptional<z.ZodNumber>;
 }, z.core.$strict>;
 type OpenAIChatGenerateProviderOptions = z.infer<typeof openaiChatGenerateProviderOptionsSchema>;
+type OpenAIResponsesGenerateProviderOptionsConfig = {
+    key: string;
+    schema: z.ZodType<OpenAIResponsesGenerateProviderOptions>;
+};
 type OpenAIChatGenerateProviderOptionsConfig = {
     key: string;
     schema: z.ZodType<OpenAIChatGenerateProviderOptions>;
@@ -128,6 +143,7 @@ declare const openaiResponsesProviderOptionsSchema: z.ZodObject<{
     include: z.ZodOptional<z.ZodArray<z.ZodString>>;
     parallelToolCalls: z.ZodOptional<z.ZodBoolean>;
     user: z.ZodOptional<z.ZodString>;
+    promptCacheKey: z.ZodOptional<z.ZodString>;
 }, z.core.$strict>;
 type OpenAIResponsesProviderOptions = OpenAIResponsesGenerateProviderOptions;
 declare const openaiCompatProviderOptionsSchema: z.ZodObject<{
@@ -141,6 +157,7 @@ declare const openaiCompatProviderOptionsSchema: z.ZodObject<{
         priority: "priority";
     }>>;
     parallelToolCalls: z.ZodOptional<z.ZodBoolean>;
+    promptCacheKey: z.ZodOptional<z.ZodString>;
     stopSequences: z.ZodOptional<z.ZodArray<z.ZodString>>;
     frequencyPenalty: z.ZodOptional<z.ZodNumber>;
     presencePenalty: z.ZodOptional<z.ZodNumber>;
@@ -157,6 +174,7 @@ declare const openaiCompatGenerateProviderOptionsSchema: z.ZodObject<{
         priority: "priority";
     }>>;
     parallelToolCalls: z.ZodOptional<z.ZodBoolean>;
+    promptCacheKey: z.ZodOptional<z.ZodString>;
     stopSequences: z.ZodOptional<z.ZodArray<z.ZodString>>;
     frequencyPenalty: z.ZodOptional<z.ZodNumber>;
     presencePenalty: z.ZodOptional<z.ZodNumber>;
@@ -172,6 +190,7 @@ type OpenAIChatCompletionsAdapterOptions = {
     providerId?: string;
     providerOptions?: OpenAIChatGenerateProviderOptionsConfig;
     reasoning?: OpenAIResolvedReasoningCompatibilityOptions;
+    reasoningTokenAccounting?: OpenAIReasoningTokenAccounting;
 };
 
 type OpenAIChatClient = {
@@ -201,12 +220,15 @@ type OpenAIChatProvider = {
 };
 type OpenAIProviderFactoryOptions = {
     modelCapabilities?: ModelCapabilitiesRegistry;
+    /** Also the `providerOptions` and reasoning `providerMetadata` key. */
     providerId?: string;
-    providerOptionsKey?: string;
+    /** Chat Completions provider options schema. */
     providerOptionsSchema?: OpenAIChatGenerateProviderOptionsConfig['schema'];
+    /** Responses API provider options schema. */
+    responsesProviderOptionsSchema?: OpenAIResponsesGenerateProviderOptionsConfig['schema'];
     defaultApi?: 'responses' | 'chat-completions';
     compatibility?: OpenAICompatibility;
 };
 declare function createOpenAIProvider(options: OpenAIProviderBaseOptions, factoryOptions?: OpenAIProviderFactoryOptions): OpenAIProvider;
 
-export { type OpenAIChatClient as O, type OpenAIProvider as a, type OpenAIProviderBaseOptions as b, type OpenAICompatGenerateProviderOptions as c, type OpenAICompatRequestOptions as d, openaiCompatProviderOptionsSchema as e, type OpenAIChatCompletionsModelOptions as f, type OpenAIChatGenerateProviderOptions as g, type OpenAIChatProvider as h, type OpenAICompatibility as i, type OpenAICompatibilityOptions as j, type OpenAIEmbedProviderOptions as k, type OpenAIImageProviderOptions as l, type OpenAIModelCapabilities as m, type OpenAIProviderFactoryOptions as n, openaiCompatGenerateProviderOptionsSchema as o, type OpenAIResponsesGenerateProviderOptions as p, type OpenAIResponsesProviderOptions as q, type OpenAIStructuredOutputMode as r, createOpenAIChatCompletionsModel as s, createOpenAIProvider as t, getOpenAIModelCapabilities as u, openaiChatGenerateProviderOptionsSchema as v, openaiEmbedProviderOptionsSchema as w, openaiImageProviderOptionsSchema as x, openaiResponsesGenerateProviderOptionsSchema as y, openaiResponsesProviderOptionsSchema as z };
+export { openaiImageProviderOptionsSchema as A, openaiResponsesGenerateProviderOptionsSchema as B, openaiResponsesProviderOptionsSchema as C, type OpenAIChatClient as O, type OpenAIProvider as a, type OpenAIProviderBaseOptions as b, type OpenAICompatGenerateProviderOptions as c, type OpenAICompatRequestOptions as d, openaiCompatProviderOptionsSchema as e, type OpenAIChatCompletionsModelOptions as f, type OpenAIChatGenerateProviderOptions as g, type OpenAIChatGenerateProviderOptionsConfig as h, type OpenAIChatProvider as i, type OpenAICompatibility as j, type OpenAICompatibilityOptions as k, type OpenAIEmbedProviderOptions as l, type OpenAIImageProviderOptions as m, type OpenAIModelCapabilities as n, openaiCompatGenerateProviderOptionsSchema as o, type OpenAIProviderFactoryOptions as p, type OpenAIReasoningTokenAccounting as q, type OpenAIResponsesGenerateProviderOptions as r, type OpenAIResponsesGenerateProviderOptionsConfig as s, type OpenAIResponsesProviderOptions as t, type OpenAIStructuredOutputMode as u, createOpenAIChatCompletionsModel as v, createOpenAIProvider as w, getOpenAIModelCapabilities as x, openaiChatGenerateProviderOptionsSchema as y, openaiEmbedProviderOptionsSchema as z };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@core-ai/openai",
-    "version": "0.25.0",
+    "version": "0.26.0",
     "description": "OpenAI provider package for @core-ai/core-ai",
     "license": "MIT",
     "author": "Omnifact (https://omnifact.ai)",
@@ -50,7 +50,7 @@
         "test:watch": "vitest"
     },
     "dependencies": {
-        "@core-ai/core-ai": "^0.25.0",
+        "@core-ai/core-ai": "^0.26.0",
         "openai": "^6.46.0"
     },
     "peerDependencies": {