@oxy.so/contracts 1.2.0 → 1.4.0

package/dist/types/inference/request.d.ts

@@ -490,7 +490,7 @@ export declare const inferenceMessageSchema: z.ZodEffects<z.ZodObject<{
         type: "refusal";
         text: string;
     })[];
-    role: "tool" | "system" | "user" | "developer" | "assistant";
+    role: "system" | "tool" | "user" | "developer" | "assistant";
     name?: string | undefined;
     toolCallId?: string | undefined;
     toolCalls?: {
@@ -538,7 +538,7 @@ export declare const inferenceMessageSchema: z.ZodEffects<z.ZodObject<{
         type: "refusal";
         text: string;
     })[];
-    role: "tool" | "system" | "user" | "developer" | "assistant";
+    role: "system" | "tool" | "user" | "developer" | "assistant";
     name?: string | undefined;
     toolCallId?: string | undefined;
     toolCalls?: {
@@ -586,7 +586,7 @@ export declare const inferenceMessageSchema: z.ZodEffects<z.ZodObject<{
         type: "refusal";
         text: string;
     })[];
-    role: "tool" | "system" | "user" | "developer" | "assistant";
+    role: "system" | "tool" | "user" | "developer" | "assistant";
     name?: string | undefined;
     toolCallId?: string | undefined;
     toolCalls?: {
@@ -634,7 +634,7 @@ export declare const inferenceMessageSchema: z.ZodEffects<z.ZodObject<{
         type: "refusal";
         text: string;
     })[];
-    role: "tool" | "system" | "user" | "developer" | "assistant";
+    role: "system" | "tool" | "user" | "developer" | "assistant";
     name?: string | undefined;
     toolCallId?: string | undefined;
     toolCalls?: {
@@ -871,7 +871,7 @@ export declare const inferenceInputSchema: z.ZodDiscriminatedUnion<"format", [z.
             type: "refusal";
             text: string;
         })[];
-        role: "tool" | "system" | "user" | "developer" | "assistant";
+        role: "system" | "tool" | "user" | "developer" | "assistant";
         name?: string | undefined;
         toolCallId?: string | undefined;
         toolCalls?: {
@@ -919,7 +919,7 @@ export declare const inferenceInputSchema: z.ZodDiscriminatedUnion<"format", [z.
             type: "refusal";
             text: string;
         })[];
-        role: "tool" | "system" | "user" | "developer" | "assistant";
+        role: "system" | "tool" | "user" | "developer" | "assistant";
         name?: string | undefined;
         toolCallId?: string | undefined;
         toolCalls?: {
@@ -967,7 +967,7 @@ export declare const inferenceInputSchema: z.ZodDiscriminatedUnion<"format", [z.
             type: "refusal";
             text: string;
         })[];
-        role: "tool" | "system" | "user" | "developer" | "assistant";
+        role: "system" | "tool" | "user" | "developer" | "assistant";
         name?: string | undefined;
         toolCallId?: string | undefined;
         toolCalls?: {
@@ -1015,7 +1015,7 @@ export declare const inferenceInputSchema: z.ZodDiscriminatedUnion<"format", [z.
             type: "refusal";
             text: string;
         })[];
-        role: "tool" | "system" | "user" | "developer" | "assistant";
+        role: "system" | "tool" | "user" | "developer" | "assistant";
         name?: string | undefined;
         toolCallId?: string | undefined;
         toolCalls?: {
@@ -1066,7 +1066,7 @@ export declare const inferenceInputSchema: z.ZodDiscriminatedUnion<"format", [z.
             type: "refusal";
             text: string;
         })[];
-        role: "tool" | "system" | "user" | "developer" | "assistant";
+        role: "system" | "tool" | "user" | "developer" | "assistant";
         name?: string | undefined;
         toolCallId?: string | undefined;
         toolCalls?: {
@@ -1117,7 +1117,7 @@ export declare const inferenceInputSchema: z.ZodDiscriminatedUnion<"format", [z.
             type: "refusal";
             text: string;
         })[];
-        role: "tool" | "system" | "user" | "developer" | "assistant";
+        role: "system" | "tool" | "user" | "developer" | "assistant";
         name?: string | undefined;
         toolCallId?: string | undefined;
         toolCalls?: {
@@ -1237,6 +1237,20 @@ export declare const responseFormatSchema: z.ZodDiscriminatedUnion<"type", [z.Zo
     name: string;
     strict: boolean;
 }>]>;
+/**
+ * The caller's reasoning control. Strict, like every leaf: a provider-specific
+ * knob (`budget_tokens`, `summary`) is refused rather than silently dropped.
+ *
+ * Oxy forwards it only after checking the resolved model advertises the effort
+ * in its catalogue `reasoningEfforts`; Kaana translates it per provider.
+ */
+export declare const inferenceReasoningSchema: z.ZodObject<{
+    effort: z.ZodEnum<["low", "medium", "high"]>;
+}, "strict", z.ZodTypeAny, {
+    effort: "low" | "medium" | "high";
+}, {
+    effort: "low" | "medium" | "high";
+}>;
 /**
  * What the edge records about the CALL, as opposed to its content.
  *
@@ -1272,6 +1286,21 @@ export declare const clientRequestMetadataSchema: z.ZodObject<{
     clientRequestId?: string | undefined;
     labels?: Record<string, string> | undefined;
 }>;
+/** Parameters for text-to-speech, preserved in the signed request. */
+export declare const inferenceSpeechParametersSchema: z.ZodObject<{
+    voice: z.ZodString;
+    responseFormat: z.ZodEnum<["mp3", "opus", "aac", "flac", "wav", "pcm"]>;
+    speed: z.ZodOptional<z.ZodNumber>;
+}, "strict", z.ZodTypeAny, {
+    voice: string;
+    responseFormat: "mp3" | "opus" | "aac" | "flac" | "wav" | "pcm";
+    speed?: number | undefined;
+}, {
+    voice: string;
+    responseFormat: "mp3" | "opus" | "aac" | "flac" | "wav" | "pcm";
+    speed?: number | undefined;
+}>;
+export type InferenceSpeechParameters = z.infer<typeof inferenceSpeechParametersSchema>;
 /**
  * The canonical internal request Oxy forwards to the data plane.
  *
@@ -1583,7 +1612,7 @@ export declare const inferenceRequestSchema: z.ZodEffects<z.ZodObject<{
                 type: "refusal";
                 text: string;
             })[];
-            role: "tool" | "system" | "user" | "developer" | "assistant";
+            role: "system" | "tool" | "user" | "developer" | "assistant";
             name?: string | undefined;
             toolCallId?: string | undefined;
             toolCalls?: {
@@ -1631,7 +1660,7 @@ export declare const inferenceRequestSchema: z.ZodEffects<z.ZodObject<{
                 type: "refusal";
                 text: string;
             })[];
-            role: "tool" | "system" | "user" | "developer" | "assistant";
+            role: "system" | "tool" | "user" | "developer" | "assistant";
             name?: string | undefined;
             toolCallId?: string | undefined;
             toolCalls?: {
@@ -1679,7 +1708,7 @@ export declare const inferenceRequestSchema: z.ZodEffects<z.ZodObject<{
                 type: "refusal";
                 text: string;
             })[];
-            role: "tool" | "system" | "user" | "developer" | "assistant";
+            role: "system" | "tool" | "user" | "developer" | "assistant";
             name?: string | undefined;
             toolCallId?: string | undefined;
             toolCalls?: {
@@ -1727,7 +1756,7 @@ export declare const inferenceRequestSchema: z.ZodEffects<z.ZodObject<{
                 type: "refusal";
                 text: string;
             })[];
-            role: "tool" | "system" | "user" | "developer" | "assistant";
+            role: "system" | "tool" | "user" | "developer" | "assistant";
             name?: string | undefined;
             toolCallId?: string | undefined;
             toolCalls?: {
@@ -1778,7 +1807,7 @@ export declare const inferenceRequestSchema: z.ZodEffects<z.ZodObject<{
                 type: "refusal";
                 text: string;
             })[];
-            role: "tool" | "system" | "user" | "developer" | "assistant";
+            role: "system" | "tool" | "user" | "developer" | "assistant";
             name?: string | undefined;
             toolCallId?: string | undefined;
             toolCalls?: {
@@ -1829,7 +1858,7 @@ export declare const inferenceRequestSchema: z.ZodEffects<z.ZodObject<{
                 type: "refusal";
                 text: string;
             })[];
-            role: "tool" | "system" | "user" | "developer" | "assistant";
+            role: "system" | "tool" | "user" | "developer" | "assistant";
             name?: string | undefined;
             toolCallId?: string | undefined;
             toolCalls?: {
@@ -1885,6 +1914,27 @@ export declare const inferenceRequestSchema: z.ZodEffects<z.ZodObject<{
         presencePenalty?: number | undefined;
         stopSequences?: string[] | undefined;
     }>;
+    /** Absent means the route's own default reasoning behaviour. */
+    reasoning: z.ZodOptional<z.ZodObject<{
+        effort: z.ZodEnum<["low", "medium", "high"]>;
+    }, "strict", z.ZodTypeAny, {
+        effort: "low" | "medium" | "high";
+    }, {
+        effort: "low" | "medium" | "high";
+    }>>;
+    speech: z.ZodOptional<z.ZodObject<{
+        voice: z.ZodString;
+        responseFormat: z.ZodEnum<["mp3", "opus", "aac", "flac", "wav", "pcm"]>;
+        speed: z.ZodOptional<z.ZodNumber>;
+    }, "strict", z.ZodTypeAny, {
+        voice: string;
+        responseFormat: "mp3" | "opus" | "aac" | "flac" | "wav" | "pcm";
+        speed?: number | undefined;
+    }, {
+        voice: string;
+        responseFormat: "mp3" | "opus" | "aac" | "flac" | "wav" | "pcm";
+        speed?: number | undefined;
+    }>>;
     tools: z.ZodDefault<z.ZodArray<z.ZodObject<{
         type: z.ZodLiteral<"function">;
         name: z.ZodString;
@@ -2249,7 +2299,7 @@ export declare const inferenceRequestSchema: z.ZodEffects<z.ZodObject<{
                 type: "refusal";
                 text: string;
             })[];
-            role: "tool" | "system" | "user" | "developer" | "assistant";
+            role: "system" | "tool" | "user" | "developer" | "assistant";
             name?: string | undefined;
             toolCallId?: string | undefined;
             toolCalls?: {
@@ -2280,11 +2330,10 @@ export declare const inferenceRequestSchema: z.ZodEffects<z.ZodObject<{
         policyVersion: number;
     };
     idempotencyKey?: string | undefined;
-    maxOutputTokens?: number | undefined;
-    toolChoice?: "none" | "required" | "auto" | {
-        type: "function";
-        name: string;
+    reasoning?: {
+        effort: "low" | "medium" | "high";
     } | undefined;
+    maxOutputTokens?: number | undefined;
     responseFormat?: {
         type: "text";
     } | {
@@ -2295,6 +2344,15 @@ export declare const inferenceRequestSchema: z.ZodEffects<z.ZodObject<{
         name: string;
         strict: boolean;
     } | undefined;
+    speech?: {
+        voice: string;
+        responseFormat: "mp3" | "opus" | "aac" | "flac" | "wav" | "pcm";
+        speed?: number | undefined;
+    } | undefined;
+    toolChoice?: "none" | "required" | "auto" | {
+        type: "function";
+        name: string;
+    } | undefined;
     authorizedRoutes?: ({
         provider: string;
         modelReference: string;
@@ -2396,7 +2454,7 @@ export declare const inferenceRequestSchema: z.ZodEffects<z.ZodObject<{
                 type: "refusal";
                 text: string;
             })[];
-            role: "tool" | "system" | "user" | "developer" | "assistant";
+            role: "system" | "tool" | "user" | "developer" | "assistant";
             name?: string | undefined;
             toolCallId?: string | undefined;
             toolCalls?: {
@@ -2434,11 +2492,10 @@ export declare const inferenceRequestSchema: z.ZodEffects<z.ZodObject<{
         strict?: boolean | undefined;
     }[] | undefined;
     idempotencyKey?: string | undefined;
-    maxOutputTokens?: number | undefined;
-    toolChoice?: "none" | "required" | "auto" | {
-        type: "function";
-        name: string;
+    reasoning?: {
+        effort: "low" | "medium" | "high";
     } | undefined;
+    maxOutputTokens?: number | undefined;
     responseFormat?: {
         type: "text";
     } | {
@@ -2449,6 +2506,15 @@ export declare const inferenceRequestSchema: z.ZodEffects<z.ZodObject<{
         name: string;
         strict: boolean;
     } | undefined;
+    speech?: {
+        voice: string;
+        responseFormat: "mp3" | "opus" | "aac" | "flac" | "wav" | "pcm";
+        speed?: number | undefined;
+    } | undefined;
+    toolChoice?: "none" | "required" | "auto" | {
+        type: "function";
+        name: string;
+    } | undefined;
     authorizedRoutes?: ({
         provider: string;
         modelReference: string;
@@ -2557,7 +2623,7 @@ export declare const inferenceRequestSchema: z.ZodEffects<z.ZodObject<{
                 type: "refusal";
                 text: string;
             })[];
-            role: "tool" | "system" | "user" | "developer" | "assistant";
+            role: "system" | "tool" | "user" | "developer" | "assistant";
             name?: string | undefined;
             toolCallId?: string | undefined;
             toolCalls?: {
@@ -2588,11 +2654,10 @@ export declare const inferenceRequestSchema: z.ZodEffects<z.ZodObject<{
         policyVersion: number;
     };
     idempotencyKey?: string | undefined;
-    maxOutputTokens?: number | undefined;
-    toolChoice?: "none" | "required" | "auto" | {
-        type: "function";
-        name: string;
+    reasoning?: {
+        effort: "low" | "medium" | "high";
     } | undefined;
+    maxOutputTokens?: number | undefined;
     responseFormat?: {
         type: "text";
     } | {
@@ -2603,6 +2668,15 @@ export declare const inferenceRequestSchema: z.ZodEffects<z.ZodObject<{
         name: string;
         strict: boolean;
     } | undefined;
+    speech?: {
+        voice: string;
+        responseFormat: "mp3" | "opus" | "aac" | "flac" | "wav" | "pcm";
+        speed?: number | undefined;
+    } | undefined;
+    toolChoice?: "none" | "required" | "auto" | {
+        type: "function";
+        name: string;
+    } | undefined;
     authorizedRoutes?: ({
         provider: string;
         modelReference: string;
@@ -2704,7 +2778,7 @@ export declare const inferenceRequestSchema: z.ZodEffects<z.ZodObject<{
                 type: "refusal";
                 text: string;
             })[];
-            role: "tool" | "system" | "user" | "developer" | "assistant";
+            role: "system" | "tool" | "user" | "developer" | "assistant";
             name?: string | undefined;
             toolCallId?: string | undefined;
             toolCalls?: {
@@ -2742,11 +2816,10 @@ export declare const inferenceRequestSchema: z.ZodEffects<z.ZodObject<{
         strict?: boolean | undefined;
     }[] | undefined;
     idempotencyKey?: string | undefined;
-    maxOutputTokens?: number | undefined;
-    toolChoice?: "none" | "required" | "auto" | {
-        type: "function";
-        name: string;
+    reasoning?: {
+        effort: "low" | "medium" | "high";
     } | undefined;
+    maxOutputTokens?: number | undefined;
     responseFormat?: {
         type: "text";
     } | {
@@ -2757,6 +2830,15 @@ export declare const inferenceRequestSchema: z.ZodEffects<z.ZodObject<{
         name: string;
         strict: boolean;
     } | undefined;
+    speech?: {
+        voice: string;
+        responseFormat: "mp3" | "opus" | "aac" | "flac" | "wav" | "pcm";
+        speed?: number | undefined;
+    } | undefined;
+    toolChoice?: "none" | "required" | "auto" | {
+        type: "function";
+        name: string;
+    } | undefined;
     authorizedRoutes?: ({
         provider: string;
         modelReference: string;
@@ -2793,6 +2875,7 @@ export type InferenceMessageRole = z.infer<typeof inferenceMessageRoleSchema>;
 export type InferenceMessage = z.infer<typeof inferenceMessageSchema>;
 export type InferenceInput = z.infer<typeof inferenceInputSchema>;
 export type SamplingParameters = z.infer<typeof samplingParametersSchema>;
+export type InferenceReasoning = z.infer<typeof inferenceReasoningSchema>;
 export type ToolDefinition = z.infer<typeof toolDefinitionSchema>;
 export type ToolChoice = z.infer<typeof toolChoiceSchema>;
 export type ResponseFormat = z.infer<typeof responseFormatSchema>;

package/dist/types/inference/streamEvents.d.ts

@@ -2,7 +2,7 @@
  * Normalized stream events — what the data plane emits and the Oxy edge
  * forwards as SSE.
  *
- * One discriminated union, seven shapes, all carrying `requestId` and a
+ * One discriminated union, eight shapes, all carrying `requestId` and a
  * monotonic `sequence`. `requestId` is on EVERY event rather than only the
  * first because a proxy that re-frames or a client that reconnects would
  * otherwise be holding events it cannot attribute; `sequence` is what makes a
@@ -93,6 +93,37 @@ export declare const inferenceStreamDeltaEventSchema: z.ZodObject<{
     sequence: number;
     outputIndex: number;
 }>;
+/** The encodings an audio output may carry. */
+export declare const inferenceAudioMediaTypeSchema: z.ZodEnum<["audio/mpeg", "audio/wav", "audio/ogg", "audio/aac", "audio/flac", "audio/pcm"]>;
+export type InferenceAudioMediaType = z.infer<typeof inferenceAudioMediaTypeSchema>;
+/** The most bytes one folded audio output may hold, at the edge and in the SDK. */
+export declare const MAX_INFERENCE_AUDIO_BYTES: number;
+/** A bounded, independently base64-encoded chunk of one audio output. */
+export declare const inferenceStreamAudioEventSchema: z.ZodObject<{
+    schemaVersion: z.ZodLiteral<1>;
+    type: z.ZodLiteral<"audio">;
+    requestId: z.ZodString;
+    sequence: z.ZodNumber;
+    outputIndex: z.ZodNumber;
+    mediaType: z.ZodEnum<["audio/mpeg", "audio/wav", "audio/ogg", "audio/aac", "audio/flac", "audio/pcm"]>;
+    data: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "audio";
+    schemaVersion: 1;
+    data: string;
+    requestId: string;
+    mediaType: "audio/mpeg" | "audio/wav" | "audio/ogg" | "audio/aac" | "audio/flac" | "audio/pcm";
+    sequence: number;
+    outputIndex: number;
+}, {
+    type: "audio";
+    schemaVersion: 1;
+    data: string;
+    requestId: string;
+    mediaType: "audio/mpeg" | "audio/wav" | "audio/ogg" | "audio/aac" | "audio/flac" | "audio/pcm";
+    sequence: number;
+    outputIndex: number;
+}>;
 /**
  * A tool call being streamed.
  *
@@ -610,6 +641,30 @@ export declare const inferenceStreamEventSchema: z.ZodDiscriminatedUnion<"type",
     text: string;
     sequence: number;
     outputIndex: number;
+}>, z.ZodObject<{
+    schemaVersion: z.ZodLiteral<1>;
+    type: z.ZodLiteral<"audio">;
+    requestId: z.ZodString;
+    sequence: z.ZodNumber;
+    outputIndex: z.ZodNumber;
+    mediaType: z.ZodEnum<["audio/mpeg", "audio/wav", "audio/ogg", "audio/aac", "audio/flac", "audio/pcm"]>;
+    data: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "audio";
+    schemaVersion: 1;
+    data: string;
+    requestId: string;
+    mediaType: "audio/mpeg" | "audio/wav" | "audio/ogg" | "audio/aac" | "audio/flac" | "audio/pcm";
+    sequence: number;
+    outputIndex: number;
+}, {
+    type: "audio";
+    schemaVersion: 1;
+    data: string;
+    requestId: string;
+    mediaType: "audio/mpeg" | "audio/wav" | "audio/ogg" | "audio/aac" | "audio/flac" | "audio/pcm";
+    sequence: number;
+    outputIndex: number;
 }>, z.ZodObject<{
     /** See `version.ts`: each stream event is a whole message on the wire. */
     schemaVersion: z.ZodLiteral<1>;
@@ -939,6 +994,7 @@ export declare const inferenceStreamEventSchema: z.ZodDiscriminatedUnion<"type",
 }>]>;
 export type InferenceStreamStartEvent = z.infer<typeof inferenceStreamStartEventSchema>;
 export type InferenceStreamDeltaEvent = z.infer<typeof inferenceStreamDeltaEventSchema>;
+export type InferenceStreamAudioEvent = z.infer<typeof inferenceStreamAudioEventSchema>;
 export type InferenceStreamToolCallEvent = z.infer<typeof inferenceStreamToolCallEventSchema>;
 export type InferenceStreamUsageEvent = z.infer<typeof inferenceStreamUsageEventSchema>;
 export type InferenceRouteSwitchDetail = z.infer<typeof inferenceRouteSwitchDetailSchema>;

package/dist/types/inference/version.d.ts

@@ -99,4 +99,4 @@
  * change to, say, the catalogue reject every in-flight inference request; the
  * per-shape `schemaVersion` is what a message is validated against.
  */
-export declare const INFERENCE_CONTRACT_VERSION = "3.0.0";
+export declare const INFERENCE_CONTRACT_VERSION = "3.1.0";

package/dist/types/keyRotation.d.ts

@@ -72,17 +72,17 @@ export declare const rotateKeyCompleteRequestSchema: z.ZodObject<{
     signOutEverywhere: z.ZodOptional<z.ZodBoolean>;
 }, "strip", z.ZodTypeAny, {
     signature: string;
-    timestamp: number;
     challenge: string;
     newPublicKey: string;
     newKeyProof: string;
+    timestamp: number;
     signOutEverywhere?: boolean | undefined;
 }, {
     signature: string;
-    timestamp: number;
     challenge: string;
     newPublicKey: string;
     newKeyProof: string;
+    timestamp: number;
     signOutEverywhere?: boolean | undefined;
 }>;
 export type RotateKeyCompleteRequest = z.infer<typeof rotateKeyCompleteRequestSchema>;