@ai-sdk/assemblyai 0.0.0-70e0935a-20260114150030 → 0.0.0-98261322-20260122142521

package/CHANGELOG.md

@@ -1,12 +1,39 @@
 # @ai-sdk/assemblyai
 
-## 0.0.0-70e0935a-20260114150030
+## 0.0.0-98261322-20260122142521
 
 ### Patch Changes
 
-- Updated dependencies [9fbe723]
-  - @ai-sdk/provider-utils@0.0.0-70e0935a-20260114150030
-  - @ai-sdk/provider@0.0.0-70e0935a-20260114150030
+- 080559b: chore: add docs to package dist
+
+## 2.0.9
+
+### Patch Changes
+
+- 8dc54db: chore: add src folders to package bundle
+
+## 2.0.8
+
+### Patch Changes
+
+- Updated dependencies [5c090e7]
+  - @ai-sdk/provider@3.0.4
+  - @ai-sdk/provider-utils@4.0.8
+
+## 2.0.7
+
+### Patch Changes
+
+- Updated dependencies [46f46e4]
+  - @ai-sdk/provider-utils@4.0.7
+
+## 2.0.6
+
+### Patch Changes
+
+- Updated dependencies [1b11dcb]
+  - @ai-sdk/provider-utils@4.0.6
+  - @ai-sdk/provider@3.0.3
 
 ## 2.0.5
 

package/dist/index.js

@@ -401,7 +401,7 @@ var assemblyaiTranscriptionResponseSchema = import_v42.z.object({
 });
 
 // src/version.ts
-var VERSION = true ? "0.0.0-70e0935a-20260114150030" : "0.0.0-test";
+var VERSION = true ? "0.0.0-98261322-20260122142521" : "0.0.0-test";
 
 // src/assemblyai-provider.ts
 function createAssemblyAI(options = {}) {

package/dist/index.mjs

@@ -385,7 +385,7 @@ var assemblyaiTranscriptionResponseSchema = z2.object({
 });
 
 // src/version.ts
-var VERSION = true ? "0.0.0-70e0935a-20260114150030" : "0.0.0-test";
+var VERSION = true ? "0.0.0-98261322-20260122142521" : "0.0.0-test";
 
 // src/assemblyai-provider.ts
 function createAssemblyAI(options = {}) {

package/docs/100-assemblyai.mdx

@@ -0,0 +1,282 @@
+---
+title: AssemblyAI
+description: Learn how to use the AssemblyAI provider for the AI SDK.
+---
+
+# AssemblyAI Provider
+
+The [AssemblyAI](https://assemblyai.com/) provider contains language model support for the AssemblyAI transcription API.
+
+## Setup
+
+The AssemblyAI provider is available in the `@ai-sdk/assemblyai` module. You can install it with
+
+<Tabs items={['pnpm', 'npm', 'yarn', 'bun']}>
+  <Tab>
+    <Snippet text="pnpm add @ai-sdk/assemblyai" dark />
+  </Tab>
+  <Tab>
+    <Snippet text="npm install @ai-sdk/assemblyai" dark />
+  </Tab>
+  <Tab>
+    <Snippet text="yarn add @ai-sdk/assemblyai" dark />
+  </Tab>
+
+  <Tab>
+    <Snippet text="bun add @ai-sdk/assemblyai" dark />
+  </Tab>
+</Tabs>
+
+## Provider Instance
+
+You can import the default provider instance `assemblyai` from `@ai-sdk/assemblyai`:
+
+```ts
+import { assemblyai } from '@ai-sdk/assemblyai';
+```
+
+If you need a customized setup, you can import `createAssemblyAI` from `@ai-sdk/assemblyai` and create a provider instance with your settings:
+
+```ts
+import { createAssemblyAI } from '@ai-sdk/assemblyai';
+
+const assemblyai = createAssemblyAI({
+  // custom settings, e.g.
+  fetch: customFetch,
+});
+```
+
+You can use the following optional settings to customize the AssemblyAI provider instance:
+
+- **apiKey** _string_
+
+  API key that is being sent using the `Authorization` header.
+  It defaults to the `ASSEMBLYAI_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.
+  Defaults to the global `fetch` function.
+  You can use it as a middleware to intercept requests,
+  or to provide a custom fetch implementation for e.g. testing.
+
+## Transcription Models
+
+You can create models that call the [AssemblyAI transcription API](https://www.assemblyai.com/docs/getting-started/transcribe-an-audio-file/typescript)
+using the `.transcription()` factory method.
+
+The first argument is the model id e.g. `best`.
+
+```ts
+const model = assemblyai.transcription('best');
+```
+
+You can also pass additional provider-specific options using the `providerOptions` argument. For example, supplying the `contentSafety` option will enable content safety filtering.
+
+```ts highlight="6"
+import { experimental_transcribe as transcribe } from 'ai';
+import { assemblyai } from '@ai-sdk/assemblyai';
+import { readFile } from 'fs/promises';
+
+const result = await transcribe({
+  model: assemblyai.transcription('best'),
+  audio: await readFile('audio.mp3'),
+  providerOptions: { assemblyai: { contentSafety: true } },
+});
+```
+
+The following provider options are available:
+
+- **audioEndAt** _number_
+
+  End time of the audio in milliseconds.
+  Optional.
+
+- **audioStartFrom** _number_
+
+  Start time of the audio in milliseconds.
+  Optional.
+
+- **autoChapters** _boolean_
+
+  Whether to automatically generate chapters for the transcription.
+  Optional.
+
+- **autoHighlights** _boolean_
+
+  Whether to automatically generate highlights for the transcription.
+  Optional.
+
+- **boostParam** _enum_
+
+  Boost parameter for the transcription.
+  Allowed values: `'low'`, `'default'`, `'high'`.
+  Optional.
+
+- **contentSafety** _boolean_
+
+  Whether to enable content safety filtering.
+  Optional.
+
+- **contentSafetyConfidence** _number_
+
+  Confidence threshold for content safety filtering (25-100).
+  Optional.
+
+- **customSpelling** _array of objects_
+
+  Custom spelling rules for the transcription.
+  Each object has `from` (array of strings) and `to` (string) properties.
+  Optional.
+
+- **disfluencies** _boolean_
+
+  Whether to include disfluencies (um, uh, etc.) in the transcription.
+  Optional.
+
+- **entityDetection** _boolean_
+
+  Whether to detect entities in the transcription.
+  Optional.
+
+- **filterProfanity** _boolean_
+
+  Whether to filter profanity in the transcription.
+  Optional.
+
+- **formatText** _boolean_
+
+  Whether to format the text in the transcription.
+  Optional.
+
+- **iabCategories** _boolean_
+
+  Whether to include IAB categories in the transcription.
+  Optional.
+
+- **languageCode** _string_
+
+  Language code for the audio.
+  Supports numerous ISO-639-1 and ISO-639-3 language codes.
+  Optional.
+
+- **languageConfidenceThreshold** _number_
+
+  Confidence threshold for language detection.
+  Optional.
+
+- **languageDetection** _boolean_
+
+  Whether to enable language detection.
+  Optional.
+
+- **multichannel** _boolean_
+
+  Whether to process multiple audio channels separately.
+  Optional.
+
+- **punctuate** _boolean_
+
+  Whether to add punctuation to the transcription.
+  Optional.
+
+- **redactPii** _boolean_
+
+  Whether to redact personally identifiable information.
+  Optional.
+
+- **redactPiiAudio** _boolean_
+
+  Whether to redact PII in the audio file.
+  Optional.
+
+- **redactPiiAudioQuality** _enum_
+
+  Quality of the redacted audio file.
+  Allowed values: `'mp3'`, `'wav'`.
+  Optional.
+
+- **redactPiiPolicies** _array of enums_
+
+  Policies for PII redaction, specifying which types of information to redact.
+  Supports numerous types like `'person_name'`, `'phone_number'`, etc.
+  Optional.
+
+- **redactPiiSub** _enum_
+
+  Substitution method for redacted PII.
+  Allowed values: `'entity_name'`, `'hash'`.
+  Optional.
+
+- **sentimentAnalysis** _boolean_
+
+  Whether to perform sentiment analysis on the transcription.
+  Optional.
+
+- **speakerLabels** _boolean_
+
+  Whether to label different speakers in the transcription.
+  Optional.
+
+- **speakersExpected** _number_
+
+  Expected number of speakers in the audio.
+  Optional.
+
+- **speechThreshold** _number_
+
+  Threshold for speech detection (0-1).
+  Optional.
+
+- **summarization** _boolean_
+
+  Whether to generate a summary of the transcription.
+  Optional.
+
+- **summaryModel** _enum_
+
+  Model to use for summarization.
+  Allowed values: `'informative'`, `'conversational'`, `'catchy'`.
+  Optional.
+
+- **summaryType** _enum_
+
+  Type of summary to generate.
+  Allowed values: `'bullets'`, `'bullets_verbose'`, `'gist'`, `'headline'`, `'paragraph'`.
+  Optional.
+
+- **topics** _array of strings_
+
+  List of topics to detect in the transcription.
+  Optional.
+
+- **webhookAuthHeaderName** _string_
+
+  Name of the authentication header for webhook requests.
+  Optional.
+
+- **webhookAuthHeaderValue** _string_
+
+  Value of the authentication header for webhook requests.
+  Optional.
+
+- **webhookUrl** _string_
+
+  URL to send webhook notifications to.
+  Optional.
+
+- **wordBoost** _array of strings_
+
+  List of words to boost in the transcription.
+  Optional.
+
+### Model Capabilities
+
+| Model  | Transcription       | Duration            | Segments            | Language            |
+| ------ | ------------------- | ------------------- | ------------------- | ------------------- |
+| `best` | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> |
+| `nano` | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> | <Check size={18} /> |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ai-sdk/assemblyai",
-  "version": "0.0.0-70e0935a-20260114150030",
+  "version": "0.0.0-98261322-20260122142521",
   "license": "Apache-2.0",
   "sideEffects": false,
   "main": "./dist/index.js",
@@ -8,9 +8,14 @@
   "types": "./dist/index.d.ts",
   "files": [
     "dist/**/*",
+    "docs/**/*",
+    "src",
     "CHANGELOG.md",
     "README.md"
   ],
+  "directories": {
+    "doc": "./docs"
+  },
   "exports": {
     "./package.json": "./package.json",
     ".": {
@@ -20,15 +25,15 @@
     }
   },
   "dependencies": {
-    "@ai-sdk/provider": "0.0.0-70e0935a-20260114150030",
-    "@ai-sdk/provider-utils": "0.0.0-70e0935a-20260114150030"
+    "@ai-sdk/provider": "3.0.4",
+    "@ai-sdk/provider-utils": "4.0.8"
   },
   "devDependencies": {
     "@types/node": "20.17.24",
     "tsup": "^8",
     "typescript": "5.6.3",
     "zod": "3.25.76",
-    "@ai-sdk/test-server": "1.0.1",
+    "@ai-sdk/test-server": "1.0.2",
     "@vercel/ai-tsconfig": "0.0.0"
   },
   "peerDependencies": {
@@ -54,7 +59,7 @@
   "scripts": {
     "build": "pnpm clean && tsup --tsconfig tsconfig.build.json",
     "build:watch": "pnpm clean && tsup --watch --tsconfig tsconfig.build.json",
-    "clean": "del-cli dist *.tsbuildinfo",
+    "clean": "del-cli dist docs *.tsbuildinfo",
     "lint": "eslint \"./**/*.ts*\"",
     "type-check": "tsc --build",
     "prettier-check": "prettier --check \"./**/*.ts*\"",