krutrim-ai-sdk 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,442 @@
+import * as _ai_sdk_provider_utils from '@ai-sdk/provider-utils';
+import { FetchFunction } from '@ai-sdk/provider-utils';
+import * as _ai_sdk_provider from '@ai-sdk/provider';
+import { LanguageModelV3, EmbeddingModelV3, SpeechModelV3, TranscriptionModelV3 } from '@ai-sdk/provider';
+import { z } from 'zod';
+
+/**
+ * Default OpenAI-compatible base URL for Krutrim Cloud chat, embeddings, etc.
+ * @see https://docs.cloud.olakrutrim.com/basics/ai-studio/ai-jobs/inferencing
+ */
+declare const KRUTRIM_DEFAULT_BASE_URL = "https://cloud.olakrutrim.com/v1";
+/**
+ * Base host used for Language Labs / Bhashik endpoints
+ * (`/api/v1/languagelabs/*`).
+ */
+declare const KRUTRIM_DEFAULT_API_HOST = "https://cloud.olakrutrim.com";
+/**
+ * Internal configuration shared by model implementations.
+ */
+type KrutrimConfig = {
+    provider: string;
+    /**
+     * Build a full request URL for the OpenAI-compatible API.
+     */
+    url: (options: {
+        modelId: string;
+        path: string;
+    }) => string;
+    /**
+     * Build a full request URL for Language Labs endpoints.
+     */
+    languageLabsUrl: (path: string) => string;
+    headers: () => Record<string, string | undefined>;
+    fetch?: FetchFunction;
+    generateId?: () => string;
+};
+/**
+ * Options for {@link createKrutrim}.
+ */
+interface KrutrimProviderSettings {
+    /**
+     * Base URL for OpenAI-compatible API calls (`/chat/completions`, `/embeddings`).
+     * @default "https://cloud.olakrutrim.com/v1"
+     */
+    baseURL?: string;
+    /**
+     * Root host for Language Labs / Bhashik endpoints.
+     * @default "https://cloud.olakrutrim.com"
+     */
+    apiHost?: string;
+    /**
+     * API key for authenticating requests.
+     * Defaults to `process.env.KRUTRIM_API_KEY` or
+     * `process.env.KRUTRIM_CLOUD_API_KEY`.
+     */
+    apiKey?: string;
+    /**
+     * Custom headers merged into every request (can override defaults).
+     */
+    headers?: Record<string, string>;
+    /**
+     * Custom `fetch` implementation for middleware, testing, or edge runtimes.
+     */
+    fetch?: FetchFunction;
+    /**
+     * Optional ID generator used for tool call IDs when the API omits them.
+     */
+    generateId?: () => string;
+}
+/**
+ * Resolve the Krutrim API key from options or environment variables.
+ *
+ * Checks (in order):
+ * 1. Explicit `apiKey` option
+ * 2. `KRUTRIM_API_KEY`
+ * 3. `KRUTRIM_CLOUD_API_KEY` (official Krutrim Cloud SDK name)
+ */
+declare function resolveKrutrimApiKey(apiKey: string | undefined): string | undefined;
+
+/**
+ * ISO / BCP-47 style Indian language codes used across helpers.
+ */
+type IndicLanguageCode = 'hi-IN' | 'bn-IN' | 'kn-IN' | 'ml-IN' | 'mr-IN' | 'or-IN' | 'pa-IN' | 'ta-IN' | 'te-IN' | 'gu-IN' | 'as-IN' | 'ur-IN' | 'en-IN' | 'sa-IN' | 'ne-IN';
+/**
+ * Short ISO-639-3 style codes used by Bhashik / Language Labs.
+ */
+type BhashikLanguageCode = 'eng' | 'hin' | 'ben' | 'mar' | 'tam' | 'tel' | 'kan' | 'mal' | 'pan' | 'guj';
+/**
+ * Translation API uses script-aware codes like `hin_Deva`, `eng_Latn`.
+ */
+type TranslationLanguageCode = string;
+declare const INDIC_LANGUAGES: ReadonlyArray<{
+    code: IndicLanguageCode;
+    bhashik: BhashikLanguageCode | null;
+    name: string;
+    nativeName: string;
+    script: string;
+    notes?: string;
+}>;
+/**
+ * Map BCP-47 Indic codes to Bhashik short codes when available.
+ */
+declare function toBhashikLanguageCode(code: IndicLanguageCode | string): BhashikLanguageCode | null;
+/**
+ * Build a translation-style language tag, e.g. `hin_Deva`, `eng_Latn`.
+ */
+declare function toTranslationLanguageCode(code: IndicLanguageCode | string): TranslationLanguageCode;
+
+type KrutrimSpeechSettings = {
+    /**
+     * Speaker voice.
+     * @default "female"
+     */
+    speaker?: 'female' | 'male';
+};
+
+type TranslationSettings = {
+    /**
+     * Source language (BCP-47 like `hi-IN`, short `hin`, or `hin_Deva`).
+     */
+    from: IndicLanguageCode | string;
+    /**
+     * Target language (BCP-47 like `en-IN`, short `eng`, or `eng_Latn`).
+     */
+    to: IndicLanguageCode | string;
+    /**
+     * Translation model.
+     * @default "krutrim-translate-v1.0"
+     */
+    model?: string;
+};
+
+/**
+ * Popular chat / text-generation model IDs on Krutrim Cloud.
+ *
+ * Exact IDs can change as the catalogue is updated — always confirm in the
+ * [Model Catalogue](https://cloud.olakrutrim.com) if a call fails with
+ * "invalid model".
+ *
+ * Free-form strings are still accepted via `ChatModelId`.
+ */
+declare const KRUTRIM_CHAT_MODELS: {
+    /** Krutrim's flagship Indic-capable model (v1). */
+    readonly krutrim1: "Krutrim-1";
+    /** Krutrim's next-generation text model. */
+    readonly krutrim2: "Krutrim-2";
+    /** Lowercase alias accepted by many OpenAI-compatible samples. */
+    readonly krutrim1Lower: "krutrim-1";
+    readonly krutrim2Lower: "krutrim-2";
+    readonly llama33_70b: "Llama-3.3-70B-Instruct";
+    readonly llama32_11b_vision: "Llama-3.2-11B-Vision-Instruct";
+    readonly llama4_maverick: "Llama-4-Maverick-17B-128E-Instruct";
+    readonly llama3_8b: "Meta-Llama-3-8B-Instruct";
+    readonly mistral7b: "Mistral-7B-v0.2";
+    readonly mistral7bInstruct: "Mistral-7B-Instruct";
+    readonly qwen3_32b: "Qwen3-32B";
+    readonly qwen3_30b: "Qwen3-30B-A3B";
+    readonly phi4_reasoning: "Phi-4-reasoning-plus";
+    readonly deepseekR1: "DeepSeek-R1";
+    readonly deepseekR1_70b: "DeepSeek-R1-Distill-Llama-70B";
+    readonly deepseekR1_8b: "DeepSeek-R1-Distill-Llama-8B";
+    readonly gemma3_27b: "gemma-3-27b-it";
+    readonly spectreV2: "Krutrim-spectre-v2";
+};
+/**
+ * Embedding model IDs (text-to-embedding).
+ */
+declare const KRUTRIM_EMBEDDING_MODELS: {
+    /** Krutrim embedding model. */
+    readonly vyakyarth: "Vyakyarth";
+    /** Alternative Krutrim embedding model. */
+    readonly bhasantarit: "Bhasantarit";
+};
+/**
+ * Speech model IDs.
+ */
+declare const KRUTRIM_SPEECH_MODELS: {
+    /** Krutrim Speech-to-Text. */
+    readonly dhwani: "Krutrim-Dhwani";
+    /** Krutrim Text-to-Speech. */
+    readonly tts: "Krutrim-TTS";
+};
+/**
+ * Multimodal / vision model IDs.
+ */
+declare const KRUTRIM_VISION_MODELS: {
+    readonly chitrapathak: "chitrapathak";
+    readonly llama32_11b_vision: "Llama-3.2-11B-Vision-Instruct";
+    readonly llama4_maverick: "Llama-4-Maverick-17B-128E-Instruct";
+    readonly gemma3_27b: "gemma-3-27b-it";
+};
+/**
+ * Friendly aliases → canonical catalogue model IDs.
+ *
+ * Use {@link resolveModelId} so `krutrim('krutrim-2')` and
+ * `krutrim('Krutrim-2')` both work.
+ */
+declare const MODEL_ALIASES: Record<string, string>;
+/**
+ * Resolve a friendly alias or passthrough an exact catalogue ID.
+ */
+declare function resolveModelId(modelId: string): string;
+/**
+ * Typed chat model IDs with autocomplete for popular models.
+ */
+type ChatModelId = (typeof KRUTRIM_CHAT_MODELS)[keyof typeof KRUTRIM_CHAT_MODELS] | keyof typeof MODEL_ALIASES | (string & {});
+/**
+ * Typed embedding model IDs.
+ */
+type EmbeddingModelId = (typeof KRUTRIM_EMBEDDING_MODELS)[keyof typeof KRUTRIM_EMBEDDING_MODELS] | (string & {});
+/**
+ * Typed speech model IDs.
+ */
+type SpeechModelId = (typeof KRUTRIM_SPEECH_MODELS)[keyof typeof KRUTRIM_SPEECH_MODELS] | (string & {});
+
+/**
+ * Optional provider-side chat settings (also via `providerOptions.krutrim`).
+ */
+type ChatSettings = {
+    /**
+     * How many chat completion choices to generate per input message.
+     * You are billed for all generated tokens — keep `n` at `1` when possible.
+     */
+    n?: number;
+    /**
+     * Unique end-user identifier for abuse monitoring (OpenAI-compatible `user`).
+     */
+    user?: string;
+    /**
+     * Reasoning effort for reasoning models (provider-dependent).
+     */
+    reasoningEffort?: 'low' | 'medium' | 'high';
+};
+
+/**
+ * Krutrim provider interface — callable + factory methods.
+ *
+ * @example
+ * ```ts
+ * import { krutrim } from 'krutrim-ai-sdk';
+ * import { generateText } from 'ai';
+ *
+ * const { text } = await generateText({
+ *   model: krutrim('Krutrim-2'),
+ *   prompt: 'नमस्ते! आज मौसम कैसा है?',
+ * });
+ * ```
+ */
+type KrutrimProvider = {
+    /**
+     * Create a chat / text-generation model.
+     */
+    (modelId: ChatModelId, settings?: ChatSettings): LanguageModelV3;
+    /**
+     * Create a chat language model (alias of the call signature).
+     */
+    languageModel(modelId: ChatModelId, settings?: ChatSettings): LanguageModelV3;
+    /**
+     * Create a chat model (alias of `languageModel`).
+     */
+    chat(modelId: ChatModelId, settings?: ChatSettings): LanguageModelV3;
+    /**
+     * Create an embedding model (e.g. Vyakyarth, Bhasantarit).
+     */
+    embedding(modelId: EmbeddingModelId): EmbeddingModelV3;
+    /**
+     * Alias for {@link KrutrimProvider.embedding}.
+     */
+    embeddingModel(modelId: EmbeddingModelId): EmbeddingModelV3;
+    /**
+     * Create a text-embedding model (AI SDK naming).
+     */
+    textEmbeddingModel(modelId: EmbeddingModelId): EmbeddingModelV3;
+    /**
+     * Bhashik Text-to-Speech.
+     *
+     * @example
+     * ```ts
+     * import { experimental_generateSpeech as generateSpeech } from 'ai';
+     * const { audio } = await generateSpeech({
+     *   model: krutrim.speech('hi-IN'),
+     *   text: 'नमस्ते, भारत!',
+     * });
+     * ```
+     */
+    speech(language: IndicLanguageCode | BhashikLanguageCode | string, settings?: KrutrimSpeechSettings): SpeechModelV3;
+    /**
+     * Bhashik Speech-to-Text (Krutrim-Dhwani family).
+     *
+     * @example
+     * ```ts
+     * import { experimental_transcribe as transcribe } from 'ai';
+     * const { text } = await transcribe({
+     *   model: krutrim.transcription('hi-IN'),
+     *   audio: await readFile('./clip.wav'),
+     * });
+     * ```
+     */
+    transcription(language: IndicLanguageCode | BhashikLanguageCode | string): TranscriptionModelV3;
+    /**
+     * Bhashik language detection (works with `generateText`).
+     */
+    languageDetection(): LanguageModelV3;
+    /**
+     * Bhashik text translation (works with `generateText`).
+     *
+     * @example
+     * ```ts
+     * const { text } = await generateText({
+     *   model: krutrim.translation({ from: 'hi-IN', to: 'en-IN' }),
+     *   prompt: 'आज मौसम बहुत सुहाना है।',
+     * });
+     * ```
+     */
+    translation(settings: TranslationSettings): LanguageModelV3;
+};
+
+/**
+ * Create a Krutrim Cloud provider instance.
+ *
+ * @example
+ * ```ts
+ * import { createKrutrim } from 'krutrim-ai-sdk';
+ *
+ * const krutrim = createKrutrim({
+ *   apiKey: process.env.KRUTRIM_API_KEY,
+ *   // baseURL: 'https://cloud.olakrutrim.com/v1',
+ * });
+ * ```
+ */
+declare function createKrutrim(options?: KrutrimProviderSettings): KrutrimProvider;
+/**
+ * Default Krutrim provider instance.
+ *
+ * Reads `KRUTRIM_API_KEY` or `KRUTRIM_CLOUD_API_KEY` from the environment.
+ *
+ * @example
+ * ```ts
+ * import { krutrim } from 'krutrim-ai-sdk';
+ * import { generateText } from 'ai';
+ *
+ * const { text } = await generateText({
+ *   model: krutrim('Krutrim-2'),
+ *   prompt: 'Write a haiku about monsoons in Kerala.',
+ * });
+ * ```
+ */
+declare const krutrim: KrutrimProvider;
+
+/**
+ * Flexible error payload — Krutrim surfaces both OpenAI-style and
+ * Language Labs-style error bodies.
+ */
+declare const krutrimErrorDataSchema: z.ZodObject<{
+    error: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodObject<{
+        message: z.ZodOptional<z.ZodString>;
+        type: z.ZodOptional<z.ZodString>;
+        code: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
+        param: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    }, "strip", z.ZodTypeAny, {
+        code?: string | number | undefined;
+        message?: string | undefined;
+        type?: string | undefined;
+        param?: string | null | undefined;
+    }, {
+        code?: string | number | undefined;
+        message?: string | undefined;
+        type?: string | undefined;
+        param?: string | null | undefined;
+    }>]>>;
+    message: z.ZodOptional<z.ZodString>;
+    status: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
+    detail: z.ZodOptional<z.ZodObject<{
+        info: z.ZodOptional<z.ZodString>;
+    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+        info: z.ZodOptional<z.ZodString>;
+    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+        info: z.ZodOptional<z.ZodString>;
+    }, z.ZodTypeAny, "passthrough">>>;
+    code: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
+}, "strip", z.ZodTypeAny, {
+    code?: string | number | undefined;
+    message?: string | undefined;
+    status?: string | number | undefined;
+    error?: string | {
+        code?: string | number | undefined;
+        message?: string | undefined;
+        type?: string | undefined;
+        param?: string | null | undefined;
+    } | undefined;
+    detail?: z.objectOutputType<{
+        info: z.ZodOptional<z.ZodString>;
+    }, z.ZodTypeAny, "passthrough"> | undefined;
+}, {
+    code?: string | number | undefined;
+    message?: string | undefined;
+    status?: string | number | undefined;
+    error?: string | {
+        code?: string | number | undefined;
+        message?: string | undefined;
+        type?: string | undefined;
+        param?: string | null | undefined;
+    } | undefined;
+    detail?: z.objectInputType<{
+        info: z.ZodOptional<z.ZodString>;
+    }, z.ZodTypeAny, "passthrough"> | undefined;
+}>;
+type KrutrimErrorData = z.infer<typeof krutrimErrorDataSchema>;
+/**
+ * Enrich raw API errors with India / Krutrim-specific guidance.
+ */
+declare function enhanceKrutrimErrorMessage(rawMessage: string, statusCode?: number): string;
+declare const krutrimFailedResponseHandler: _ai_sdk_provider_utils.ResponseHandler<_ai_sdk_provider.APICallError>;
+
+/**
+ * System prompt that steers the model to respond in a target Indian language.
+ */
+declare function indicResponsePrompt(language: IndicLanguageCode | string, options?: {
+    /** Prefer native script over Latin transliteration. @default true */
+    nativeScript?: boolean;
+    /** Allow code-mixing (Hinglish, Tanglish, etc.). @default false */
+    allowCodeMix?: boolean;
+}): string;
+/**
+ * Prompt fragment for language identification via a chat model.
+ * Prefer {@link krutrim.languageDetection} (Bhashik API) when available.
+ */
+declare function languageDetectionPrompt(): string;
+/**
+ * Notes for apps that accept Romanized Indic input (Hinglish, etc.).
+ * Attach as a system hint when users type in Latin script.
+ */
+declare function transliterationNotes(targetLanguage?: IndicLanguageCode | string): string;
+/**
+ * Lightweight system prompt for multilingual Indian customer-support agents.
+ */
+declare function indicSupportAgentPrompt(options?: {
+    brandName?: string;
+    languages?: Array<IndicLanguageCode | string>;
+}): string;
+
+export { type BhashikLanguageCode, type ChatModelId, type ChatSettings, type EmbeddingModelId, INDIC_LANGUAGES, type IndicLanguageCode, KRUTRIM_CHAT_MODELS, KRUTRIM_DEFAULT_API_HOST, KRUTRIM_DEFAULT_BASE_URL, KRUTRIM_EMBEDDING_MODELS, KRUTRIM_SPEECH_MODELS, KRUTRIM_VISION_MODELS, type KrutrimConfig, type KrutrimErrorData, type KrutrimProvider, type KrutrimProviderSettings, type KrutrimSpeechSettings, MODEL_ALIASES, type SpeechModelId, type TranslationLanguageCode, type TranslationSettings, createKrutrim, enhanceKrutrimErrorMessage, indicResponsePrompt, indicSupportAgentPrompt, krutrim, krutrimErrorDataSchema, krutrimFailedResponseHandler, languageDetectionPrompt, resolveKrutrimApiKey, resolveModelId, toBhashikLanguageCode, toTranslationLanguageCode, transliterationNotes };