@x12i/ai-dispatcher 3.2.0 → 3.3.0

package/dist/index.d.cts

@@ -1,5 +1,5 @@
-import { ReasoningEffort, ReasoningOutcome } from '@x12i/ai-profiles';
-export { ReasoningEffort, ReasoningOutcome, registerHostIntents, resolveAIProfile } from '@x12i/ai-profiles';
+import { ReasoningOutcome } from '@x12i/ai-profiles';
+export { ReasoningOutcome, registerHostIntents, resolveAIProfile } from '@x12i/ai-profiles';
 import * as _x12i_openrouter_runtime from '@x12i/openrouter-runtime';
 import { RuntimeToolExecutor, RuntimeLogger, RuntimeRequest, RuntimeResponse, RuntimeUsage, RuntimeStreamEvent, CompiledOpenRouterRequest, OpenRouterRuntimeOptions } from '@x12i/openrouter-runtime';
 export { CompiledOpenRouterRequest, METADATA_NORMALIZATION_MAP, NormalizedMetadataKey, OpenRouterRuntimeOptions, RuntimeDefaults, RuntimeLogger, RuntimeMessage, RuntimeRequest, RuntimeResponse, RuntimeServerToolsPolicy, RuntimeStreamEvent, canonicalMetadataKey, decodeProviderMetadata, normalizeMetadata } from '@x12i/openrouter-runtime';
@@ -95,6 +95,11 @@ interface OpenAiRuntimeOptions {
     logger?: RuntimeLogger;
 }
 
+/**
+ * Effort name for one call.
+ * It is valid when the target model's `reasoning.supportedEfforts` lists it.
+ */
+type ReasoningEffort = string;
 /** Compact and readable write outline. Raw is `JSON.stringify` or the original string. */
 type AiInputMode = "compact" | "readable" | "raw";
 /** Wire codec chosen for one prepared value. Compact and readable default to `outline`. */
@@ -152,9 +157,13 @@ interface RoleStamp {
  * Catalog resolution for one call.
  * `outcome` is present only when the catalog resolver ran.
  * `bypassed` is true when an explicit provider control took precedence.
+ * `sentEffort` is the effort written on the wire. `reportedEffort` is the effort
+ * the provider returned, when it returned one.
  */
 interface ReasoningResolution {
     requestedEffort?: ReasoningEffort;
+    sentEffort?: ReasoningEffort;
+    reportedEffort?: ReasoningEffort;
     target: ImplementedAiProvider;
     requestedModel: string;
     effectiveModel: string;
@@ -214,11 +223,18 @@ interface AiDispatcherRequest extends RuntimeRequest {
      */
     role?: RoleStamp;
     /**
-     * Provider-neutral reasoning intent. `@x12i/ai-profiles` chooses the wire action
-     * from its reasoning catalog. An explicit provider control on the same request
-     * wins and the catalog is not called.
+     * Effort to send. Valid when the target model's `reasoning.supportedEfforts`
+     * lists it. The mapping supplies response paths and the body shape.
+     * The effort string is written unchanged.
+     * An explicit provider control on the same request wins and the catalog is not called.
      */
     reasoningEffort?: ReasoningEffort;
+    /**
+     * Use the mapping's substitution when the requested effort is not in the
+     * model's `supportedEfforts`. The resolution then records both efforts and
+     * `outcome: "degraded"`. Omitted, an unsupported effort fails with `EFFORT_UNSUPPORTED`.
+     */
+    degradeReasoningEffort?: boolean;
     /**
      * Bedrock Converse escape hatch. When `additionalModelRequestFields` is set,
      * it is the explicit reasoning control for Bedrock and the catalog is not applied.
@@ -409,4 +425,4 @@ declare function stripReasoningHistoryFields<T>(message: T, paths: readonly stri
 
 declare function resolveProvider(requestProvider: AiProviderId | undefined, defaultProvider: AiProviderId): ImplementedAiProvider;
 
-export { AI_DISPATCHER_GATE, type AiDispatcher, AiDispatcherError, type AiDispatcherOptions, type AiDispatcherRequest, type AiDispatcherResponse, type AiDispatcherUsage, type AiInputCodec, type AiInputCodecChoice, type AiInputFraming, type AiInputMode, type AiInputReadableFormat, type AiInputSettings, type AiInputSharing, type AiInputTokenizer, type AiProviderAdapter, type AiProviderId, type CacheMode, type CacheOutcome, type CachePolicy, type CacheResolution, type CacheTtl, type CloudflareBackoff, type CloudflareCallContext, type CloudflareEndpoint, type CloudflareEndpointChoice, type CloudflareGatewayControls, type CloudflareRequestOptions, type CloudflareRunOptions, type CloudflareRuntimeOptions, type CloudflareWebhookFormat, type CompiledAiRequest, type CompiledCloudflareRequest, type CompiledOpenAiRequest, DEFAULT_METADATA_PRIORITY, type DispatcherMcpOptions, type DispatcherMcpServer, type DispatcherMcpTool, IMPLEMENTED_AI_PROVIDERS, type ImplementedAiProvider, type InputResolution, type OpenAiRuntimeOptions, type ReasoningResolution, type RoleStamp, createAiDispatcher, isImplementedAiProvider, providerNotImplemented, resolveProvider, stripReasoningHistoryFields };
+export { AI_DISPATCHER_GATE, type AiDispatcher, AiDispatcherError, type AiDispatcherOptions, type AiDispatcherRequest, type AiDispatcherResponse, type AiDispatcherUsage, type AiInputCodec, type AiInputCodecChoice, type AiInputFraming, type AiInputMode, type AiInputReadableFormat, type AiInputSettings, type AiInputSharing, type AiInputTokenizer, type AiProviderAdapter, type AiProviderId, type CacheMode, type CacheOutcome, type CachePolicy, type CacheResolution, type CacheTtl, type CloudflareBackoff, type CloudflareCallContext, type CloudflareEndpoint, type CloudflareEndpointChoice, type CloudflareGatewayControls, type CloudflareRequestOptions, type CloudflareRunOptions, type CloudflareRuntimeOptions, type CloudflareWebhookFormat, type CompiledAiRequest, type CompiledCloudflareRequest, type CompiledOpenAiRequest, DEFAULT_METADATA_PRIORITY, type DispatcherMcpOptions, type DispatcherMcpServer, type DispatcherMcpTool, IMPLEMENTED_AI_PROVIDERS, type ImplementedAiProvider, type InputResolution, type OpenAiRuntimeOptions, type ReasoningEffort, type ReasoningResolution, type RoleStamp, createAiDispatcher, isImplementedAiProvider, providerNotImplemented, resolveProvider, stripReasoningHistoryFields };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { ReasoningEffort, ReasoningOutcome } from '@x12i/ai-profiles';
-export { ReasoningEffort, ReasoningOutcome, registerHostIntents, resolveAIProfile } from '@x12i/ai-profiles';
+import { ReasoningOutcome } from '@x12i/ai-profiles';
+export { ReasoningOutcome, registerHostIntents, resolveAIProfile } from '@x12i/ai-profiles';
 import * as _x12i_openrouter_runtime from '@x12i/openrouter-runtime';
 import { RuntimeToolExecutor, RuntimeLogger, RuntimeRequest, RuntimeResponse, RuntimeUsage, RuntimeStreamEvent, CompiledOpenRouterRequest, OpenRouterRuntimeOptions } from '@x12i/openrouter-runtime';
 export { CompiledOpenRouterRequest, METADATA_NORMALIZATION_MAP, NormalizedMetadataKey, OpenRouterRuntimeOptions, RuntimeDefaults, RuntimeLogger, RuntimeMessage, RuntimeRequest, RuntimeResponse, RuntimeServerToolsPolicy, RuntimeStreamEvent, canonicalMetadataKey, decodeProviderMetadata, normalizeMetadata } from '@x12i/openrouter-runtime';
@@ -95,6 +95,11 @@ interface OpenAiRuntimeOptions {
     logger?: RuntimeLogger;
 }
 
+/**
+ * Effort name for one call.
+ * It is valid when the target model's `reasoning.supportedEfforts` lists it.
+ */
+type ReasoningEffort = string;
 /** Compact and readable write outline. Raw is `JSON.stringify` or the original string. */
 type AiInputMode = "compact" | "readable" | "raw";
 /** Wire codec chosen for one prepared value. Compact and readable default to `outline`. */
@@ -152,9 +157,13 @@ interface RoleStamp {
  * Catalog resolution for one call.
  * `outcome` is present only when the catalog resolver ran.
  * `bypassed` is true when an explicit provider control took precedence.
+ * `sentEffort` is the effort written on the wire. `reportedEffort` is the effort
+ * the provider returned, when it returned one.
  */
 interface ReasoningResolution {
     requestedEffort?: ReasoningEffort;
+    sentEffort?: ReasoningEffort;
+    reportedEffort?: ReasoningEffort;
     target: ImplementedAiProvider;
     requestedModel: string;
     effectiveModel: string;
@@ -214,11 +223,18 @@ interface AiDispatcherRequest extends RuntimeRequest {
      */
     role?: RoleStamp;
     /**
-     * Provider-neutral reasoning intent. `@x12i/ai-profiles` chooses the wire action
-     * from its reasoning catalog. An explicit provider control on the same request
-     * wins and the catalog is not called.
+     * Effort to send. Valid when the target model's `reasoning.supportedEfforts`
+     * lists it. The mapping supplies response paths and the body shape.
+     * The effort string is written unchanged.
+     * An explicit provider control on the same request wins and the catalog is not called.
      */
     reasoningEffort?: ReasoningEffort;
+    /**
+     * Use the mapping's substitution when the requested effort is not in the
+     * model's `supportedEfforts`. The resolution then records both efforts and
+     * `outcome: "degraded"`. Omitted, an unsupported effort fails with `EFFORT_UNSUPPORTED`.
+     */
+    degradeReasoningEffort?: boolean;
     /**
      * Bedrock Converse escape hatch. When `additionalModelRequestFields` is set,
      * it is the explicit reasoning control for Bedrock and the catalog is not applied.
@@ -409,4 +425,4 @@ declare function stripReasoningHistoryFields<T>(message: T, paths: readonly stri
 
 declare function resolveProvider(requestProvider: AiProviderId | undefined, defaultProvider: AiProviderId): ImplementedAiProvider;
 
-export { AI_DISPATCHER_GATE, type AiDispatcher, AiDispatcherError, type AiDispatcherOptions, type AiDispatcherRequest, type AiDispatcherResponse, type AiDispatcherUsage, type AiInputCodec, type AiInputCodecChoice, type AiInputFraming, type AiInputMode, type AiInputReadableFormat, type AiInputSettings, type AiInputSharing, type AiInputTokenizer, type AiProviderAdapter, type AiProviderId, type CacheMode, type CacheOutcome, type CachePolicy, type CacheResolution, type CacheTtl, type CloudflareBackoff, type CloudflareCallContext, type CloudflareEndpoint, type CloudflareEndpointChoice, type CloudflareGatewayControls, type CloudflareRequestOptions, type CloudflareRunOptions, type CloudflareRuntimeOptions, type CloudflareWebhookFormat, type CompiledAiRequest, type CompiledCloudflareRequest, type CompiledOpenAiRequest, DEFAULT_METADATA_PRIORITY, type DispatcherMcpOptions, type DispatcherMcpServer, type DispatcherMcpTool, IMPLEMENTED_AI_PROVIDERS, type ImplementedAiProvider, type InputResolution, type OpenAiRuntimeOptions, type ReasoningResolution, type RoleStamp, createAiDispatcher, isImplementedAiProvider, providerNotImplemented, resolveProvider, stripReasoningHistoryFields };
+export { AI_DISPATCHER_GATE, type AiDispatcher, AiDispatcherError, type AiDispatcherOptions, type AiDispatcherRequest, type AiDispatcherResponse, type AiDispatcherUsage, type AiInputCodec, type AiInputCodecChoice, type AiInputFraming, type AiInputMode, type AiInputReadableFormat, type AiInputSettings, type AiInputSharing, type AiInputTokenizer, type AiProviderAdapter, type AiProviderId, type CacheMode, type CacheOutcome, type CachePolicy, type CacheResolution, type CacheTtl, type CloudflareBackoff, type CloudflareCallContext, type CloudflareEndpoint, type CloudflareEndpointChoice, type CloudflareGatewayControls, type CloudflareRequestOptions, type CloudflareRunOptions, type CloudflareRuntimeOptions, type CloudflareWebhookFormat, type CompiledAiRequest, type CompiledCloudflareRequest, type CompiledOpenAiRequest, DEFAULT_METADATA_PRIORITY, type DispatcherMcpOptions, type DispatcherMcpServer, type DispatcherMcpTool, IMPLEMENTED_AI_PROVIDERS, type ImplementedAiProvider, type InputResolution, type OpenAiRuntimeOptions, type ReasoningEffort, type ReasoningResolution, type RoleStamp, createAiDispatcher, isImplementedAiProvider, providerNotImplemented, resolveProvider, stripReasoningHistoryFields };