Introducing Socket Firewall: Free, Proactive Protection for Your Software Supply Chain.Learn More
Socket
Book a DemoInstallSign in
Socket

@ai-sdk/groq

Package Overview
Dependencies
Maintainers
4
Versions
127
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@ai-sdk/groq

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, transcription support, and browser search tool.

latest
Source
npmnpm
Version
2.0.22
Version published
Weekly downloads
177K
11.38%
Maintainers
4
Weekly downloads
 
Created
Source

AI SDK - Groq Provider

The Groq provider for the AI SDK contains language model support for the Groq chat and completion APIs, transcription support, and browser search tool.

Setup

The Groq provider is available in the @ai-sdk/groq module. You can install it with

npm i @ai-sdk/groq

Provider Instance

You can import the default provider instance groq from @ai-sdk/groq:

import { groq } from '@ai-sdk/groq';

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

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

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:

// ✅ 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

import { groq } from '@ai-sdk/groq';
import { generateText } from 'ai';

const { text } = await generateText({
  model: groq('gemma2-9b-it'),
  prompt: 'Write a vegetarian lasagna recipe for 4 people.',
});

Documentation

Please check out the Groq provider documentation for more information.

For browser search details, see the Groq Browser Search Documentation.

Keywords

ai

FAQs

Package last updated on 26 Sep 2025

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts