@canarycoders/ai 0.4.0 → 0.6.0

package/dist/index.d.cts

@@ -6,15 +6,18 @@ export { b as RealtimeKind, c as RealtimeTool } from './realtime-BWDkXcj9.cjs';
 type FetchLike = typeof globalThis.fetch;
 
 /** Every provider the gateway can route to. */
-type ProviderType = "gemini" | "vertex" | "openai" | "anthropic" | "xai" | "lmstudio" | "ollama" | "perplexity" | "elevenlabs" | "mlxaudio" | "vision" | "gcvision";
+type ProviderType = "gemini" | "vertex" | "openai" | "anthropic" | "xai" | "lmstudio" | "ollama" | "perplexity" | "elevenlabs" | "mlxaudio" | "vision" | "gcvision" | "zhipu" | "moonshot";
 /** Providers that serve text chat / completion. */
-type ChatProvider = "gemini" | "vertex" | "openai" | "anthropic" | "xai" | "lmstudio" | "ollama" | "perplexity";
+type ChatProvider = "gemini" | "vertex" | "openai" | "anthropic" | "xai" | "lmstudio" | "ollama" | "perplexity" | "zhipu" | "moonshot";
 type ModelCapability = "chat" | "vision" | "image-generation" | "video-generation" | "text-to-speech" | "speech-to-text" | "image-recognition" | "face-detection" | "web-detection" | "conversation" | "sound-effect" | "music-generation" | "dialogue" | "realtime-voice" | "realtime-translate" | "realtime-transcribe" | "embeddings" | "reasoning";
 interface TokenUsage {
     inputTokens: number;
     outputTokens: number;
     totalTokens: number;
+    /** Cache-read tokens (subset of inputTokens), billed at the cached-input rate. */
     cachedTokens?: number;
+    /** Anthropic only: cache-write tokens (billed at 1.25x input). */
+    cacheCreationTokens?: number;
     reasoningTokens?: number;
 }
 interface ModelInfo {
@@ -57,7 +60,7 @@ interface Citation {
     startIndex?: number;
     endIndex?: number;
 }
-/** The standard CanaryLLM success envelope: `{ success: true, data: T }`. */
+/** The standard CanaryCoders AI success envelope: `{ success: true, data: T }`. */
 interface ApiEnvelope<T> {
     success: boolean;
     data: T;
@@ -124,6 +127,12 @@ interface CreateConversationSessionParams {
 interface ConversationSession {
     session: ConversationSessionRecord;
     signedUrl: string;
+    /**
+     * Pass verbatim into the ElevenLabs client's `Conversation.startSession({ dynamicVariables })`
+     * so the post-call webhook correlates this session deterministically. Contains
+     * `canary_session_id` (this session's id).
+     */
+    dynamicVariables: Record<string, string>;
     /** seconds until the signed URL expires (≈900) */
     expiresIn: number;
     textOnly: boolean;
@@ -291,6 +300,15 @@ interface CompleteParams {
     tools?: ToolDefinition[];
     toolChoice?: ToolChoice;
     thinkingMode?: ThinkingMode;
+    /**
+     * Anthropic only: opt into prompt caching. The gateway places cache_control
+     * breakpoints on the system prompt and the last message (5-minute TTL).
+     */
+    promptCaching?: boolean;
+    /** OpenAI only: stable cache-routing key (per conversation/workload) to raise automatic cache hits. */
+    promptCacheKey?: string;
+    /** OpenAI only: stable end-user identifier, also used for cache routing. */
+    safetyIdentifier?: string;
     webSearch?: WebSearchOptions;
     cache?: {
         enabled?: boolean;
@@ -971,7 +989,7 @@ declare class VisionResource extends BaseResource {
     }>;
 }
 
-interface CanaryLLMOptions {
+interface CanaryCodersAIOptions {
     /** API key. Defaults to `process.env.CANARY_AI_API_KEY` (legacy `CANARYLLM_API_KEY` still read). */
     apiKey?: string;
     /** Base URL. Defaults to `https://api.ai.canarycoders.es`. */
@@ -990,7 +1008,7 @@ interface CanaryLLMOptions {
     /** Default polling behavior for queued operations. */
     poll?: PollOptions;
 }
-declare class CanaryLLM {
+declare class CanaryCodersAI {
     readonly chat: ChatResource;
     readonly queue: QueueResource;
     readonly images: ImagesResource;
@@ -1009,7 +1027,7 @@ declare class CanaryLLM {
     private readonly transport;
     private readonly baseURL;
     private readonly apiKey?;
-    constructor(options?: CanaryLLMOptions);
+    constructor(options?: CanaryCodersAIOptions);
     /** Targets to plug into the official `openai` / `@anthropic-ai/sdk` clients. */
     get compat(): {
         openai: () => CompatTarget;
@@ -1081,5 +1099,5 @@ interface StreamAdapterOptions extends SSEOptions {
 }
 
 // @ts-ignore
-export = CanaryLLM;
-export { APIConnectionError, APIConnectionTimeoutError, APIError, type ApiEnvelope, type AudioOutputFormat, AuthenticationError, type AutoLabelParams, type AutoLabelResult, type AutoTrainParams, BadRequestError, type BoundingBox, BrokeredCredential, CanaryLLM, type CanaryLLMOptions, type ChatProvider, type ChatStreamEvent, type ChatStreamOptions, type Citation, CompatTarget, type CompleteParams, type CompletionResult, ConflictError, type ContentPart, type ConversationQuestion, type ConversationSession, type ConversationSessionRecord, type ConversationTemplate, type ConversationTemplateParams, type ConversationTemplateType, type ConversationTemplateUpdate, type ConversationTool, type ConversationVoiceSettings, type CreateConversationSessionParams, CreateRealtimeSessionParams, type DetectParams, type Detection, type DialogueInput, type DialogueParams, type DialogueResult, type DocumentContent, type EmbeddingParams, type EmbeddingResult, type FaceDetectParams, type FaceDetectionResult, FinalizeRealtimeParams, type GeneratedImage, type GeneratedVideo, type ImageContent, type ImageGenerateParams, type ImageGenerationResult, type ImageRecognitionResult, InternalServerError, Job, type JobSnapshot, type JobStatus, type JobStreamOptions, type KeyInfo, type KeyValidation, type Message, type MessageContent, type MessageRole, type ModelCapability, type ModelInfo, type MusicParams, type MusicResult, NotFoundError, PermissionError, type PollOptions, type PortalPeriod, type ProviderType, RateLimitError, RealtimeSession, RealtimeSessionRecord, type ResponseFormat, type STTResult, type SignedUrlParams, type SignedUrlResult, type SoundEffectParams, type SoundEffectResult, type SpeechParams, type StreamAdapterOptions, type StreamChunk, type StreamProtocol, type TTSResult, type TaskKind, type TextContent, type ThinkingMode, type TokenUsage, type ToolCall, type ToolCallDelta, type ToolChoice, type ToolDefinition, type TrainParams, type TrainingJob, type TranscribeParams, type TranscriptWord, UnprocessableEntityError, type UsageSummary, type VideoContent, type VideoGenerateParams, type VideoGenerationResult, type VideoUploadOptions, type VideoUploadResult, type VisionModel, type VoiceInfo, type VoiceSettings, type WebDetectParams, type WebDetectionResult, type WebEntity, type WebSearchOptions, type ZeroShotDetectParams, toBrokeredCredential };
+export = CanaryCodersAI;
+export { APIConnectionError, APIConnectionTimeoutError, APIError, type ApiEnvelope, type AudioOutputFormat, AuthenticationError, type AutoLabelParams, type AutoLabelResult, type AutoTrainParams, BadRequestError, type BoundingBox, BrokeredCredential, CanaryCodersAI, type CanaryCodersAIOptions, CanaryCodersAI as CanaryLLM, type CanaryCodersAIOptions as CanaryLLMOptions, type ChatProvider, type ChatStreamEvent, type ChatStreamOptions, type Citation, CompatTarget, type CompleteParams, type CompletionResult, ConflictError, type ContentPart, type ConversationQuestion, type ConversationSession, type ConversationSessionRecord, type ConversationTemplate, type ConversationTemplateParams, type ConversationTemplateType, type ConversationTemplateUpdate, type ConversationTool, type ConversationVoiceSettings, type CreateConversationSessionParams, CreateRealtimeSessionParams, type DetectParams, type Detection, type DialogueInput, type DialogueParams, type DialogueResult, type DocumentContent, type EmbeddingParams, type EmbeddingResult, type FaceDetectParams, type FaceDetectionResult, FinalizeRealtimeParams, type GeneratedImage, type GeneratedVideo, type ImageContent, type ImageGenerateParams, type ImageGenerationResult, type ImageRecognitionResult, InternalServerError, Job, type JobSnapshot, type JobStatus, type JobStreamOptions, type KeyInfo, type KeyValidation, type Message, type MessageContent, type MessageRole, type ModelCapability, type ModelInfo, type MusicParams, type MusicResult, NotFoundError, PermissionError, type PollOptions, type PortalPeriod, type ProviderType, RateLimitError, RealtimeSession, RealtimeSessionRecord, type ResponseFormat, type STTResult, type SignedUrlParams, type SignedUrlResult, type SoundEffectParams, type SoundEffectResult, type SpeechParams, type StreamAdapterOptions, type StreamChunk, type StreamProtocol, type TTSResult, type TaskKind, type TextContent, type ThinkingMode, type TokenUsage, type ToolCall, type ToolCallDelta, type ToolChoice, type ToolDefinition, type TrainParams, type TrainingJob, type TranscribeParams, type TranscriptWord, UnprocessableEntityError, type UsageSummary, type VideoContent, type VideoGenerateParams, type VideoGenerationResult, type VideoUploadOptions, type VideoUploadResult, type VisionModel, type VoiceInfo, type VoiceSettings, type WebDetectParams, type WebDetectionResult, type WebEntity, type WebSearchOptions, type ZeroShotDetectParams, toBrokeredCredential };

package/dist/index.d.ts

@@ -6,15 +6,18 @@ export { b as RealtimeKind, c as RealtimeTool } from './realtime-BWDkXcj9.js';
 type FetchLike = typeof globalThis.fetch;
 
 /** Every provider the gateway can route to. */
-type ProviderType = "gemini" | "vertex" | "openai" | "anthropic" | "xai" | "lmstudio" | "ollama" | "perplexity" | "elevenlabs" | "mlxaudio" | "vision" | "gcvision";
+type ProviderType = "gemini" | "vertex" | "openai" | "anthropic" | "xai" | "lmstudio" | "ollama" | "perplexity" | "elevenlabs" | "mlxaudio" | "vision" | "gcvision" | "zhipu" | "moonshot";
 /** Providers that serve text chat / completion. */
-type ChatProvider = "gemini" | "vertex" | "openai" | "anthropic" | "xai" | "lmstudio" | "ollama" | "perplexity";
+type ChatProvider = "gemini" | "vertex" | "openai" | "anthropic" | "xai" | "lmstudio" | "ollama" | "perplexity" | "zhipu" | "moonshot";
 type ModelCapability = "chat" | "vision" | "image-generation" | "video-generation" | "text-to-speech" | "speech-to-text" | "image-recognition" | "face-detection" | "web-detection" | "conversation" | "sound-effect" | "music-generation" | "dialogue" | "realtime-voice" | "realtime-translate" | "realtime-transcribe" | "embeddings" | "reasoning";
 interface TokenUsage {
     inputTokens: number;
     outputTokens: number;
     totalTokens: number;
+    /** Cache-read tokens (subset of inputTokens), billed at the cached-input rate. */
     cachedTokens?: number;
+    /** Anthropic only: cache-write tokens (billed at 1.25x input). */
+    cacheCreationTokens?: number;
     reasoningTokens?: number;
 }
 interface ModelInfo {
@@ -57,7 +60,7 @@ interface Citation {
     startIndex?: number;
     endIndex?: number;
 }
-/** The standard CanaryLLM success envelope: `{ success: true, data: T }`. */
+/** The standard CanaryCoders AI success envelope: `{ success: true, data: T }`. */
 interface ApiEnvelope<T> {
     success: boolean;
     data: T;
@@ -124,6 +127,12 @@ interface CreateConversationSessionParams {
 interface ConversationSession {
     session: ConversationSessionRecord;
     signedUrl: string;
+    /**
+     * Pass verbatim into the ElevenLabs client's `Conversation.startSession({ dynamicVariables })`
+     * so the post-call webhook correlates this session deterministically. Contains
+     * `canary_session_id` (this session's id).
+     */
+    dynamicVariables: Record<string, string>;
     /** seconds until the signed URL expires (≈900) */
     expiresIn: number;
     textOnly: boolean;
@@ -291,6 +300,15 @@ interface CompleteParams {
     tools?: ToolDefinition[];
     toolChoice?: ToolChoice;
     thinkingMode?: ThinkingMode;
+    /**
+     * Anthropic only: opt into prompt caching. The gateway places cache_control
+     * breakpoints on the system prompt and the last message (5-minute TTL).
+     */
+    promptCaching?: boolean;
+    /** OpenAI only: stable cache-routing key (per conversation/workload) to raise automatic cache hits. */
+    promptCacheKey?: string;
+    /** OpenAI only: stable end-user identifier, also used for cache routing. */
+    safetyIdentifier?: string;
     webSearch?: WebSearchOptions;
     cache?: {
         enabled?: boolean;
@@ -971,7 +989,7 @@ declare class VisionResource extends BaseResource {
     }>;
 }
 
-interface CanaryLLMOptions {
+interface CanaryCodersAIOptions {
     /** API key. Defaults to `process.env.CANARY_AI_API_KEY` (legacy `CANARYLLM_API_KEY` still read). */
     apiKey?: string;
     /** Base URL. Defaults to `https://api.ai.canarycoders.es`. */
@@ -990,7 +1008,7 @@ interface CanaryLLMOptions {
     /** Default polling behavior for queued operations. */
     poll?: PollOptions;
 }
-declare class CanaryLLM {
+declare class CanaryCodersAI {
     readonly chat: ChatResource;
     readonly queue: QueueResource;
     readonly images: ImagesResource;
@@ -1009,7 +1027,7 @@ declare class CanaryLLM {
     private readonly transport;
     private readonly baseURL;
     private readonly apiKey?;
-    constructor(options?: CanaryLLMOptions);
+    constructor(options?: CanaryCodersAIOptions);
     /** Targets to plug into the official `openai` / `@anthropic-ai/sdk` clients. */
     get compat(): {
         openai: () => CompatTarget;
@@ -1080,4 +1098,4 @@ interface StreamAdapterOptions extends SSEOptions {
     includeRaw?: boolean;
 }
 
-export { APIConnectionError, APIConnectionTimeoutError, APIError, type ApiEnvelope, type AudioOutputFormat, AuthenticationError, type AutoLabelParams, type AutoLabelResult, type AutoTrainParams, BadRequestError, type BoundingBox, BrokeredCredential, CanaryLLM, type CanaryLLMOptions, type ChatProvider, type ChatStreamEvent, type ChatStreamOptions, type Citation, CompatTarget, type CompleteParams, type CompletionResult, ConflictError, type ContentPart, type ConversationQuestion, type ConversationSession, type ConversationSessionRecord, type ConversationTemplate, type ConversationTemplateParams, type ConversationTemplateType, type ConversationTemplateUpdate, type ConversationTool, type ConversationVoiceSettings, type CreateConversationSessionParams, CreateRealtimeSessionParams, type DetectParams, type Detection, type DialogueInput, type DialogueParams, type DialogueResult, type DocumentContent, type EmbeddingParams, type EmbeddingResult, type FaceDetectParams, type FaceDetectionResult, FinalizeRealtimeParams, type GeneratedImage, type GeneratedVideo, type ImageContent, type ImageGenerateParams, type ImageGenerationResult, type ImageRecognitionResult, InternalServerError, Job, type JobSnapshot, type JobStatus, type JobStreamOptions, type KeyInfo, type KeyValidation, type Message, type MessageContent, type MessageRole, type ModelCapability, type ModelInfo, type MusicParams, type MusicResult, NotFoundError, PermissionError, type PollOptions, type PortalPeriod, type ProviderType, RateLimitError, RealtimeSession, RealtimeSessionRecord, type ResponseFormat, type STTResult, type SignedUrlParams, type SignedUrlResult, type SoundEffectParams, type SoundEffectResult, type SpeechParams, type StreamAdapterOptions, type StreamChunk, type StreamProtocol, type TTSResult, type TaskKind, type TextContent, type ThinkingMode, type TokenUsage, type ToolCall, type ToolCallDelta, type ToolChoice, type ToolDefinition, type TrainParams, type TrainingJob, type TranscribeParams, type TranscriptWord, UnprocessableEntityError, type UsageSummary, type VideoContent, type VideoGenerateParams, type VideoGenerationResult, type VideoUploadOptions, type VideoUploadResult, type VisionModel, type VoiceInfo, type VoiceSettings, type WebDetectParams, type WebDetectionResult, type WebEntity, type WebSearchOptions, type ZeroShotDetectParams, CanaryLLM as default, toBrokeredCredential };
+export { APIConnectionError, APIConnectionTimeoutError, APIError, type ApiEnvelope, type AudioOutputFormat, AuthenticationError, type AutoLabelParams, type AutoLabelResult, type AutoTrainParams, BadRequestError, type BoundingBox, BrokeredCredential, CanaryCodersAI, type CanaryCodersAIOptions, CanaryCodersAI as CanaryLLM, type CanaryCodersAIOptions as CanaryLLMOptions, type ChatProvider, type ChatStreamEvent, type ChatStreamOptions, type Citation, CompatTarget, type CompleteParams, type CompletionResult, ConflictError, type ContentPart, type ConversationQuestion, type ConversationSession, type ConversationSessionRecord, type ConversationTemplate, type ConversationTemplateParams, type ConversationTemplateType, type ConversationTemplateUpdate, type ConversationTool, type ConversationVoiceSettings, type CreateConversationSessionParams, CreateRealtimeSessionParams, type DetectParams, type Detection, type DialogueInput, type DialogueParams, type DialogueResult, type DocumentContent, type EmbeddingParams, type EmbeddingResult, type FaceDetectParams, type FaceDetectionResult, FinalizeRealtimeParams, type GeneratedImage, type GeneratedVideo, type ImageContent, type ImageGenerateParams, type ImageGenerationResult, type ImageRecognitionResult, InternalServerError, Job, type JobSnapshot, type JobStatus, type JobStreamOptions, type KeyInfo, type KeyValidation, type Message, type MessageContent, type MessageRole, type ModelCapability, type ModelInfo, type MusicParams, type MusicResult, NotFoundError, PermissionError, type PollOptions, type PortalPeriod, type ProviderType, RateLimitError, RealtimeSession, RealtimeSessionRecord, type ResponseFormat, type STTResult, type SignedUrlParams, type SignedUrlResult, type SoundEffectParams, type SoundEffectResult, type SpeechParams, type StreamAdapterOptions, type StreamChunk, type StreamProtocol, type TTSResult, type TaskKind, type TextContent, type ThinkingMode, type TokenUsage, type ToolCall, type ToolCallDelta, type ToolChoice, type ToolDefinition, type TrainParams, type TrainingJob, type TranscribeParams, type TranscriptWord, UnprocessableEntityError, type UsageSummary, type VideoContent, type VideoGenerateParams, type VideoGenerationResult, type VideoUploadOptions, type VideoUploadResult, type VisionModel, type VoiceInfo, type VoiceSettings, type WebDetectParams, type WebDetectionResult, type WebEntity, type WebSearchOptions, type ZeroShotDetectParams, CanaryCodersAI as default, toBrokeredCredential };

package/dist/index.js

@@ -1590,7 +1590,7 @@ function readEnv(key) {
   if (typeof process !== "undefined" && process.env) return process.env[key];
   return void 0;
 }
-var CanaryLLM = class {
+var CanaryCodersAI = class {
   chat;
   queue;
   images;
@@ -1649,8 +1649,8 @@ var CanaryLLM = class {
 };
 
 // src/index.ts
-var src_default = CanaryLLM;
+var src_default = CanaryCodersAI;
 
-export { APIConnectionError, APIConnectionTimeoutError, APIError, AuthenticationError, BadRequestError, CanaryLLM, ConflictError, InternalServerError, Job, NotFoundError, PermissionError, RateLimitError, UnprocessableEntityError, anthropicTarget, src_default as default, openaiTarget, toBrokeredCredential };
+export { APIConnectionError, APIConnectionTimeoutError, APIError, AuthenticationError, BadRequestError, CanaryCodersAI, CanaryCodersAI as CanaryLLM, ConflictError, InternalServerError, Job, NotFoundError, PermissionError, RateLimitError, UnprocessableEntityError, anthropicTarget, src_default as default, openaiTarget, toBrokeredCredential };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map