@ai-sdk/groq 0.0.0-013d7476-20250808163325 → 0.0.0-64aae7dd-20260114144918

package/README.md

@@ -1,7 +1,7 @@
 # AI SDK - Groq Provider
 
 The **[Groq provider](https://ai-sdk.dev/providers/ai-sdk-providers/groq)** for the [AI SDK](https://ai-sdk.dev/docs)
-contains language model support for the Groq chat and completion APIs and embedding model support for the Groq embeddings API.
+contains language model support for the Groq chat and completion APIs, transcription support, and browser search tool.
 
 ## Setup
 
@@ -19,7 +19,95 @@ You can import the default provider instance `groq` from `@ai-sdk/groq`:
 import { groq } from '@ai-sdk/groq';
 ```
 
-## Example
+## Browser Search Tool
+
+The Groq provider includes a browser search tool that provides interactive web browsing capabilities. Unlike traditional web search, browser search navigates websites interactively, providing more detailed and comprehensive results.
+
+### Supported Models
+
+Browser search is only available for these models:
+
+- `openai/gpt-oss-20b`
+- `openai/gpt-oss-120b`
+
+⚠️ **Important**: Using browser search with other models will generate a warning and the tool will be ignored.
+
+### Basic Usage
+
+```ts
+import { groq } from '@ai-sdk/groq';
+import { generateText } from 'ai';
+
+const result = await generateText({
+  model: groq('openai/gpt-oss-120b'), // Must use supported model
+  prompt:
+    'What are the latest developments in AI? Please search for recent news.',
+  tools: {
+    browser_search: groq.tools.browserSearch({}),
+  },
+  toolChoice: 'required', // Ensure the tool is used
+});
+
+console.log(result.text);
+```
+
+### Streaming Example
+
+```ts
+import { groq } from '@ai-sdk/groq';
+import { streamText } from 'ai';
+
+const result = streamText({
+  model: groq('openai/gpt-oss-120b'),
+  prompt: 'Search for the latest tech news and summarize it.',
+  tools: {
+    browser_search: groq.tools.browserSearch({}),
+  },
+  toolChoice: 'required',
+});
+
+for await (const delta of result.fullStream) {
+  if (delta.type === 'text-delta') {
+    process.stdout.write(delta.text);
+  }
+}
+```
+
+### Key Features
+
+- **Interactive Browsing**: Navigates websites like a human user
+- **Comprehensive Results**: More detailed than traditional search snippets
+- **Server-side Execution**: Runs on Groq's infrastructure, no setup required
+- **Powered by Exa**: Uses Exa search engine for optimal results
+- **Currently Free**: Available at no additional charge during beta
+
+### Best Practices
+
+- Use `toolChoice: 'required'` to ensure the browser search is activated
+- Supported models only: `openai/gpt-oss-20b` and `openai/gpt-oss-120b`
+- The tool works automatically - no configuration parameters needed
+- Server-side execution means no additional API keys or setup required
+
+### Model Validation
+
+The provider automatically validates model compatibility:
+
+```ts
+// ✅ Supported - will work
+const result = await generateText({
+  model: groq('openai/gpt-oss-120b'),
+  tools: { browser_search: groq.tools.browserSearch({}) },
+});
+
+// ❌ Unsupported - will show warning and ignore tool
+const result = await generateText({
+  model: groq('gemma2-9b-it'),
+  tools: { browser_search: groq.tools.browserSearch({}) },
+});
+// Warning: "Browser search is only supported on models: openai/gpt-oss-20b, openai/gpt-oss-120b"
+```
+
+## Basic Text Generation
 
 ```ts
 import { groq } from '@ai-sdk/groq';
@@ -34,3 +122,5 @@ const { text } = await generateText({
 ## Documentation
 
 Please check out the **[Groq provider documentation](https://ai-sdk.dev/providers/ai-sdk-providers/groq)** for more information.
+
+For browser search details, see the **[Groq Browser Search Documentation](https://console.groq.com/docs/browser-search)**.

package/dist/index.d.mts

@@ -1,36 +1,61 @@
-import { ProviderV2, LanguageModelV2, TranscriptionModelV2 } from '@ai-sdk/provider';
+import { ProviderV3, LanguageModelV3, TranscriptionModelV3 } from '@ai-sdk/provider';
+import * as _ai_sdk_provider_utils from '@ai-sdk/provider-utils';
 import { FetchFunction } from '@ai-sdk/provider-utils';
 import { z } from 'zod/v4';
 
-type GroqChatModelId = 'gemma2-9b-it' | 'llama-3.1-8b-instant' | 'llama-3.3-70b-versatile' | 'meta-llama/llama-guard-4-12b' | 'openai/gpt-oss-120b' | 'openai/gpt-oss-20b' | 'deepseek-r1-distill-llama-70b' | 'meta-llama/llama-4-maverick-17b-128e-instruct' | 'meta-llama/llama-4-scout-17b-16e-instruct' | 'meta-llama/llama-prompt-guard-2-22m' | 'meta-llama/llama-prompt-guard-2-86m' | 'mistral-saba-24b' | 'moonshotai/kimi-k2-instruct' | 'qwen/qwen3-32b' | 'llama-guard-3-8b' | 'llama3-70b-8192' | 'llama3-8b-8192' | 'mixtral-8x7b-32768' | 'qwen-qwq-32b' | 'qwen-2.5-32b' | 'deepseek-r1-distill-qwen-32b' | (string & {});
+type GroqChatModelId = 'gemma2-9b-it' | 'llama-3.1-8b-instant' | 'llama-3.3-70b-versatile' | 'meta-llama/llama-guard-4-12b' | 'openai/gpt-oss-120b' | 'openai/gpt-oss-20b' | 'deepseek-r1-distill-llama-70b' | 'meta-llama/llama-4-maverick-17b-128e-instruct' | 'meta-llama/llama-4-scout-17b-16e-instruct' | 'meta-llama/llama-prompt-guard-2-22m' | 'meta-llama/llama-prompt-guard-2-86m' | 'moonshotai/kimi-k2-instruct-0905' | 'qwen/qwen3-32b' | 'llama-guard-3-8b' | 'llama3-70b-8192' | 'llama3-8b-8192' | 'mixtral-8x7b-32768' | 'qwen-qwq-32b' | 'qwen-2.5-32b' | 'deepseek-r1-distill-qwen-32b' | (string & {});
 declare const groqProviderOptions: z.ZodObject<{
     reasoningFormat: z.ZodOptional<z.ZodEnum<{
         parsed: "parsed";
         raw: "raw";
         hidden: "hidden";
     }>>;
-    reasoningEffort: z.ZodOptional<z.ZodString>;
+    reasoningEffort: z.ZodOptional<z.ZodEnum<{
+        none: "none";
+        default: "default";
+        low: "low";
+        medium: "medium";
+        high: "high";
+    }>>;
     parallelToolCalls: z.ZodOptional<z.ZodBoolean>;
     user: z.ZodOptional<z.ZodString>;
     structuredOutputs: z.ZodOptional<z.ZodBoolean>;
+    strictJsonSchema: z.ZodOptional<z.ZodBoolean>;
+    serviceTier: z.ZodOptional<z.ZodEnum<{
+        on_demand: "on_demand";
+        flex: "flex";
+        auto: "auto";
+    }>>;
 }, z.core.$strip>;
 type GroqProviderOptions = z.infer<typeof groqProviderOptions>;
 
-type GroqTranscriptionModelId = 'whisper-large-v3-turbo' | 'distil-whisper-large-v3-en' | 'whisper-large-v3' | (string & {});
+type GroqTranscriptionModelId = 'whisper-large-v3-turbo' | 'whisper-large-v3' | (string & {});
+
+declare const groqTools: {
+    browserSearch: _ai_sdk_provider_utils.ProviderToolFactory<{}, {}>;
+};
 
-interface GroqProvider extends ProviderV2 {
+interface GroqProvider extends ProviderV3 {
     /**
   Creates a model for text generation.
   */
-    (modelId: GroqChatModelId): LanguageModelV2;
+    (modelId: GroqChatModelId): LanguageModelV3;
     /**
   Creates an Groq chat model for text generation.
      */
-    languageModel(modelId: GroqChatModelId): LanguageModelV2;
+    languageModel(modelId: GroqChatModelId): LanguageModelV3;
     /**
   Creates a model for transcription.
      */
-    transcription(modelId: GroqTranscriptionModelId): TranscriptionModelV2;
+    transcription(modelId: GroqTranscriptionModelId): TranscriptionModelV3;
+    /**
+     * Tools provided by Groq.
+     */
+    tools: typeof groqTools;
+    /**
+     * @deprecated Use `embeddingModel` instead.
+     */
+    textEmbeddingModel(modelId: string): never;
 }
 interface GroqProviderSettings {
     /**
@@ -60,4 +85,20 @@ Default Groq provider instance.
  */
 declare const groq: GroqProvider;
 
-export { type GroqProvider, type GroqProviderOptions, type GroqProviderSettings, createGroq, groq };
+/**
+ * Browser search tool for Groq models.
+ *
+ * Provides interactive browser search capabilities that go beyond traditional web search
+ * by navigating websites interactively and providing more detailed results.
+ *
+ * Currently supported on:
+ * - openai/gpt-oss-20b
+ * - openai/gpt-oss-120b
+ *
+ * @see https://console.groq.com/docs/browser-search
+ */
+declare const browserSearch: _ai_sdk_provider_utils.ProviderToolFactory<{}, {}>;
+
+declare const VERSION: string;
+
+export { type GroqProvider, type GroqProviderOptions, type GroqProviderSettings, VERSION, browserSearch, createGroq, groq };

package/dist/index.d.ts

@@ -1,36 +1,61 @@
-import { ProviderV2, LanguageModelV2, TranscriptionModelV2 } from '@ai-sdk/provider';
+import { ProviderV3, LanguageModelV3, TranscriptionModelV3 } from '@ai-sdk/provider';
+import * as _ai_sdk_provider_utils from '@ai-sdk/provider-utils';
 import { FetchFunction } from '@ai-sdk/provider-utils';
 import { z } from 'zod/v4';
 
-type GroqChatModelId = 'gemma2-9b-it' | 'llama-3.1-8b-instant' | 'llama-3.3-70b-versatile' | 'meta-llama/llama-guard-4-12b' | 'openai/gpt-oss-120b' | 'openai/gpt-oss-20b' | 'deepseek-r1-distill-llama-70b' | 'meta-llama/llama-4-maverick-17b-128e-instruct' | 'meta-llama/llama-4-scout-17b-16e-instruct' | 'meta-llama/llama-prompt-guard-2-22m' | 'meta-llama/llama-prompt-guard-2-86m' | 'mistral-saba-24b' | 'moonshotai/kimi-k2-instruct' | 'qwen/qwen3-32b' | 'llama-guard-3-8b' | 'llama3-70b-8192' | 'llama3-8b-8192' | 'mixtral-8x7b-32768' | 'qwen-qwq-32b' | 'qwen-2.5-32b' | 'deepseek-r1-distill-qwen-32b' | (string & {});
+type GroqChatModelId = 'gemma2-9b-it' | 'llama-3.1-8b-instant' | 'llama-3.3-70b-versatile' | 'meta-llama/llama-guard-4-12b' | 'openai/gpt-oss-120b' | 'openai/gpt-oss-20b' | 'deepseek-r1-distill-llama-70b' | 'meta-llama/llama-4-maverick-17b-128e-instruct' | 'meta-llama/llama-4-scout-17b-16e-instruct' | 'meta-llama/llama-prompt-guard-2-22m' | 'meta-llama/llama-prompt-guard-2-86m' | 'moonshotai/kimi-k2-instruct-0905' | 'qwen/qwen3-32b' | 'llama-guard-3-8b' | 'llama3-70b-8192' | 'llama3-8b-8192' | 'mixtral-8x7b-32768' | 'qwen-qwq-32b' | 'qwen-2.5-32b' | 'deepseek-r1-distill-qwen-32b' | (string & {});
 declare const groqProviderOptions: z.ZodObject<{
     reasoningFormat: z.ZodOptional<z.ZodEnum<{
         parsed: "parsed";
         raw: "raw";
         hidden: "hidden";
     }>>;
-    reasoningEffort: z.ZodOptional<z.ZodString>;
+    reasoningEffort: z.ZodOptional<z.ZodEnum<{
+        none: "none";
+        default: "default";
+        low: "low";
+        medium: "medium";
+        high: "high";
+    }>>;
     parallelToolCalls: z.ZodOptional<z.ZodBoolean>;
     user: z.ZodOptional<z.ZodString>;
     structuredOutputs: z.ZodOptional<z.ZodBoolean>;
+    strictJsonSchema: z.ZodOptional<z.ZodBoolean>;
+    serviceTier: z.ZodOptional<z.ZodEnum<{
+        on_demand: "on_demand";
+        flex: "flex";
+        auto: "auto";
+    }>>;
 }, z.core.$strip>;
 type GroqProviderOptions = z.infer<typeof groqProviderOptions>;
 
-type GroqTranscriptionModelId = 'whisper-large-v3-turbo' | 'distil-whisper-large-v3-en' | 'whisper-large-v3' | (string & {});
+type GroqTranscriptionModelId = 'whisper-large-v3-turbo' | 'whisper-large-v3' | (string & {});
+
+declare const groqTools: {
+    browserSearch: _ai_sdk_provider_utils.ProviderToolFactory<{}, {}>;
+};
 
-interface GroqProvider extends ProviderV2 {
+interface GroqProvider extends ProviderV3 {
     /**
   Creates a model for text generation.
   */
-    (modelId: GroqChatModelId): LanguageModelV2;
+    (modelId: GroqChatModelId): LanguageModelV3;
     /**
   Creates an Groq chat model for text generation.
      */
-    languageModel(modelId: GroqChatModelId): LanguageModelV2;
+    languageModel(modelId: GroqChatModelId): LanguageModelV3;
     /**
   Creates a model for transcription.
      */
-    transcription(modelId: GroqTranscriptionModelId): TranscriptionModelV2;
+    transcription(modelId: GroqTranscriptionModelId): TranscriptionModelV3;
+    /**
+     * Tools provided by Groq.
+     */
+    tools: typeof groqTools;
+    /**
+     * @deprecated Use `embeddingModel` instead.
+     */
+    textEmbeddingModel(modelId: string): never;
 }
 interface GroqProviderSettings {
     /**
@@ -60,4 +85,20 @@ Default Groq provider instance.
  */
 declare const groq: GroqProvider;
 
-export { type GroqProvider, type GroqProviderOptions, type GroqProviderSettings, createGroq, groq };
+/**
+ * Browser search tool for Groq models.
+ *
+ * Provides interactive browser search capabilities that go beyond traditional web search
+ * by navigating websites interactively and providing more detailed results.
+ *
+ * Currently supported on:
+ * - openai/gpt-oss-20b
+ * - openai/gpt-oss-120b
+ *
+ * @see https://console.groq.com/docs/browser-search
+ */
+declare const browserSearch: _ai_sdk_provider_utils.ProviderToolFactory<{}, {}>;
+
+declare const VERSION: string;
+
+export { type GroqProvider, type GroqProviderOptions, type GroqProviderSettings, VERSION, browserSearch, createGroq, groq };