sarvam-ai-sdk 0.3.0-beta → 0.3.1

package/README.md

@@ -18,6 +18,15 @@ 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.
 
+### Version Compatibility
+
+| Sarvam AI SDK Version | Vercel AI SDK Version |
+|-----------------------|-----------------------|
+| 0.4.x (beta)			| 7.x.x (beta)			|
+| 0.3.x (current)		| 6.x.x (current)		|
+| 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`:
@@ -68,19 +77,6 @@ import { sarvam } from "sarvam-ai-sdk";
 import { experimental_transcribe as transcribe } from "ai";
 import { readFile } from "fs/promises";
 
-const { text } = await transcribe({
-    model: sarvam.transcription("saarika:v2.5", "ml-IN"),
-    audio: await readFile("./src/transcript-test.wav"),
-});
-
-console.log(text); // പാചകം തുടരും സുഹൃത്തുക്കളെ
-```
-
-```ts
-import { sarvam } from "sarvam-ai-sdk";
-import { experimental_transcribe as 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"),
@@ -89,24 +85,9 @@ const { text } = await transcribe({
 console.log(text); // Pachakam thudaroo, suhruthukkale.
 ```
 
-## Speech-to-Text-Translate
-
-```ts
-import { sarvam } from "sarvam-ai-sdk";
-import { experimental_transcribe as transcribe } from "ai";
-import { readFile } from "fs/promises";
-
-const result = await transcribe({
-    model: sarvam.speechTranslation("saaras:v2.5"),
-    audio: await readFile("./src/transcript-test.wav"),
-});
-
-console.log(result.text); // Cooking continues, my friends
-```
-
 ## Translation
 
-> NB: Only transliterates `prompt` and `role:user` messages, not `role:system` not `role:assistant`.
+> NB: Only translates `prompt` and `role:user` messages, not `role:system` not `role:assistant`.
 
 ```ts
 import { sarvam } from "sarvam-ai-sdk";
@@ -188,29 +169,56 @@ console.log(result.toolResults);
 ```
 
 ## Generate JSON object
+> NB: `generateObject` is deprecated, use `generateText` with `Output` tool.
 
 ```ts
 import { z } from "zod";
 import { sarvam } from "sarvam-ai-sdk";
-import { generateObject } from 'ai';
+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',
+	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",
 });
 
 console.log(object);
 ```
 
+## Generating Structured Outputs
+
+```ts
+import { z } from "zod";
+import { sarvam } from "sarvam-ai-sdk";
+import { generateText, Output } from "ai";
+
+const { output } = await generateText({
+	model: sarvam("sarvam-105b"),
+	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(output);
+```
+
 ## All APIs
 
 ```ts
@@ -232,11 +240,8 @@ sarvam.languageIdentification();
 // Text-to-Speech
 sarvam.speech("bulbul:v3", "ml-IN");
 
-// Speech-to-Text + Transcribe to same language
-sarvam.transcription("saarika:v2.5");
-
-// Speech-to-Text + Translate to English
-sarvam.speechTranslation("saaras:v3");
+// Speech-to-Text
+sarvam.transcription("saaras:v3");
 ```