sarvam-ai-sdk 0.4.0 → 0.4.2-beta

package/README.md

@@ -1,211 +1,206 @@
-<a href="https://github.com/rajatsandeepsen/sarvam-ai-sdk">
-    <img alt="cover" src="https://github.com/rajatsandeepsen/sarvam-ai-sdk/blob/master/cover.png?raw=true" />
-</a>
-
-# AI SDK - Sarvam Provider
-
-The **[Sarvam provider](https://v6.ai-sdk.dev/providers/community-providers/sarvam)** for the [AI SDK](https://v6.ai-sdk.dev/docs)
-contains language model support for the Sarvam chat completion, Text-to-Speech and Speech-to-Text APIs.
-
-## Setup
-
-The **[Sarvam](http://sarvam.ai)** provider is available in the `sarvam-ai-sdk` module. You can install it with
-
-```bash
-npm i sarvam-ai-sdk ai@6
-```
-
-> [!WARNING]
-> This package only works with Vercel AI-SDK v6, not v7. Make sure to install `ai@6` in your project.
-
-## Provider Instance
-
-You can import the default provider instance `sarvam` from `sarvam-ai-sdk`:
-
+<a href="https://github.com/sarvamai/sarvam-ai-sdk">
+    <img alt="cover" src="https://github.com/sarvamai/sarvam-ai-sdk/blob/master/cover.png?raw=true" />
+</a>
+
+# AI SDK - Sarvam Provider
+
+The **[Sarvam provider](https://v7.ai-sdk.dev/providers/community-providers/sarvam)** for the [AI SDK](https://v7.ai-sdk.dev/docs)
+contains language model support for the Sarvam chat completion, Text-to-Speech and Speech-to-Text APIs.
+
+## Setup
+
+The **[Sarvam](http://sarvam.ai)** provider is available in the `sarvam-ai-sdk` module. You can install it with
+
+```bash
+npm i sarvam-ai-sdk ai@7
+```
+
+> [!WARNING]
+> This package only works with Vercel AI-SDK v7, not v8. Make sure to install `ai@7` in your project.
+
+### Version Compatibility
+
+| Sarvam AI SDK Version | Vercel AI SDK Version |
+|-----------------------|-----------------------|
+| 0.5.x (beta)			| 8.x.x (beta)			|
+| 0.4.x (current)		| 7.x.x (current)		|
+| 0.3.x 				| 6.x.x 				|
+| 0.2.x					| 5.x.x					|
+| 0.1.x					| 4.x.x					|
+
+## Provider Instance
+
+You can import the default provider instance `sarvam` from `sarvam-ai-sdk`:
+
 ```ts
-import { sarvam } from 'sarvam-ai-sdk';
-```
-
-Create `.env` file with API key from **[Sarvam Dashboard](https://dashboard.sarvam.ai/)**
-```bash
-SARVAM_API_KEY="your_api_key"
+import { sarvam } from "sarvam-ai-sdk";
 ```
-
-## Example
-
+
+Create `.env` file with API key from **[Sarvam Dashboard](https://dashboard.sarvam.ai/)**
+```bash
+SARVAM_API_KEY="your_api_key"
+```
+
+## Example
+
 ```ts
-import { sarvam } from 'sarvam-ai-sdk';
-import { generateText } from 'ai';
+import { sarvam } from "sarvam-ai-sdk";
+import { generateText } from "ai";
 
 const { text } = await generateText({
-	model: sarvam("sarvam-30b"),
-    prompt: "Translate this to malayalam: 'Keep cooking, guys'",
+	model: sarvam("sarvam-30b", {
+		reasoning_effort: "low",
+	}),
+	prompt: "Translate this to malayalam: 'Keep cooking, guys'",
 });
 
-console.log(text); // പാചകം തുടരൂ, സുഹൃത്തുക്കളേ
+console.log(text); // പചക തടര, സഹതകള
 ```
-
-## Text-to-Speech
-
+
+## Text-to-Speech
+
 ```ts
 import { sarvam } from "sarvam-ai-sdk";
-import { experimental_generateSpeech as generateSpeech } from "ai";
+import { generateSpeech } from "ai";
 import { writeFile } from "fs/promises";
 
 const { audio } = await generateSpeech({
-    model: sarvam.speech("bulbul:v3", "ml-IN"),
-    text: "പാചകം തുടരൂ, സുഹൃത്തുക്കളേ",
+	model: sarvam.speech("bulbul:v3", "ml-IN"),
+	text: "പചക തടര, സഹതകള",
 });
 
-const audioBuffer = Buffer.from(audio.base64, "base64")
+const audioBuffer = Buffer.from(audio.base64, "base64");
 await writeFile("./src/transcript-test.wav", audioBuffer);
 ```
-
-## Speech-to-Text
-
+
+## Speech-to-Text
+
 ```ts
 import { sarvam } from "sarvam-ai-sdk";
-import { experimental_transcribe as transcribe } from "ai";
+import { transcribe } from "ai";
 import { readFile } from "fs/promises";
 
 const { text } = await transcribe({
-    model: sarvam.transcription("saaras:v3", "en-IN"),
-    audio: await readFile("./src/transcript-test.wav"),
+	model: sarvam.transcription("saaras:v3", "en-IN"),
+	audio: await readFile("./src/transcript-test.wav"),
 });
 
 console.log(text); // Pachakam thudaroo, suhruthukkale.
 ```
-
-## Translation
-
-> NB: Only translates `prompt` and `role:user` messages, not `role:system` not `role:assistant`.
-
+
+## Translation
+
+> NB: Only translates `prompt` and `role:user` messages, not `role:system` not `role:assistant`.
+
 ```ts
 import { sarvam } from "sarvam-ai-sdk";
 import { generateText } from "ai";
 
 const result = await generateText({
 	model: sarvam.translation("mayura:v1", {
-        "from": "ml-IN",
-        "to": "en-IN",
-    }),
-    prompt: "ഇതൊക്കെ ശ്രദ്ധിക്കണ്ടേ അംബാനെ?",
+		from: "ml-IN",
+		to: "en-IN",
+	}),
+	prompt: "ഇതക ശദകണ അബന?",
 });
 
 console.log(result.text); // Shouldn't we be careful about this, Ambane?
 ```
-
-## Transliterate
-
-> NB: Only transliterates `prompt` and `role:user` messages, not `role:system` not `role:assistant`.
-
+
+## Transliterate
+
+> NB: Only transliterates `prompt` and `role:user` messages, not `role:system` not `role:assistant`.
+
 ```ts
 import { sarvam } from "sarvam-ai-sdk";
 import { generateText } from "ai";
 
 const result = await generateText({
-  model: sarvam.transliterate({
-      to: "ml-IN",
-      from: "en-IN", // optional
-  }),
-  prompt: "eda mone, happy alle?",
+	model: sarvam.transliterate({
+		to: "ml-IN",
+		from: "en-IN", // optional
+	}),
+	prompt: "eda mone, happy alle?",
 });
 
-console.log(result.text); // എടാ മോനെ, ഹാപ്പി അല്ലേ?
+console.log(result.text); // എട മന, ഹപ അല?
 ```
-
-## Language Identification
-
-> NB: Only identifies `prompt` and `role:user` messages, not `role:system` not `role:assistant`.
-
+
+## Language Identification
+
+> NB: Only identifies `prompt` and `role:user` messages, not `role:system` not `role:assistant`.
+
 ```ts
 import { sarvam } from "sarvam-ai-sdk";
 import { generateText } from "ai";
 
 const result = await generateText({
-    model: sarvam.languageIdentification(),
-    prompt: "ബുദ്ധിയാണ് സാറേ ഇവൻ്റെ മെയിൻ",
+	model: sarvam.languageIdentification(),
+	prompt: "ബദയണ സറ ഇവൻറ മയൻ",
 });
 
 console.log(result.text); // ml-IN
 ```
-
-## Tool Calling
-
+
+## Tool Calling
+
 ```ts
 import { z } from "zod";
 import { generateText, tool } from "ai";
 import { sarvam } from "sarvam-ai-sdk";
 
-
 const result = await generateText({
-  model: sarvam("sarvam-30b"),
-  tools: {
-    weather: tool({
-      description: "Get the weather in a location",
-      inputSchema: z.object({
-		location: z.string(),
-      }),
-      execute: async ({ location }) => ({
-        location,
-        temperature: 72 + Math.floor(Math.random() * 21) - 10,
-      }),
-    }),
-  },
-  system: "Your are a helpful AI",
-  prompt: "കൊച്ചിയിലെ കാലാവസ്ഥ എന്താണ്?",
+	model: sarvam("sarvam-30b"),
+	tools: {
+		weather: tool({
+			description: "Get the weather in a location",
+			inputSchema: z.object({
+				location: z.string(),
+			}),
+			execute: async ({ location }) => ({
+				location,
+				temperature: 72 + Math.floor(Math.random() * 21) - 10,
+			}),
+		}),
+	},
+	instructions: "Your are a helpful AI",
+	prompt: "കചയല കലവസ എനണ?",
 });
 
 console.log(result.toolResults);
 ```
-
-## Generate JSON object
-
+
+## Generating Structured Outputs
+
 ```ts
 import { z } from "zod";
 import { sarvam } from "sarvam-ai-sdk";
-import { generateObject } from 'ai';
-
-const { object } = await generateObject({
-  model: sarvam("sarvam-30b"),
-  schemaName: "Recipe",
-  schemaDescription: "A recipe with a name, ingredients and steps",
-  schema: z.object({
-    recipe: z.object({
-      name: z.string(),
-      ingredients: z.array(z.string()),
-      steps: z.array(z.string()),
-    }),
-  }),
-  prompt: 'Generate a South Indian recipe, in Malayalam',
+import { generateText, Output } from "ai";
+
+const { output } = await generateText({
+	model: sarvam("sarvam-105b", {
+		// uncomment to enable direct JSON mode
+		// experimental_json_mode: true,
+	}),
+	output: Output.object({
+		name: "Recipe",
+		description: "A recipe with a name, ingredients and steps",
+		schema: z.object({
+			recipe: z.object({
+				name: z.string(),
+				ingredients: z.array(z.string()),
+				steps: z.array(z.string()),
+			}),
+		}),
+	}),
+	prompt: "Generate a South Indian recipe, in Malayalam",
 });
 
-console.log(object);
-```
-
-## Document Intelligence
-
-Digitize documents (PDF, PNG, JPEG, ZIP of images) using Sarvam Vision with OCR support for 23 languages.
-Returns a ZIP buffer containing the extracted content.
-
-```ts
-import { sarvam } from "sarvam-ai-sdk";
-import { readFile, writeFile } from "fs/promises";
-
-const file = await readFile("./invoice.pdf");
-
-const result = await sarvam.documentIntelligence.digitize(
-    file,
-    "invoice.pdf",
-    { language: "hi-IN", outputFormat: "md" },
-);
-
-await writeFile("./output.zip", result.output);
-console.log(`Pages processed: ${result.pageMetrics.pagesSucceeded}`);
+console.log(output);
 ```
-
-## All APIs
-
+
+## All APIs
+
 ```ts
 import { sarvam } from "sarvam-ai-sdk";
 
@@ -227,12 +222,8 @@ sarvam.speech("bulbul:v3", "ml-IN");
 
 // Speech-to-Text
 sarvam.transcription("saaras:v3");
-
-// Document Intelligence (Sarvam Vision)
-sarvam.documentIntelligence.digitize(file, "document.pdf", { language: "hi-IN" });
 ```
-
-
-## Documentation
-
-Please check out the **[Sarvam provider documentation](https://v6.ai-sdk.dev/providers/community-providers/sarvam)** and **[Sarvam API documentation](https://docs.sarvam.ai)** for more information.
+
+## Documentation
+
+Please check out the **[Sarvam provider documentation](https://v7.ai-sdk.dev/providers/community-providers/sarvam)** and **[Sarvam API documentation](https://docs.sarvam.ai)** for more information.