@ai-sdk/cerebras 2.0.18 → 2.0.19

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @ai-sdk/cerebras
 
+## 2.0.19
+
+### Patch Changes
+
+- 2b8369d: chore: add docs to package dist
+
 ## 2.0.18
 
 ### Patch Changes

package/dist/index.js

@@ -33,7 +33,7 @@ var import_provider_utils = require("@ai-sdk/provider-utils");
 var import_v4 = require("zod/v4");
 
 // src/version.ts
-var VERSION = true ? "2.0.18" : "0.0.0-test";
+var VERSION = true ? "2.0.19" : "0.0.0-test";
 
 // src/cerebras-provider.ts
 var cerebrasErrorSchema = import_v4.z.object({

package/dist/index.mjs

@@ -11,7 +11,7 @@ import {
 import { z } from "zod/v4";
 
 // src/version.ts
-var VERSION = true ? "2.0.18" : "0.0.0-test";
+var VERSION = true ? "2.0.19" : "0.0.0-test";
 
 // src/cerebras-provider.ts
 var cerebrasErrorSchema = z.object({

package/docs/40-cerebras.mdx

@@ -0,0 +1,119 @@
+---
+title: Cerebras
+description: Learn how to use Cerebras's models with the AI SDK.
+---
+
+# Cerebras Provider
+
+The [Cerebras](https://cerebras.ai) provider offers access to powerful language models through the Cerebras API, including their high-speed inference capabilities powered by Wafer-Scale Engines and CS-3 systems.
+
+API keys can be obtained from the [Cerebras Platform](https://cloud.cerebras.ai).
+
+## Setup
+
+The Cerebras provider is available via the `@ai-sdk/cerebras` module. You can install it with:
+
+<Tabs items={['pnpm', 'npm', 'yarn', 'bun']}>
+  <Tab>
+    <Snippet text="pnpm add @ai-sdk/cerebras" dark />
+  </Tab>
+  <Tab>
+    <Snippet text="npm install @ai-sdk/cerebras" dark />
+  </Tab>
+  <Tab>
+    <Snippet text="yarn add @ai-sdk/cerebras" dark />
+  </Tab>
+
+  <Tab>
+    <Snippet text="bun add @ai-sdk/cerebras" dark />
+  </Tab>
+</Tabs>
+
+## Provider Instance
+
+You can import the default provider instance `cerebras` from `@ai-sdk/cerebras`:
+
+```ts
+import { cerebras } from '@ai-sdk/cerebras';
+```
+
+For custom configuration, you can import `createCerebras` and create a provider instance with your settings:
+
+```ts
+import { createCerebras } from '@ai-sdk/cerebras';
+
+const cerebras = createCerebras({
+  apiKey: process.env.CEREBRAS_API_KEY ?? '',
+});
+```
+
+You can use the following optional settings to customize the Cerebras provider instance:
+
+- **baseURL** _string_
+
+  Use a different URL prefix for API calls.
+  The default prefix is `https://api.cerebras.ai/v1`.
+
+- **apiKey** _string_
+
+  API key that is being sent using the `Authorization` header. It defaults to
+  the `CEREBRAS_API_KEY` environment variable.
+
+- **headers** _Record&lt;string,string&gt;_
+
+  Custom headers to include in the requests.
+
+- **fetch** _(input: RequestInfo, init?: RequestInit) => Promise&lt;Response&gt;_
+
+  Custom [fetch](https://developer.mozilla.org/en-US/docs/Web/API/fetch) implementation.
+
+## Language Models
+
+You can create language models using a provider instance:
+
+```ts
+import { cerebras } from '@ai-sdk/cerebras';
+import { generateText } from 'ai';
+
+const { text } = await generateText({
+  model: cerebras('llama3.1-8b'),
+  prompt: 'Write a vegetarian lasagna recipe for 4 people.',
+});
+```
+
+Cerebras language models can be used in the `streamText` function
+(see [AI SDK Core](/docs/ai-sdk-core)).
+
+You can create Cerebras language models using a provider instance. The first argument is the model ID, e.g. `llama-3.3-70b`:
+
+```ts
+const model = cerebras('llama-3.3-70b');
+```
+
+You can also use the `.languageModel()` and `.chat()` methods:
+
+```ts
+const model = cerebras.languageModel('llama-3.3-70b');
+const model = cerebras.chat('llama-3.3-70b');
+```
+
+## Model Capabilities
+
+| Model                            | Image Input         | Object Generation   | Tool Usage          | Tool Streaming      |
+| -------------------------------- | ------------------- | ------------------- | ------------------- | ------------------- |
+| `llama3.1-8b`                    | <Cross size={18} /> | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> |
+| `llama-3.3-70b`                  | <Cross size={18} /> | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> |
+| `gpt-oss-120b`                   | <Cross size={18} /> | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> |
+| `qwen-3-32b`                     | <Cross size={18} /> | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> |
+| `qwen-3-235b-a22b-instruct-2507` | <Cross size={18} /> | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> |
+| `qwen-3-235b-a22b-thinking-2507` | <Cross size={18} /> | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> |
+| `zai-glm-4.6`                    | <Cross size={18} /> | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> |
+| `zai-glm-4.7`                    | <Cross size={18} /> | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> |
+
+<Note>
+  Please see the [Cerebras
+  docs](https://inference-docs.cerebras.ai/introduction) for more details about
+  the available models. Note that context windows are temporarily limited to
+  8192 tokens in the Free Tier. You can also pass any available provider model
+  ID as a string if needed.
+</Note>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ai-sdk/cerebras",
-  "version": "2.0.18",
+  "version": "2.0.19",
   "license": "Apache-2.0",
   "sideEffects": false,
   "main": "./dist/index.js",
@@ -8,10 +8,14 @@
   "types": "./dist/index.d.ts",
   "files": [
     "dist/**/*",
+    "docs/**/*",
     "src",
     "CHANGELOG.md",
     "README.md"
   ],
+  "directories": {
+    "doc": "./docs"
+  },
   "exports": {
     "./package.json": "./package.json",
     ".": {
@@ -58,7 +62,7 @@
   "scripts": {
     "build": "pnpm clean && tsup --tsconfig tsconfig.build.json",
     "build:watch": "pnpm clean && tsup --watch",
-    "clean": "del-cli dist *.tsbuildinfo",
+    "clean": "del-cli dist docs *.tsbuildinfo",
     "lint": "eslint \"./**/*.ts*\"",
     "type-check": "tsc --build",
     "prettier-check": "prettier --check \"./**/*.ts*\"",