sarvam-ai-sdk 0.1.4 → 0.2.0-beta

package/README.md

@@ -1,6 +1,6 @@
 # AI SDK - Sarvam Provider
 
-The **[Sarvam provider](https://v4.ai-sdk.dev/providers/ai-sdk-providers/sarvam)** for the [AI SDK](https://v4.ai-sdk.dev/docs)
+The **[Sarvam provider](https://v5.ai-sdk.dev/providers/ai-sdk-providers/sarvam)** for the [AI SDK](https://v5.ai-sdk.dev/docs)
 contains language model support for the Sarvam chat completion, Text-to-Speech and Speech-to-Text APIs.
 
 ## Setup
@@ -8,11 +8,11 @@ contains language model support for the Sarvam chat completion, Text-to-Speech a
 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
+npm i sarvam-ai-sdk ai@5
 ```
 
 > [!WARNING]
-> This package only works with Vercel AI-SDK v4, not latest v6. Make sure to install `ai@4` in your project.
+> This package only works with Vercel AI-SDK v5, not v6 or latest v7. Make sure to install `ai@5` in your project.
 
 ## Provider Instance
 
@@ -102,14 +102,14 @@ console.log(result.text); // Cooking continues, my friends
 
 ## Translation
 
-> NB: Only transliterates `prompt` and `role:user` messages, not `system` not `assistant`.
+> 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.translation({
+	model: sarvam.translation("mayura:v1", {
         "from": "ml-IN",
         "to": "en-IN",
     }),
@@ -121,7 +121,7 @@ console.log(result.text); // Shouldn't we be careful about this, Ambane?
 
 ## Transliterate
 
-> NB: Only transliterates `prompt` and `role:user` messages, not `system` not `assistant`.
+> NB: Only transliterates `prompt` and `role:user` messages, not `role:system` not `role:assistant`.
 
 ```ts
 import { sarvam } from "sarvam-ai-sdk";
@@ -129,8 +129,8 @@ import { generateText } from "ai";
 
 const result = await generateText({
   model: sarvam.transliterate({
-      from: "en-IN",
       to: "ml-IN",
+      from: "en-IN", // optional
   }),
   prompt: "eda mone, happy alle?",
 });
@@ -140,7 +140,7 @@ console.log(result.text); // എടാ മോനെ, ഹാപ്പി അല
 
 ## Language Identification
 
-> NB: Only identifies `prompt` and `role:user` messages, not `system` not `assistant`.
+> NB: Only identifies `prompt` and `role:user` messages, not `role:system` not `role:assistant`.
 
 ```ts
 import { sarvam } from "sarvam-ai-sdk";
@@ -167,8 +167,8 @@ const result = await generateText({
   tools: {
     weather: tool({
       description: "Get the weather in a location",
-      parameters: z.object({
-        location: z.string().describe("The location to get the weather for"),
+      inputSchema: z.object({
+		location: z.string(),
       }),
       execute: async ({ location }) => ({
         location,
@@ -183,9 +183,6 @@ const result = await generateText({
 console.log(result.toolResults);
 ```
 
-> [!WARNING]
-> Old `sarvam-m` models isn't trained on native tool calling feature (aka JSON mode). So we recommend using latest models.
-
 ## Generate JSON object
 
 ```ts
@@ -195,6 +192,8 @@ 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(),
@@ -208,9 +207,6 @@ const { object } = await generateObject({
 console.log(object);
 ```
 
-> [!WARNING]
-> Old `sarvam-m` models isn't trained on native JSON object generation. So we recommend using latest models.
-
 ## All APIs
 
 ```ts
@@ -221,10 +217,10 @@ sarvam("sarvam-105b");
 sarvam.languageModel("sarvam-30b");
 
 // Text-to-Text + Transliteration
-sarvam.transliterate({ from: "en-IN", to: "ml-IN" });
+sarvam.transliterate({ to: "ml-IN", from: "en-IN" });
 
 // Text-to-Text + Translation
-sarvam.translation({ from: "en-IN", to: "ml-IN" });
+sarvam.translation("mayura:v1", { from: "en-IN", to: "ml-IN" });
 
 // Text-to-Text + Language identification
 sarvam.languageIdentification();
@@ -242,4 +238,4 @@ sarvam.speechTranslation("saaras:v3");
 
 ## Documentation
 
-Please check out the **[Sarvam provider documentation](https://v4.ai-sdk.dev/providers/ai-sdk-providers/sarvam)** and **[Sarvam API documentation](https://docs.sarvam.ai)** for more information.
+Please check out the **[Sarvam provider documentation](https://v5.ai-sdk.dev/providers/ai-sdk-providers/sarvam)** and **[Sarvam API documentation](https://docs.sarvam.ai)** for more information.