Releases: AssemblyAI/assemblyai-node-sdk
Releases · AssemblyAI/assemblyai-node-sdk
v4.0.1
What's Changed
Added
- Add
"assemblyai/mistral-7b"
toLemurModel
type
Changed
- Update types with
@example
- Update types with
Format: uuid
if applicable
Full Changelog: v4.0.0...v4.0.1
v4.0.0
What's changed
Added
- Add
node
,deno
,bun
,browser
, andworkerd
(Cloudflare Workers) exports to package.json. These exports are compatible versions of the SDK, with a few limitations in some cases. For more details, consult the SDK Compatibility document. - Add
dist/assemblyai.umd.js
anddist/assemblyai.umd.min.js
. You can reference these script files directly in the browser and the SDK will be available at the globalassemblyai
variable.
Changed
RealtimeService.sendAudio
accepts audio via typeArrayBufferLike
.- Breaking:
RealtimeService.stream
returns a WHATWG Streams Standard stream, instead of a Node stream. In the browser, the native web standard stream will be used. ws
is used as the WebSocket client as before, but in the browser, the native WebSocket client is used.- Rename Node SDK to JavaScript SDK as the SDK is compatible with more runtimes now.
Full Changelog: v3.1.3...v4.0.0
v4.0.0-beta.0
What's Changed
Added
- Add
browser
andbrowser:min
exports, atdist/index.umd.js
anddist/index.umd.min.js
. These exports are browser compatible versions of the SDK, with a few limitations. You can't use the file system and you have to use a temporary auth token with the real-time transcriber.
Changed
RealtimeService.sendAudio
accepts audio via typeArrayBufferLike
.- Breaking:
RealtimeService.stream
returns a WHATWG Streams Standard stream, instead of a Node stream. In the browser, the native web standard stream will be used. ws
is used as the WebSocket client as before, but in the browser, the native WebSocket client is used.- Rename Node SDK to JavaScript SDK as the SDK is compatible with more runtimes now.
Full Changelog: v3.1.3...v4.0.0-beta.0
v3.1.3
v3.1.2
v3.1.1
What's Changed
Added
- Add
client.transcripts.transcribe
function to transcribe an audio file with polling until transcript status iscompleted
orerror
. This function takes anaudio
option which can be an audio file URL, path, stream, or buffer. - Add
client.transcripts.submit
function to queue a transcript. You can useclient.transcripts.waitUntilReady
to poll the transcript returned bysubmit
. This function also takes anaudio
option which can be an audio file URL, path, stream, or buffer.
Changed
- Deprecated
client.transcripts.create
in favor oftranscribe
andsubmit
, to be more consistent with other AssemblyAI SDKs. - Renamed types
- Renamed
Parameters
type suffix withParams
type suffix - Renamed
CreateTranscriptParameters
toTranscriptParams
- Renamed
CreateTranscriptOptionalParameters
toTranscriptOptionalParams
.
- Renamed
- Added deprecated aliases for the forementioned types
- Improved type docs
Full Changelog: v3.1.0...v3.1.1
v3.1.0
Added
- Add
AssemblyAI.transcripts.waitUntilReady
function to wait until a transcript is ready, meaningstatus
iscompleted
orerror
. - Add
chars_per_caption
parameter toAssemblyAI.transcripts.subtitles
function. - Add
input_text
property to LeMUR functions. Instead of usingtranscript_ids
, you can useinput_text
to provide custom formatted transcripts as input to LeMUR.
Changed
- Change default timeout from 3 minutes to infinite (-1). Fixes #17
Fixed
- Correctly serialize the keywords for
client.transcripts.wordSearch
. - Use more widely compatible syntax for wildcard exporting types. Fixes #18.
Full Changelog: v3.0.1...v3.1.0
v3.0.1
What's Changed
Changed
- The SDK uses
fetch
instead of Axios. This removes the Axios dependency. Axios relies on XMLHttpRequest which isn't supported in Cloudflare Workers, Deno, Bun, etc. By usingfetch
, the SDK is now more compatible on the forementioned runtimes.
Fixed
- The SDK uses relative imports instead of using path aliases, to make the library transpilable with tsc for consumers. Fixes #14.
- Added
speaker
property to theTranscriptUtterance
type, and removedchannel
property.
Full Changelog: v3.0.0...v3.0.1
v3.0.0
Changed
AssemblyAI.files.upload
accepts streams and buffers, in addition to a string (path to file).
Removed
- Breaking: The module does not have a default export anymore, because of inconsistent functionality across module systems. Instead, use
AssemblyAI
as a named import like this:import { AssemblyAI } from 'assemblyai'
.
Full Changelog: v2.0.2...v3.0.0
v2.0.2
What's Changed
AssemblyAI.transcripts.wordSearch
searches for keywords in the transcript.AssemblyAI.lemur.purgeRequestData
deletes data related to your LeMUR request.RealtimeService.stream
creates a writable stream that you can write audio data to instead of using RealtimeService.sendAudio.- Fix where the AssemblyAI class would be exported as default named export instead in certain module systems.
Full Changelog: v2.0.1...v2.0.2