assemblyai 4.2.0-beta.0 → 4.2.1

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## [4.2.1] - 2024-01-23
+
+### Added
+- Add `answer_format` to `LemurActionItemsParams` type
+
+### Changed
+- Rename `RealtimeService` to `RealtimeTranscriber`, `RealtimeServiceFactory` to `RealtimeTranscriberFactory`, `RealtimeTranscriberFactory.createService()` to `RealtimeTranscriberFactory.transcriber()`. Deprecated aliases are provided for all old types and functions for backwards compatibility.
+- Restrict the type for `redact_pii_audio_quality` from `string` to `RedactPiiAudioQuality` an enum string.
+
 ## [4.2.0] - 2024-01-11
 
 ### Added

package/README.md

@@ -184,18 +184,18 @@ const { response } = await client.lemur.task({
 });
 ```
 
-## Transcribe in real time
+## Transcribe in real-time
 
-Create the real-time service.
+Create the real-time transcriber.
 
 ```typescript
-const rt = client.realtime.createService();
+const rt = client.realtime.transcriber();
 ```
 
 You can also pass in the following options.
 
 ```typescript
-const rt = client.realtime.createService({
+const rt = client.realtime.transcriber({
   realtimeUrl: 'wss://localhost/override',
   apiKey: process.env.ASSEMBLYAI_API_KEY // The API key passed to `AssemblyAI` will be used by default,
   sampleRate: 16_000,
@@ -207,7 +207,7 @@ You can also generate a temporary auth token for real-time.
 
 ```typescript
 const token = await client.realtime.createTemporaryToken({ expires_in = 60 });
-const rt = client.realtime.createService({
+const rt = client.realtime.transcriber({
   token: token,
 });
 ```

package/dist/assemblyai.umd.js

@@ -195,7 +195,7 @@
     }
 
     const defaultRealtimeUrl = "wss://api.assemblyai.com/v2/realtime/ws";
-    class RealtimeService {
+    class RealtimeTranscriber {
         constructor(params) {
             var _a, _b;
             this.listeners = {};
@@ -342,18 +342,29 @@
             });
         }
     }
+    /**
+     * @deprecated Use RealtimeTranscriber instead
+     */
+    class RealtimeService extends RealtimeTranscriber {
+    }
 
-    class RealtimeServiceFactory extends BaseService {
+    class RealtimeTranscriberFactory extends BaseService {
         constructor(params) {
             super(params);
             this.rtFactoryParams = params;
         }
+        /**
+         * @deprecated Use transcriber(...) instead
+         */
         createService(params) {
+            return this.transcriber(params);
+        }
+        transcriber(params) {
             const serviceParams = Object.assign({}, params);
             if (!serviceParams.token && !serviceParams.apiKey) {
                 serviceParams.apiKey = this.rtFactoryParams.apiKey;
             }
-            return new RealtimeService(serviceParams);
+            return new RealtimeTranscriber(serviceParams);
         }
         createTemporaryToken(params) {
             return __awaiter(this, void 0, void 0, function* () {
@@ -365,6 +376,11 @@
             });
         }
     }
+    /**
+     * @deprecated Use RealtimeTranscriberFactory instead
+     */
+    class RealtimeServiceFactory extends RealtimeTranscriberFactory {
+    }
 
     class TranscriptService extends BaseService {
         constructor(params, files) {
@@ -628,7 +644,7 @@
             this.files = new FileService(params);
             this.transcripts = new TranscriptService(params, this.files);
             this.lemur = new LemurService(params);
-            this.realtime = new RealtimeServiceFactory(params);
+            this.realtime = new RealtimeTranscriberFactory(params);
         }
     }
 
@@ -637,6 +653,8 @@
     exports.LemurService = LemurService;
     exports.RealtimeService = RealtimeService;
     exports.RealtimeServiceFactory = RealtimeServiceFactory;
+    exports.RealtimeTranscriber = RealtimeTranscriber;
+    exports.RealtimeTranscriberFactory = RealtimeTranscriberFactory;
     exports.TranscriptService = TranscriptService;
 
 }));

package/dist/assemblyai.umd.min.js

@@ -1 +1 @@
-!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?t(exports):"function"==typeof define&&define.amd?define(["exports"],t):t((e="undefined"!=typeof globalThis?globalThis:e||self).assemblyai={})}(this,(function(e){"use strict";function t(e,t,s,i){return new(s||(s=Promise))((function(o,n){function r(e){try{c(i.next(e))}catch(e){n(e)}}function a(e){try{c(i.throw(e))}catch(e){n(e)}}function c(e){var t;e.done?o(e.value):(t=e.value,t instanceof s?t:new s((function(e){e(t)}))).then(r,a)}c((i=i.apply(e,t||[])).next())}))}"function"==typeof SuppressedError&&SuppressedError;class s{constructor(e){this.params=e}fetch(e,s){var i;return t(this,void 0,void 0,(function*(){(s=null!=s?s:{}).headers=null!==(i=s.headers)&&void 0!==i?i:{},s.headers=Object.assign({Authorization:this.params.apiKey,"Content-Type":"application/json"},s.headers),e.startsWith("http")||(e=this.params.baseUrl+e);const t=yield fetch(e,s);if(t.status>=400){let e;const s=yield t.text();if(s){try{e=JSON.parse(s)}catch(e){}if(null==e?void 0:e.error)throw new Error(e.error);throw new Error(s)}throw new Error(`HTTP Error: ${t.status} ${t.statusText}`)}return t}))}fetchJson(e,s){return t(this,void 0,void 0,(function*(){return(yield this.fetch(e,s)).json()}))}}class i extends s{summary(e){return this.fetchJson("/lemur/v3/generate/summary",{method:"POST",body:JSON.stringify(e)})}questionAnswer(e){return this.fetchJson("/lemur/v3/generate/question-answer",{method:"POST",body:JSON.stringify(e)})}actionItems(e){return this.fetchJson("/lemur/v3/generate/action-items",{method:"POST",body:JSON.stringify(e)})}task(e){return this.fetchJson("/lemur/v3/generate/task",{method:"POST",body:JSON.stringify(e)})}purgeRequestData(e){return this.fetchJson(`/lemur/v3/${e}`,{method:"DELETE"})}}const{WritableStream:o}="undefined"!=typeof window?window:"undefined"!=typeof global?global:globalThis;var n=null;"undefined"!=typeof WebSocket?n=WebSocket:"undefined"!=typeof MozWebSocket?n=MozWebSocket:"undefined"!=typeof global?n=global.WebSocket||global.MozWebSocket:"undefined"!=typeof window?n=window.WebSocket||window.MozWebSocket:"undefined"!=typeof self&&(n=self.WebSocket||self.MozWebSocket);var r,a=n;!function(e){e[e.BadSampleRate=4e3]="BadSampleRate",e[e.AuthFailed=4001]="AuthFailed",e[e.InsufficientFundsOrFreeAccount=4002]="InsufficientFundsOrFreeAccount",e[e.NonexistentSessionId=4004]="NonexistentSessionId",e[e.SessionExpired=4008]="SessionExpired",e[e.ClosedSession=4010]="ClosedSession",e[e.RateLimited=4029]="RateLimited",e[e.UniqueSessionViolation=4030]="UniqueSessionViolation",e[e.SessionTimeout=4031]="SessionTimeout",e[e.AudioTooShort=4032]="AudioTooShort",e[e.AudioTooLong=4033]="AudioTooLong",e[e.BadJson=4100]="BadJson",e[e.BadSchema=4101]="BadSchema",e[e.TooManyStreams=4102]="TooManyStreams",e[e.Reconnected=4103]="Reconnected",e[e.ReconnectAttemptsExhausted=1013]="ReconnectAttemptsExhausted"}(r||(r={}));const c={[r.BadSampleRate]:"Sample rate must be a positive integer",[r.AuthFailed]:"Not Authorized",[r.InsufficientFundsOrFreeAccount]:"Insufficient funds or you are using a free account. This feature is paid-only and requires you to add a credit card. Please visit https://assemblyai.com/dashboard/ to add a credit card to your account.",[r.NonexistentSessionId]:"Session ID does not exist",[r.SessionExpired]:"Session has expired",[r.ClosedSession]:"Session is closed",[r.RateLimited]:"Rate limited",[r.UniqueSessionViolation]:"Unique session violation",[r.SessionTimeout]:"Session Timeout",[r.AudioTooShort]:"Audio too short",[r.AudioTooLong]:"Audio too long",[r.BadJson]:"Bad JSON",[r.BadSchema]:"Bad schema",[r.TooManyStreams]:"Too many streams",[r.Reconnected]:"Reconnected",[r.ReconnectAttemptsExhausted]:"Reconnect attempts exhausted"};class l extends Error{}class d{constructor(e){var t,s;if(this.listeners={},this.realtimeUrl=null!==(t=e.realtimeUrl)&&void 0!==t?t:"wss://api.assemblyai.com/v2/realtime/ws",this.sampleRate=null!==(s=e.sampleRate)&&void 0!==s?s:16e3,this.wordBoost=e.wordBoost,this.encoding=e.encoding,"token"in e&&e.token&&(this.token=e.token),"apiKey"in e&&e.apiKey&&(this.apiKey=e.apiKey),!this.token&&!this.apiKey)throw new Error("API key or temporary token is required.")}connectionUrl(){const e=new URL(this.realtimeUrl);if("wss:"!==e.protocol)throw new Error("Invalid protocol, must be wss");const t=new URLSearchParams;return this.token&&t.set("token",this.token),t.set("sample_rate",this.sampleRate.toString()),this.wordBoost&&this.wordBoost.length>0&&t.set("word_boost",JSON.stringify(this.wordBoost)),this.encoding&&t.set("encoding",this.encoding),e.search=t.toString(),e}on(e,t){this.listeners[e]=t}connect(){return new Promise((e=>{if(this.socket)throw new Error("Already connected");const t=this.connectionUrl();this.token?this.socket=new a(t.toString()):this.socket=new a(t.toString(),{headers:{Authorization:this.apiKey}}),this.socket.binaryType="arraybuffer",this.socket.onclose=({code:e,reason:t})=>{var s,i;t||e in r&&(t=c[e]),null===(i=(s=this.listeners).close)||void 0===i||i.call(s,e,t)},this.socket.onerror=e=>{var t,s,i,o;e.error?null===(s=(t=this.listeners).error)||void 0===s||s.call(t,e.error):null===(o=(i=this.listeners).error)||void 0===o||o.call(i,new Error(e.message))},this.socket.onmessage=({data:t})=>{var s,i,o,n,r,a,c,d,u,h,f,p,m;const y=JSON.parse(t.toString());if("error"in y)null===(i=(s=this.listeners).error)||void 0===i||i.call(s,new l(y.error));else switch(y.message_type){case"SessionBegins":{const t={sessionId:y.session_id,expiresAt:new Date(y.expires_at)};e(t),null===(n=(o=this.listeners).open)||void 0===n||n.call(o,t);break}case"PartialTranscript":y.created=new Date(y.created),null===(a=(r=this.listeners).transcript)||void 0===a||a.call(r,y),null===(d=(c=this.listeners)["transcript.partial"])||void 0===d||d.call(c,y);break;case"FinalTranscript":y.created=new Date(y.created),null===(h=(u=this.listeners).transcript)||void 0===h||h.call(u,y),null===(p=(f=this.listeners)["transcript.final"])||void 0===p||p.call(f,y);break;case"SessionTerminated":null===(m=this.sessionTerminatedResolve)||void 0===m||m.call(this)}}}))}sendAudio(e){if(!this.socket||this.socket.readyState!==a.OPEN)throw new Error("Socket is not open for communication");this.socket.send(e)}stream(){return new o({write:e=>{this.sendAudio(e)}})}close(e=!0){return t(this,void 0,void 0,(function*(){if(this.socket){if(this.socket.readyState===a.OPEN){const t='{"terminate_session": true}';if(e){const e=new Promise((e=>{this.sessionTerminatedResolve=e}));this.socket.send(t),yield e}else this.socket.send(t)}"removeAllListeners"in this.socket&&this.socket.removeAllListeners(),this.socket.close()}this.listeners={},this.socket=void 0}))}}class u extends s{constructor(e){super(e),this.rtFactoryParams=e}createService(e){const t=Object.assign({},e);return t.token||t.apiKey||(t.apiKey=this.rtFactoryParams.apiKey),new d(t)}createTemporaryToken(e){return t(this,void 0,void 0,(function*(){return(yield this.fetchJson("/v2/realtime/token",{method:"POST",body:JSON.stringify(e)})).token}))}}class h extends s{constructor(e,t){super(e),this.files=t}transcribe(e,s){return t(this,void 0,void 0,(function*(){const t=yield this.submit(e);return yield this.waitUntilReady(t.id,s)}))}submit(e){return t(this,void 0,void 0,(function*(){const{audio:t}=e,s=function(e,t){var s={};for(var i in e)Object.prototype.hasOwnProperty.call(e,i)&&t.indexOf(i)<0&&(s[i]=e[i]);if(null!=e&&"function"==typeof Object.getOwnPropertySymbols){var o=0;for(i=Object.getOwnPropertySymbols(e);o<i.length;o++)t.indexOf(i[o])<0&&Object.prototype.propertyIsEnumerable.call(e,i[o])&&(s[i[o]]=e[i[o]])}return s}(e,["audio"]);let i;if("string"==typeof t){const e=f(t);i=null!==e?yield this.files.upload(e):t}else i=yield this.files.upload(t);return yield this.fetchJson("/v2/transcript",{method:"POST",body:JSON.stringify(Object.assign(Object.assign({},s),{audio_url:i}))})}))}create(e,s){var i;return t(this,void 0,void 0,(function*(){const t=f(e.audio_url);if(null!==t){const s=yield this.files.upload(t);e.audio_url=s}const o=yield this.fetchJson("/v2/transcript",{method:"POST",body:JSON.stringify(e)});return null===(i=null==s?void 0:s.poll)||void 0===i||i?yield this.waitUntilReady(o.id,s):o}))}waitUntilReady(e,s){var i,o;return t(this,void 0,void 0,(function*(){const t=null!==(i=null==s?void 0:s.pollingInterval)&&void 0!==i?i:3e3,n=null!==(o=null==s?void 0:s.pollingTimeout)&&void 0!==o?o:-1,r=Date.now();for(;;){const s=yield this.get(e);if("completed"===s.status||"error"===s.status)return s;if(n>0&&Date.now()-r>n)throw new Error("Polling timeout");yield new Promise((e=>setTimeout(e,t)))}}))}get(e){return this.fetchJson(`/v2/transcript/${e}`)}list(e){return t(this,void 0,void 0,(function*(){let t="/v2/transcript";"string"==typeof e?t=e:e&&(t=`${t}?${new URLSearchParams(Object.keys(e).map((t=>{var s;return[t,(null===(s=e[t])||void 0===s?void 0:s.toString())||""]})))}`);const s=yield this.fetchJson(t);for(const e of s.transcripts)e.created=new Date(e.created),e.completed&&(e.completed=new Date(e.completed));return s}))}delete(e){return this.fetchJson(`/v2/transcript/${e}`,{method:"DELETE"})}wordSearch(e,t){const s=new URLSearchParams({words:t.join(",")});return this.fetchJson(`/v2/transcript/${e}/word-search?${s.toString()}`)}sentences(e){return this.fetchJson(`/v2/transcript/${e}/sentences`)}paragraphs(e){return this.fetchJson(`/v2/transcript/${e}/paragraphs`)}subtitles(e,s="srt",i){return t(this,void 0,void 0,(function*(){let t=`/v2/transcript/${e}/${s}`;if(i){const e=new URLSearchParams;e.set("chars_per_caption",i.toString()),t+=`?${e.toString()}`}const o=yield this.fetch(t);return yield o.text()}))}redactions(e){return this.fetchJson(`/v2/transcript/${e}/redacted-audio`)}}function f(e){let t;try{return t=new URL(e),"file:"===t.protocol?t.pathname:null}catch(t){return e}}class p extends s{upload(e){return t(this,void 0,void 0,(function*(){let s;s="string"==typeof e?yield function(e){return t(this,void 0,void 0,(function*(){throw new Error("Interacting with the file system is not supported in this environment.")}))}():e;return(yield this.fetchJson("/v2/upload",{method:"POST",body:s,headers:{"Content-Type":"application/octet-stream"},duplex:"half"})).upload_url}))}}e.AssemblyAI=class{constructor(e){e.baseUrl=e.baseUrl||"https://api.assemblyai.com",e.baseUrl&&e.baseUrl.endsWith("/")&&(e.baseUrl=e.baseUrl.slice(0,-1)),this.files=new p(e),this.transcripts=new h(e,this.files),this.lemur=new i(e),this.realtime=new u(e)}},e.FileService=p,e.LemurService=i,e.RealtimeService=d,e.RealtimeServiceFactory=u,e.TranscriptService=h}));
+!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?t(exports):"function"==typeof define&&define.amd?define(["exports"],t):t((e="undefined"!=typeof globalThis?globalThis:e||self).assemblyai={})}(this,(function(e){"use strict";function t(e,t,s,i){return new(s||(s=Promise))((function(o,n){function r(e){try{c(i.next(e))}catch(e){n(e)}}function a(e){try{c(i.throw(e))}catch(e){n(e)}}function c(e){var t;e.done?o(e.value):(t=e.value,t instanceof s?t:new s((function(e){e(t)}))).then(r,a)}c((i=i.apply(e,t||[])).next())}))}"function"==typeof SuppressedError&&SuppressedError;class s{constructor(e){this.params=e}fetch(e,s){var i;return t(this,void 0,void 0,(function*(){(s=null!=s?s:{}).headers=null!==(i=s.headers)&&void 0!==i?i:{},s.headers=Object.assign({Authorization:this.params.apiKey,"Content-Type":"application/json"},s.headers),e.startsWith("http")||(e=this.params.baseUrl+e);const t=yield fetch(e,s);if(t.status>=400){let e;const s=yield t.text();if(s){try{e=JSON.parse(s)}catch(e){}if(null==e?void 0:e.error)throw new Error(e.error);throw new Error(s)}throw new Error(`HTTP Error: ${t.status} ${t.statusText}`)}return t}))}fetchJson(e,s){return t(this,void 0,void 0,(function*(){return(yield this.fetch(e,s)).json()}))}}class i extends s{summary(e){return this.fetchJson("/lemur/v3/generate/summary",{method:"POST",body:JSON.stringify(e)})}questionAnswer(e){return this.fetchJson("/lemur/v3/generate/question-answer",{method:"POST",body:JSON.stringify(e)})}actionItems(e){return this.fetchJson("/lemur/v3/generate/action-items",{method:"POST",body:JSON.stringify(e)})}task(e){return this.fetchJson("/lemur/v3/generate/task",{method:"POST",body:JSON.stringify(e)})}purgeRequestData(e){return this.fetchJson(`/lemur/v3/${e}`,{method:"DELETE"})}}const{WritableStream:o}="undefined"!=typeof window?window:"undefined"!=typeof global?global:globalThis;var n=null;"undefined"!=typeof WebSocket?n=WebSocket:"undefined"!=typeof MozWebSocket?n=MozWebSocket:"undefined"!=typeof global?n=global.WebSocket||global.MozWebSocket:"undefined"!=typeof window?n=window.WebSocket||window.MozWebSocket:"undefined"!=typeof self&&(n=self.WebSocket||self.MozWebSocket);var r,a=n;!function(e){e[e.BadSampleRate=4e3]="BadSampleRate",e[e.AuthFailed=4001]="AuthFailed",e[e.InsufficientFundsOrFreeAccount=4002]="InsufficientFundsOrFreeAccount",e[e.NonexistentSessionId=4004]="NonexistentSessionId",e[e.SessionExpired=4008]="SessionExpired",e[e.ClosedSession=4010]="ClosedSession",e[e.RateLimited=4029]="RateLimited",e[e.UniqueSessionViolation=4030]="UniqueSessionViolation",e[e.SessionTimeout=4031]="SessionTimeout",e[e.AudioTooShort=4032]="AudioTooShort",e[e.AudioTooLong=4033]="AudioTooLong",e[e.BadJson=4100]="BadJson",e[e.BadSchema=4101]="BadSchema",e[e.TooManyStreams=4102]="TooManyStreams",e[e.Reconnected=4103]="Reconnected",e[e.ReconnectAttemptsExhausted=1013]="ReconnectAttemptsExhausted"}(r||(r={}));const c={[r.BadSampleRate]:"Sample rate must be a positive integer",[r.AuthFailed]:"Not Authorized",[r.InsufficientFundsOrFreeAccount]:"Insufficient funds or you are using a free account. This feature is paid-only and requires you to add a credit card. Please visit https://assemblyai.com/dashboard/ to add a credit card to your account.",[r.NonexistentSessionId]:"Session ID does not exist",[r.SessionExpired]:"Session has expired",[r.ClosedSession]:"Session is closed",[r.RateLimited]:"Rate limited",[r.UniqueSessionViolation]:"Unique session violation",[r.SessionTimeout]:"Session Timeout",[r.AudioTooShort]:"Audio too short",[r.AudioTooLong]:"Audio too long",[r.BadJson]:"Bad JSON",[r.BadSchema]:"Bad schema",[r.TooManyStreams]:"Too many streams",[r.Reconnected]:"Reconnected",[r.ReconnectAttemptsExhausted]:"Reconnect attempts exhausted"};class l extends Error{}class d{constructor(e){var t,s;if(this.listeners={},this.realtimeUrl=null!==(t=e.realtimeUrl)&&void 0!==t?t:"wss://api.assemblyai.com/v2/realtime/ws",this.sampleRate=null!==(s=e.sampleRate)&&void 0!==s?s:16e3,this.wordBoost=e.wordBoost,this.encoding=e.encoding,"token"in e&&e.token&&(this.token=e.token),"apiKey"in e&&e.apiKey&&(this.apiKey=e.apiKey),!this.token&&!this.apiKey)throw new Error("API key or temporary token is required.")}connectionUrl(){const e=new URL(this.realtimeUrl);if("wss:"!==e.protocol)throw new Error("Invalid protocol, must be wss");const t=new URLSearchParams;return this.token&&t.set("token",this.token),t.set("sample_rate",this.sampleRate.toString()),this.wordBoost&&this.wordBoost.length>0&&t.set("word_boost",JSON.stringify(this.wordBoost)),this.encoding&&t.set("encoding",this.encoding),e.search=t.toString(),e}on(e,t){this.listeners[e]=t}connect(){return new Promise((e=>{if(this.socket)throw new Error("Already connected");const t=this.connectionUrl();this.token?this.socket=new a(t.toString()):this.socket=new a(t.toString(),{headers:{Authorization:this.apiKey}}),this.socket.binaryType="arraybuffer",this.socket.onclose=({code:e,reason:t})=>{var s,i;t||e in r&&(t=c[e]),null===(i=(s=this.listeners).close)||void 0===i||i.call(s,e,t)},this.socket.onerror=e=>{var t,s,i,o;e.error?null===(s=(t=this.listeners).error)||void 0===s||s.call(t,e.error):null===(o=(i=this.listeners).error)||void 0===o||o.call(i,new Error(e.message))},this.socket.onmessage=({data:t})=>{var s,i,o,n,r,a,c,d,u,h,f,p,m;const y=JSON.parse(t.toString());if("error"in y)null===(i=(s=this.listeners).error)||void 0===i||i.call(s,new l(y.error));else switch(y.message_type){case"SessionBegins":{const t={sessionId:y.session_id,expiresAt:new Date(y.expires_at)};e(t),null===(n=(o=this.listeners).open)||void 0===n||n.call(o,t);break}case"PartialTranscript":y.created=new Date(y.created),null===(a=(r=this.listeners).transcript)||void 0===a||a.call(r,y),null===(d=(c=this.listeners)["transcript.partial"])||void 0===d||d.call(c,y);break;case"FinalTranscript":y.created=new Date(y.created),null===(h=(u=this.listeners).transcript)||void 0===h||h.call(u,y),null===(p=(f=this.listeners)["transcript.final"])||void 0===p||p.call(f,y);break;case"SessionTerminated":null===(m=this.sessionTerminatedResolve)||void 0===m||m.call(this)}}}))}sendAudio(e){if(!this.socket||this.socket.readyState!==a.OPEN)throw new Error("Socket is not open for communication");this.socket.send(e)}stream(){return new o({write:e=>{this.sendAudio(e)}})}close(e=!0){return t(this,void 0,void 0,(function*(){if(this.socket){if(this.socket.readyState===a.OPEN){const t='{"terminate_session": true}';if(e){const e=new Promise((e=>{this.sessionTerminatedResolve=e}));this.socket.send(t),yield e}else this.socket.send(t)}"removeAllListeners"in this.socket&&this.socket.removeAllListeners(),this.socket.close()}this.listeners={},this.socket=void 0}))}}class u extends s{constructor(e){super(e),this.rtFactoryParams=e}createService(e){return this.transcriber(e)}transcriber(e){const t=Object.assign({},e);return t.token||t.apiKey||(t.apiKey=this.rtFactoryParams.apiKey),new d(t)}createTemporaryToken(e){return t(this,void 0,void 0,(function*(){return(yield this.fetchJson("/v2/realtime/token",{method:"POST",body:JSON.stringify(e)})).token}))}}class h extends s{constructor(e,t){super(e),this.files=t}transcribe(e,s){return t(this,void 0,void 0,(function*(){const t=yield this.submit(e);return yield this.waitUntilReady(t.id,s)}))}submit(e){return t(this,void 0,void 0,(function*(){const{audio:t}=e,s=function(e,t){var s={};for(var i in e)Object.prototype.hasOwnProperty.call(e,i)&&t.indexOf(i)<0&&(s[i]=e[i]);if(null!=e&&"function"==typeof Object.getOwnPropertySymbols){var o=0;for(i=Object.getOwnPropertySymbols(e);o<i.length;o++)t.indexOf(i[o])<0&&Object.prototype.propertyIsEnumerable.call(e,i[o])&&(s[i[o]]=e[i[o]])}return s}(e,["audio"]);let i;if("string"==typeof t){const e=f(t);i=null!==e?yield this.files.upload(e):t}else i=yield this.files.upload(t);return yield this.fetchJson("/v2/transcript",{method:"POST",body:JSON.stringify(Object.assign(Object.assign({},s),{audio_url:i}))})}))}create(e,s){var i;return t(this,void 0,void 0,(function*(){const t=f(e.audio_url);if(null!==t){const s=yield this.files.upload(t);e.audio_url=s}const o=yield this.fetchJson("/v2/transcript",{method:"POST",body:JSON.stringify(e)});return null===(i=null==s?void 0:s.poll)||void 0===i||i?yield this.waitUntilReady(o.id,s):o}))}waitUntilReady(e,s){var i,o;return t(this,void 0,void 0,(function*(){const t=null!==(i=null==s?void 0:s.pollingInterval)&&void 0!==i?i:3e3,n=null!==(o=null==s?void 0:s.pollingTimeout)&&void 0!==o?o:-1,r=Date.now();for(;;){const s=yield this.get(e);if("completed"===s.status||"error"===s.status)return s;if(n>0&&Date.now()-r>n)throw new Error("Polling timeout");yield new Promise((e=>setTimeout(e,t)))}}))}get(e){return this.fetchJson(`/v2/transcript/${e}`)}list(e){return t(this,void 0,void 0,(function*(){let t="/v2/transcript";"string"==typeof e?t=e:e&&(t=`${t}?${new URLSearchParams(Object.keys(e).map((t=>{var s;return[t,(null===(s=e[t])||void 0===s?void 0:s.toString())||""]})))}`);const s=yield this.fetchJson(t);for(const e of s.transcripts)e.created=new Date(e.created),e.completed&&(e.completed=new Date(e.completed));return s}))}delete(e){return this.fetchJson(`/v2/transcript/${e}`,{method:"DELETE"})}wordSearch(e,t){const s=new URLSearchParams({words:t.join(",")});return this.fetchJson(`/v2/transcript/${e}/word-search?${s.toString()}`)}sentences(e){return this.fetchJson(`/v2/transcript/${e}/sentences`)}paragraphs(e){return this.fetchJson(`/v2/transcript/${e}/paragraphs`)}subtitles(e,s="srt",i){return t(this,void 0,void 0,(function*(){let t=`/v2/transcript/${e}/${s}`;if(i){const e=new URLSearchParams;e.set("chars_per_caption",i.toString()),t+=`?${e.toString()}`}const o=yield this.fetch(t);return yield o.text()}))}redactions(e){return this.fetchJson(`/v2/transcript/${e}/redacted-audio`)}}function f(e){let t;try{return t=new URL(e),"file:"===t.protocol?t.pathname:null}catch(t){return e}}class p extends s{upload(e){return t(this,void 0,void 0,(function*(){let s;s="string"==typeof e?yield function(e){return t(this,void 0,void 0,(function*(){throw new Error("Interacting with the file system is not supported in this environment.")}))}():e;return(yield this.fetchJson("/v2/upload",{method:"POST",body:s,headers:{"Content-Type":"application/octet-stream"},duplex:"half"})).upload_url}))}}e.AssemblyAI=class{constructor(e){e.baseUrl=e.baseUrl||"https://api.assemblyai.com",e.baseUrl&&e.baseUrl.endsWith("/")&&(e.baseUrl=e.baseUrl.slice(0,-1)),this.files=new p(e),this.transcripts=new h(e,this.files),this.lemur=new i(e),this.realtime=new u(e)}},e.FileService=p,e.LemurService=i,e.RealtimeService=class extends d{},e.RealtimeServiceFactory=class extends u{},e.RealtimeTranscriber=d,e.RealtimeTranscriberFactory=u,e.TranscriptService=h}));

package/dist/bun.mjs

@@ -130,7 +130,7 @@ class RealtimeError extends Error {
 }
 
 const defaultRealtimeUrl = "wss://api.assemblyai.com/v2/realtime/ws";
-class RealtimeService {
+class RealtimeTranscriber {
     constructor(params) {
         this.listeners = {};
         this.realtimeUrl = params.realtimeUrl ?? defaultRealtimeUrl;
@@ -271,18 +271,29 @@ class RealtimeService {
         this.socket = undefined;
     }
 }
+/**
+ * @deprecated Use RealtimeTranscriber instead
+ */
+class RealtimeService extends RealtimeTranscriber {
+}
 
-class RealtimeServiceFactory extends BaseService {
+class RealtimeTranscriberFactory extends BaseService {
     constructor(params) {
         super(params);
         this.rtFactoryParams = params;
     }
+    /**
+     * @deprecated Use transcriber(...) instead
+     */
     createService(params) {
+        return this.transcriber(params);
+    }
+    transcriber(params) {
         const serviceParams = { ...params };
         if (!serviceParams.token && !serviceParams.apiKey) {
             serviceParams.apiKey = this.rtFactoryParams.apiKey;
         }
-        return new RealtimeService(serviceParams);
+        return new RealtimeTranscriber(serviceParams);
     }
     async createTemporaryToken(params) {
         const data = await this.fetchJson("/v2/realtime/token", {
@@ -292,6 +303,11 @@ class RealtimeServiceFactory extends BaseService {
         return data.token;
     }
 }
+/**
+ * @deprecated Use RealtimeTranscriberFactory instead
+ */
+class RealtimeServiceFactory extends RealtimeTranscriberFactory {
+}
 
 class TranscriptService extends BaseService {
     constructor(params, files) {
@@ -530,8 +546,8 @@ class AssemblyAI {
         this.files = new FileService(params);
         this.transcripts = new TranscriptService(params, this.files);
         this.lemur = new LemurService(params);
-        this.realtime = new RealtimeServiceFactory(params);
+        this.realtime = new RealtimeTranscriberFactory(params);
     }
 }
 
-export { AssemblyAI, FileService, LemurService, RealtimeService, RealtimeServiceFactory, TranscriptService };
+export { AssemblyAI, FileService, LemurService, RealtimeService, RealtimeServiceFactory, RealtimeTranscriber, RealtimeTranscriberFactory, TranscriptService };

package/dist/deno.mjs

@@ -130,7 +130,7 @@ class RealtimeError extends Error {
 }
 
 const defaultRealtimeUrl = "wss://api.assemblyai.com/v2/realtime/ws";
-class RealtimeService {
+class RealtimeTranscriber {
     constructor(params) {
         this.listeners = {};
         this.realtimeUrl = params.realtimeUrl ?? defaultRealtimeUrl;
@@ -271,18 +271,29 @@ class RealtimeService {
         this.socket = undefined;
     }
 }
+/**
+ * @deprecated Use RealtimeTranscriber instead
+ */
+class RealtimeService extends RealtimeTranscriber {
+}
 
-class RealtimeServiceFactory extends BaseService {
+class RealtimeTranscriberFactory extends BaseService {
     constructor(params) {
         super(params);
         this.rtFactoryParams = params;
     }
+    /**
+     * @deprecated Use transcriber(...) instead
+     */
     createService(params) {
+        return this.transcriber(params);
+    }
+    transcriber(params) {
         const serviceParams = { ...params };
         if (!serviceParams.token && !serviceParams.apiKey) {
             serviceParams.apiKey = this.rtFactoryParams.apiKey;
         }
-        return new RealtimeService(serviceParams);
+        return new RealtimeTranscriber(serviceParams);
     }
     async createTemporaryToken(params) {
         const data = await this.fetchJson("/v2/realtime/token", {
@@ -292,6 +303,11 @@ class RealtimeServiceFactory extends BaseService {
         return data.token;
     }
 }
+/**
+ * @deprecated Use RealtimeTranscriberFactory instead
+ */
+class RealtimeServiceFactory extends RealtimeTranscriberFactory {
+}
 
 class TranscriptService extends BaseService {
     constructor(params, files) {
@@ -530,8 +546,8 @@ class AssemblyAI {
         this.files = new FileService(params);
         this.transcripts = new TranscriptService(params, this.files);
         this.lemur = new LemurService(params);
-        this.realtime = new RealtimeServiceFactory(params);
+        this.realtime = new RealtimeTranscriberFactory(params);
     }
 }
 
-export { AssemblyAI, FileService, LemurService, RealtimeService, RealtimeServiceFactory, TranscriptService };
+export { AssemblyAI, FileService, LemurService, RealtimeService, RealtimeServiceFactory, RealtimeTranscriber, RealtimeTranscriberFactory, TranscriptService };

package/dist/index.cjs

@@ -177,7 +177,7 @@ class RealtimeError extends Error {
 }
 
 const defaultRealtimeUrl = "wss://api.assemblyai.com/v2/realtime/ws";
-class RealtimeService {
+class RealtimeTranscriber {
     constructor(params) {
         var _a, _b;
         this.listeners = {};
@@ -324,18 +324,29 @@ class RealtimeService {
         });
     }
 }
+/**
+ * @deprecated Use RealtimeTranscriber instead
+ */
+class RealtimeService extends RealtimeTranscriber {
+}
 
-class RealtimeServiceFactory extends BaseService {
+class RealtimeTranscriberFactory extends BaseService {
     constructor(params) {
         super(params);
         this.rtFactoryParams = params;
     }
+    /**
+     * @deprecated Use transcriber(...) instead
+     */
     createService(params) {
+        return this.transcriber(params);
+    }
+    transcriber(params) {
         const serviceParams = Object.assign({}, params);
         if (!serviceParams.token && !serviceParams.apiKey) {
             serviceParams.apiKey = this.rtFactoryParams.apiKey;
         }
-        return new RealtimeService(serviceParams);
+        return new RealtimeTranscriber(serviceParams);
     }
     createTemporaryToken(params) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -347,6 +358,11 @@ class RealtimeServiceFactory extends BaseService {
         });
     }
 }
+/**
+ * @deprecated Use RealtimeTranscriberFactory instead
+ */
+class RealtimeServiceFactory extends RealtimeTranscriberFactory {
+}
 
 class TranscriptService extends BaseService {
     constructor(params, files) {
@@ -610,7 +626,7 @@ class AssemblyAI {
         this.files = new FileService(params);
         this.transcripts = new TranscriptService(params, this.files);
         this.lemur = new LemurService(params);
-        this.realtime = new RealtimeServiceFactory(params);
+        this.realtime = new RealtimeTranscriberFactory(params);
     }
 }
 
@@ -619,4 +635,6 @@ exports.FileService = FileService;
 exports.LemurService = LemurService;
 exports.RealtimeService = RealtimeService;
 exports.RealtimeServiceFactory = RealtimeServiceFactory;
+exports.RealtimeTranscriber = RealtimeTranscriber;
+exports.RealtimeTranscriberFactory = RealtimeTranscriberFactory;
 exports.TranscriptService = TranscriptService;

package/dist/index.mjs

@@ -175,7 +175,7 @@ class RealtimeError extends Error {
 }
 
 const defaultRealtimeUrl = "wss://api.assemblyai.com/v2/realtime/ws";
-class RealtimeService {
+class RealtimeTranscriber {
     constructor(params) {
         var _a, _b;
         this.listeners = {};
@@ -322,18 +322,29 @@ class RealtimeService {
         });
     }
 }
+/**
+ * @deprecated Use RealtimeTranscriber instead
+ */
+class RealtimeService extends RealtimeTranscriber {
+}
 
-class RealtimeServiceFactory extends BaseService {
+class RealtimeTranscriberFactory extends BaseService {
     constructor(params) {
         super(params);
         this.rtFactoryParams = params;
     }
+    /**
+     * @deprecated Use transcriber(...) instead
+     */
     createService(params) {
+        return this.transcriber(params);
+    }
+    transcriber(params) {
         const serviceParams = Object.assign({}, params);
         if (!serviceParams.token && !serviceParams.apiKey) {
             serviceParams.apiKey = this.rtFactoryParams.apiKey;
         }
-        return new RealtimeService(serviceParams);
+        return new RealtimeTranscriber(serviceParams);
     }
     createTemporaryToken(params) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -345,6 +356,11 @@ class RealtimeServiceFactory extends BaseService {
         });
     }
 }
+/**
+ * @deprecated Use RealtimeTranscriberFactory instead
+ */
+class RealtimeServiceFactory extends RealtimeTranscriberFactory {
+}
 
 class TranscriptService extends BaseService {
     constructor(params, files) {
@@ -608,8 +624,8 @@ class AssemblyAI {
         this.files = new FileService(params);
         this.transcripts = new TranscriptService(params, this.files);
         this.lemur = new LemurService(params);
-        this.realtime = new RealtimeServiceFactory(params);
+        this.realtime = new RealtimeTranscriberFactory(params);
     }
 }
 
-export { AssemblyAI, FileService, LemurService, RealtimeService, RealtimeServiceFactory, TranscriptService };
+export { AssemblyAI, FileService, LemurService, RealtimeService, RealtimeServiceFactory, RealtimeTranscriber, RealtimeTranscriberFactory, TranscriptService };

package/dist/node.cjs

@@ -129,7 +129,7 @@ class RealtimeError extends Error {
 }
 
 const defaultRealtimeUrl = "wss://api.assemblyai.com/v2/realtime/ws";
-class RealtimeService {
+class RealtimeTranscriber {
     constructor(params) {
         this.listeners = {};
         this.realtimeUrl = params.realtimeUrl ?? defaultRealtimeUrl;
@@ -270,18 +270,29 @@ class RealtimeService {
         this.socket = undefined;
     }
 }
+/**
+ * @deprecated Use RealtimeTranscriber instead
+ */
+class RealtimeService extends RealtimeTranscriber {
+}
 
-class RealtimeServiceFactory extends BaseService {
+class RealtimeTranscriberFactory extends BaseService {
     constructor(params) {
         super(params);
         this.rtFactoryParams = params;
     }
+    /**
+     * @deprecated Use transcriber(...) instead
+     */
     createService(params) {
+        return this.transcriber(params);
+    }
+    transcriber(params) {
         const serviceParams = { ...params };
         if (!serviceParams.token && !serviceParams.apiKey) {
             serviceParams.apiKey = this.rtFactoryParams.apiKey;
         }
-        return new RealtimeService(serviceParams);
+        return new RealtimeTranscriber(serviceParams);
     }
     async createTemporaryToken(params) {
         const data = await this.fetchJson("/v2/realtime/token", {
@@ -291,6 +302,11 @@ class RealtimeServiceFactory extends BaseService {
         return data.token;
     }
 }
+/**
+ * @deprecated Use RealtimeTranscriberFactory instead
+ */
+class RealtimeServiceFactory extends RealtimeTranscriberFactory {
+}
 
 class TranscriptService extends BaseService {
     constructor(params, files) {
@@ -529,7 +545,7 @@ class AssemblyAI {
         this.files = new FileService(params);
         this.transcripts = new TranscriptService(params, this.files);
         this.lemur = new LemurService(params);
-        this.realtime = new RealtimeServiceFactory(params);
+        this.realtime = new RealtimeTranscriberFactory(params);
     }
 }
 
@@ -538,4 +554,6 @@ exports.FileService = FileService;
 exports.LemurService = LemurService;
 exports.RealtimeService = RealtimeService;
 exports.RealtimeServiceFactory = RealtimeServiceFactory;
+exports.RealtimeTranscriber = RealtimeTranscriber;
+exports.RealtimeTranscriberFactory = RealtimeTranscriberFactory;
 exports.TranscriptService = TranscriptService;

package/dist/node.mjs

@@ -127,7 +127,7 @@ class RealtimeError extends Error {
 }
 
 const defaultRealtimeUrl = "wss://api.assemblyai.com/v2/realtime/ws";
-class RealtimeService {
+class RealtimeTranscriber {
     constructor(params) {
         this.listeners = {};
         this.realtimeUrl = params.realtimeUrl ?? defaultRealtimeUrl;
@@ -268,18 +268,29 @@ class RealtimeService {
         this.socket = undefined;
     }
 }
+/**
+ * @deprecated Use RealtimeTranscriber instead
+ */
+class RealtimeService extends RealtimeTranscriber {
+}
 
-class RealtimeServiceFactory extends BaseService {
+class RealtimeTranscriberFactory extends BaseService {
     constructor(params) {
         super(params);
         this.rtFactoryParams = params;
     }
+    /**
+     * @deprecated Use transcriber(...) instead
+     */
     createService(params) {
+        return this.transcriber(params);
+    }
+    transcriber(params) {
         const serviceParams = { ...params };
         if (!serviceParams.token && !serviceParams.apiKey) {
             serviceParams.apiKey = this.rtFactoryParams.apiKey;
         }
-        return new RealtimeService(serviceParams);
+        return new RealtimeTranscriber(serviceParams);
     }
     async createTemporaryToken(params) {
         const data = await this.fetchJson("/v2/realtime/token", {
@@ -289,6 +300,11 @@ class RealtimeServiceFactory extends BaseService {
         return data.token;
     }
 }
+/**
+ * @deprecated Use RealtimeTranscriberFactory instead
+ */
+class RealtimeServiceFactory extends RealtimeTranscriberFactory {
+}
 
 class TranscriptService extends BaseService {
     constructor(params, files) {
@@ -527,8 +543,8 @@ class AssemblyAI {
         this.files = new FileService(params);
         this.transcripts = new TranscriptService(params, this.files);
         this.lemur = new LemurService(params);
-        this.realtime = new RealtimeServiceFactory(params);
+        this.realtime = new RealtimeTranscriberFactory(params);
     }
 }
 
-export { AssemblyAI, FileService, LemurService, RealtimeService, RealtimeServiceFactory, TranscriptService };
+export { AssemblyAI, FileService, LemurService, RealtimeService, RealtimeServiceFactory, RealtimeTranscriber, RealtimeTranscriberFactory, TranscriptService };

package/dist/polyfills/streams/node.d.ts

@@ -1 +1,2 @@
+/// <reference types="node" />
 export { WritableStream } from "stream/web";

package/dist/services/index.d.ts

@@ -1,6 +1,6 @@
 import { BaseServiceParams } from "..";
 import { LemurService } from "./lemur";
-import { RealtimeService, RealtimeServiceFactory } from "./realtime";
+import { RealtimeTranscriber, RealtimeTranscriberFactory, RealtimeService, RealtimeServiceFactory } from "./realtime";
 import { TranscriptService } from "./transcripts";
 import { FileService } from "./files";
 declare class AssemblyAI {
@@ -19,11 +19,11 @@ declare class AssemblyAI {
     /**
      * The realtime service.
      */
-    realtime: RealtimeServiceFactory;
+    realtime: RealtimeTranscriberFactory;
     /**
      * Create a new AssemblyAI client.
      * @param params The parameters for the service, including the API key and base URL, if any.
      */
     constructor(params: BaseServiceParams);
 }
-export { AssemblyAI, LemurService, RealtimeServiceFactory, RealtimeService, TranscriptService, FileService, };
+export { AssemblyAI, LemurService, RealtimeTranscriberFactory, RealtimeTranscriber, RealtimeServiceFactory, RealtimeService, TranscriptService, FileService, };

package/dist/services/realtime/factory.d.ts

@@ -1,9 +1,18 @@
-import { BaseServiceParams, RealtimeTokenParams, CreateRealtimeServiceParams } from "../..";
-import { RealtimeService } from "./service";
+import { BaseServiceParams, RealtimeTokenParams, CreateRealtimeTranscriberParams, CreateRealtimeServiceParams } from "../..";
+import { RealtimeService, RealtimeTranscriber } from "./service";
 import { BaseService } from "../base";
-export declare class RealtimeServiceFactory extends BaseService {
+export declare class RealtimeTranscriberFactory extends BaseService {
     private rtFactoryParams;
     constructor(params: BaseServiceParams);
+    /**
+     * @deprecated Use transcriber(...) instead
+     */
     createService(params?: CreateRealtimeServiceParams): RealtimeService;
+    transcriber(params?: CreateRealtimeTranscriberParams): RealtimeTranscriber;
     createTemporaryToken(params: RealtimeTokenParams): Promise<string>;
 }
+/**
+ * @deprecated Use RealtimeTranscriberFactory instead
+ */
+export declare class RealtimeServiceFactory extends RealtimeTranscriberFactory {
+}

package/dist/services/realtime/service.d.ts

@@ -1,5 +1,5 @@
-import { RealtimeServiceParams, RealtimeTranscript, PartialTranscript, FinalTranscript, SessionBeginsEventData } from "../..";
-export declare class RealtimeService {
+import { RealtimeTranscriberParams, RealtimeTranscript, PartialTranscript, FinalTranscript, SessionBeginsEventData, AudioData } from "../..";
+export declare class RealtimeTranscriber {
     private realtimeUrl;
     private sampleRate;
     private wordBoost?;
@@ -9,7 +9,7 @@ export declare class RealtimeService {
     private socket?;
     private listeners;
     private sessionTerminatedResolve?;
-    constructor(params: RealtimeServiceParams);
+    constructor(params: RealtimeTranscriberParams);
     private connectionUrl;
     on(event: "open", listener: (event: SessionBeginsEventData) => void): void;
     on(event: "transcript", listener: (transcript: RealtimeTranscript) => void): void;
@@ -18,7 +18,12 @@ export declare class RealtimeService {
     on(event: "error", listener: (error: Error) => void): void;
     on(event: "close", listener: (code: number, reason: string) => void): void;
     connect(): Promise<SessionBeginsEventData>;
-    sendAudio(audio: ArrayBufferLike): void;
-    stream(): WritableStream<ArrayBufferLike>;
+    sendAudio(audio: AudioData): void;
+    stream(): WritableStream<AudioData>;
     close(waitForSessionTermination?: boolean): Promise<void>;
 }
+/**
+ * @deprecated Use RealtimeTranscriber instead
+ */
+export declare class RealtimeService extends RealtimeTranscriber {
+}

package/dist/types/asyncapi.generated.d.ts

@@ -1,7 +1,8 @@
-export type AudioData = {
-    /** @description Base64 encoded raw audio data */
-    audio_data: string;
-};
+/**
+ * Format: binary
+ * @description Binary audio data
+ */
+export type AudioData = ArrayBufferLike;
 /**
  * @description The encoding of the audio data
  * @default pcm_s16le

package/dist/types/openapi.generated.d.ts

@@ -425,12 +425,21 @@ export type Error = {
  *     "64nygnr62k-405c-4ae8-8a6b-d90b40ff3cce"
  *   ],
  *   "context": "This is an interview about wildfires.",
+ *   "answer_format": "Bullet Points",
  *   "final_model": "default",
  *   "temperature": 0,
  *   "max_output_size": 3000
  * }
  */
-export type LemurActionItemsParams = LemurBaseParams;
+export type LemurActionItemsParams = LemurBaseParams & {
+    /**
+     * @description How you want the action items to be returned. This can be any text.
+     * Defaults to "Bullet Points".
+     *
+     * @default Bullet Points
+     */
+    answer_format?: string;
+};
 /**
  * @example {
  *   "request_id": "5e1b27c2-691f-4414-8bc5-f14678442f9e",
@@ -825,6 +834,13 @@ export type RedactedAudioResponse = {
  * @enum {string}
  */
 export type RedactedAudioStatus = "redacted_audio_ready";
+/**
+ * @description Controls the filetype of the audio created by redact_pii_audio. Currently supports mp3 (default) and wav. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details.
+ * @default mp3
+ * @example mp3
+ * @enum {string}
+ */
+export type RedactPiiAudioQuality = "mp3" | "wav";
 /**
  * @example {
  *   "sentences": [
@@ -1954,7 +1970,7 @@ export type Transcript = {
      * @description The audio quality of the PII-redacted audio file, if redact_pii_audio is enabled.
      * See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more information.
      */
-    redact_pii_audio_quality?: string | null;
+    redact_pii_audio_quality?: RedactPiiAudioQuality | null;
     /**
      * @description The list of PII Redaction policies that were enabled, if PII Redaction is enabled.
      * See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more information.
@@ -2097,7 +2113,7 @@ export type TranscriptList = {
  */
 export type TranscriptListItem = {
     audio_url: string;
-    completed?: Date;
+    completed: Date | null;
     created: Date;
     /** Format: uuid */
     id: string;
@@ -2198,7 +2214,7 @@ export type TranscriptOptionalParams = {
      * @description Controls the filetype of the audio created by redact_pii_audio. Currently supports mp3 (default) and wav. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details.
      * @default mp3
      */
-    redact_pii_audio_quality?: string;
+    redact_pii_audio_quality?: RedactPiiAudioQuality;
     /** @description The list of PII Redaction policies to enable. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details. */
     redact_pii_policies?: PiiPolicy[];
     /** @description The replacement logic for detected PII, can be "entity_type" or "hash". See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details. */

package/dist/types/realtime/index.d.ts

@@ -1,5 +1,5 @@
 import { AudioEncoding, FinalTranscript, PartialTranscript, RealtimeTranscript, RealtimeTranscriptType } from "../asyncapi.generated";
-type CreateRealtimeServiceParams = {
+type CreateRealtimeTranscriberParams = {
     realtimeUrl?: string;
     sampleRate?: number;
     wordBoost?: string[];
@@ -9,7 +9,11 @@ type CreateRealtimeServiceParams = {
 } | {
     token: string;
 });
-type RealtimeServiceParams = {
+/**
+ * @deprecated Use CreateRealtimeTranscriberParams instead
+ */
+type CreateRealtimeServiceParams = CreateRealtimeTranscriberParams;
+type RealtimeTranscriberParams = {
     realtimeUrl?: string;
     sampleRate?: number;
     wordBoost?: string[];
@@ -19,6 +23,10 @@ type RealtimeServiceParams = {
 } | {
     token: string;
 });
+/**
+ * @deprecated Use RealtimeTranscriberParams instead
+ */
+type RealtimeServiceParams = RealtimeTranscriberParams;
 type RealtimeEvents = "open" | "close" | "transcript" | "transcript.partial" | "transcript.final" | "error";
 type SessionBeginsEventData = {
     sessionId: string;
@@ -35,4 +43,4 @@ type RealtimeListeners = {
 type RealtimeTokenParams = {
     expires_in: number;
 };
-export type { CreateRealtimeServiceParams, RealtimeServiceParams, RealtimeEvents, RealtimeTranscriptType, SessionBeginsEventData, RealtimeListeners, RealtimeTokenParams, };
+export type { CreateRealtimeTranscriberParams, RealtimeTranscriberParams, CreateRealtimeServiceParams, RealtimeServiceParams, RealtimeEvents, RealtimeTranscriptType, SessionBeginsEventData, RealtimeListeners, RealtimeTokenParams, };

package/docs/compat.md

@@ -13,7 +13,7 @@ If you do use an older version of Node.js like version 16, you'll need to polyfi
 To make the SDK compatible with the browser, the SDK aims to use web standards as much as possible.
 However, there are still incompatibilities between Node.js and the browser.
 
-- `RealtimeService` doesn't support the AssemblyAI API key in the browser.
+- `RealtimeTranscriber` doesn't support the AssemblyAI API key in the browser.
   Instead, you have to generate a temporary auth token using `client.realtime.createTemporaryToken`, and pass in the resulting token to the real-time transcriber.
 
   Generate a temporary auth token on the server.
@@ -31,16 +31,16 @@ However, there are still incompatibilities between Node.js and the browser.
   > If you embed the API key on the client, everyone can see it and use it for themselves.
 
   Then pass the token via an API to the client.
-  On the client, create an instance of `RealtimeService` using the token.
+  On the client, create an instance of `RealtimeTranscriber` using the token.
 
   ```js
-  import { RealtimeService } from "assemblyai";
+  import { RealtimeTranscriber } from "assemblyai";
   // or the following if you're using UMD
-  // const { RealtimeService } = assemblyai;
+  // const { RealtimeTranscriber } = assemblyai;
 
   const token = getToken(); // getToken is a function for you to implement
 
-  const rt = new RealtimeService({
+  const rt = new RealtimeTranscriber({
     token: token,
   });
   ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "assemblyai",
-  "version": "4.2.0-beta.0",
+  "version": "4.2.1",
   "description": "The AssemblyAI JavaScript SDK provides an easy-to-use interface for interacting with the AssemblyAI API, which supports async and real-time transcription, as well as the latest LeMUR models.",
   "engines": {
     "node": ">=18"
@@ -61,7 +61,7 @@
     "url": "git+https://github.com/AssemblyAI/assemblyai-node-sdk.git"
   },
   "publishConfig": {
-    "tag": "beta",
+    "tag": "latest",
     "access": "public",
     "registry": "https://registry.npmjs.org/"
   },

package/src/services/index.ts

@@ -1,6 +1,11 @@
 import { BaseServiceParams } from "..";
 import { LemurService } from "./lemur";
-import { RealtimeService, RealtimeServiceFactory } from "./realtime";
+import {
+  RealtimeTranscriber,
+  RealtimeTranscriberFactory,
+  RealtimeService,
+  RealtimeServiceFactory,
+} from "./realtime";
 import { TranscriptService } from "./transcripts";
 import { FileService } from "./files";
 
@@ -25,7 +30,7 @@ class AssemblyAI {
   /**
    * The realtime service.
    */
-  public realtime: RealtimeServiceFactory;
+  public realtime: RealtimeTranscriberFactory;
 
   /**
    * Create a new AssemblyAI client.
@@ -38,13 +43,15 @@ class AssemblyAI {
     this.files = new FileService(params);
     this.transcripts = new TranscriptService(params, this.files);
     this.lemur = new LemurService(params);
-    this.realtime = new RealtimeServiceFactory(params);
+    this.realtime = new RealtimeTranscriberFactory(params);
   }
 }
 
 export {
   AssemblyAI,
   LemurService,
+  RealtimeTranscriberFactory,
+  RealtimeTranscriber,
   RealtimeServiceFactory,
   RealtimeService,
   TranscriptService,

package/src/services/realtime/factory.ts

@@ -1,27 +1,35 @@
 import {
   BaseServiceParams,
   RealtimeTokenParams,
-  CreateRealtimeServiceParams,
-  RealtimeServiceParams,
+  CreateRealtimeTranscriberParams,
+  RealtimeTranscriberParams,
   RealtimeTemporaryTokenResponse,
+  CreateRealtimeServiceParams,
 } from "../..";
-import { RealtimeService } from "./service";
+import { RealtimeService, RealtimeTranscriber } from "./service";
 import { BaseService } from "../base";
 
-export class RealtimeServiceFactory extends BaseService {
+export class RealtimeTranscriberFactory extends BaseService {
   private rtFactoryParams: BaseServiceParams;
   constructor(params: BaseServiceParams) {
     super(params);
     this.rtFactoryParams = params;
   }
 
+  /**
+   * @deprecated Use transcriber(...) instead
+   */
   createService(params?: CreateRealtimeServiceParams): RealtimeService {
+    return this.transcriber(params);
+  }
+
+  transcriber(params?: CreateRealtimeTranscriberParams): RealtimeTranscriber {
     const serviceParams = { ...params } as Record<string, unknown>;
     if (!serviceParams.token && !serviceParams.apiKey) {
       serviceParams.apiKey = this.rtFactoryParams.apiKey;
     }
 
-    return new RealtimeService(serviceParams as RealtimeServiceParams);
+    return new RealtimeTranscriber(serviceParams as RealtimeTranscriberParams);
   }
 
   async createTemporaryToken(params: RealtimeTokenParams) {
@@ -35,3 +43,8 @@ export class RealtimeServiceFactory extends BaseService {
     return data.token;
   }
 }
+
+/**
+ * @deprecated Use RealtimeTranscriberFactory instead
+ */
+export class RealtimeServiceFactory extends RealtimeTranscriberFactory {}

package/src/services/realtime/service.ts

@@ -4,13 +4,14 @@ import { ErrorEvent, MessageEvent, CloseEvent } from "ws";
 import {
   RealtimeEvents,
   RealtimeListeners,
-  RealtimeServiceParams,
+  RealtimeTranscriberParams,
   RealtimeMessage,
   RealtimeTranscript,
   PartialTranscript,
   FinalTranscript,
   SessionBeginsEventData,
   AudioEncoding,
+  AudioData,
 } from "../..";
 import {
   RealtimeError,
@@ -20,7 +21,7 @@ import {
 
 const defaultRealtimeUrl = "wss://api.assemblyai.com/v2/realtime/ws";
 
-export class RealtimeService {
+export class RealtimeTranscriber {
   private realtimeUrl: string;
   private sampleRate: number;
   private wordBoost?: string[];
@@ -31,7 +32,7 @@ export class RealtimeService {
   private listeners: RealtimeListeners = {};
   private sessionTerminatedResolve?: () => void;
 
-  constructor(params: RealtimeServiceParams) {
+  constructor(params: RealtimeTranscriberParams) {
     this.realtimeUrl = params.realtimeUrl ?? defaultRealtimeUrl;
     this.sampleRate = params.sampleRate ?? 16_000;
     this.wordBoost = params.wordBoost;
@@ -157,16 +158,16 @@ export class RealtimeService {
     });
   }
 
-  sendAudio(audio: ArrayBufferLike) {
+  sendAudio(audio: AudioData) {
     if (!this.socket || this.socket.readyState !== WebSocket.OPEN) {
       throw new Error("Socket is not open for communication");
     }
     this.socket.send(audio);
   }
 
-  stream(): WritableStream<ArrayBufferLike> {
-    return new WritableStream<ArrayBufferLike>({
-      write: (chunk: ArrayBufferLike) => {
+  stream(): WritableStream<AudioData> {
+    return new WritableStream<AudioData>({
+      write: (chunk: AudioData) => {
         this.sendAudio(chunk);
       },
     });
@@ -194,3 +195,8 @@ export class RealtimeService {
     this.socket = undefined;
   }
 }
+
+/**
+ * @deprecated Use RealtimeTranscriber instead
+ */
+export class RealtimeService extends RealtimeTranscriber {}

package/src/types/asyncapi.generated.ts

@@ -15,10 +15,11 @@ type OneOf<T extends any[]> = T extends [infer Only]
   ? OneOf<[XOR<A, B>, ...Rest]>
   : never;
 
-export type AudioData = {
-  /** @description Base64 encoded raw audio data */
-  audio_data: string;
-};
+/**
+ * Format: binary
+ * @description Binary audio data
+ */
+export type AudioData = ArrayBufferLike;
 
 /**
  * @description The encoding of the audio data

package/src/types/openapi.generated.ts

@@ -475,12 +475,21 @@ export type Error = {
  *     "64nygnr62k-405c-4ae8-8a6b-d90b40ff3cce"
  *   ],
  *   "context": "This is an interview about wildfires.",
+ *   "answer_format": "Bullet Points",
  *   "final_model": "default",
  *   "temperature": 0,
  *   "max_output_size": 3000
  * }
  */
-export type LemurActionItemsParams = LemurBaseParams;
+export type LemurActionItemsParams = LemurBaseParams & {
+  /**
+   * @description How you want the action items to be returned. This can be any text.
+   * Defaults to "Bullet Points".
+   *
+   * @default Bullet Points
+   */
+  answer_format?: string;
+};
 
 /**
  * @example {
@@ -931,6 +940,14 @@ export type RedactedAudioResponse = {
  */
 export type RedactedAudioStatus = "redacted_audio_ready";
 
+/**
+ * @description Controls the filetype of the audio created by redact_pii_audio. Currently supports mp3 (default) and wav. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details.
+ * @default mp3
+ * @example mp3
+ * @enum {string}
+ */
+export type RedactPiiAudioQuality = "mp3" | "wav";
+
 /**
  * @example {
  *   "sentences": [
@@ -2076,7 +2093,7 @@ export type Transcript = {
    * @description The audio quality of the PII-redacted audio file, if redact_pii_audio is enabled.
    * See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more information.
    */
-  redact_pii_audio_quality?: string | null;
+  redact_pii_audio_quality?: RedactPiiAudioQuality | null;
   /**
    * @description The list of PII Redaction policies that were enabled, if PII Redaction is enabled.
    * See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more information.
@@ -2244,7 +2261,7 @@ export type TranscriptList = {
  */
 export type TranscriptListItem = {
   audio_url: string;
-  completed?: Date;
+  completed: Date | null;
   created: Date;
   /** Format: uuid */
   id: string;
@@ -2346,7 +2363,7 @@ export type TranscriptOptionalParams = {
    * @description Controls the filetype of the audio created by redact_pii_audio. Currently supports mp3 (default) and wav. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details.
    * @default mp3
    */
-  redact_pii_audio_quality?: string;
+  redact_pii_audio_quality?: RedactPiiAudioQuality;
   /** @description The list of PII Redaction policies to enable. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details. */
   redact_pii_policies?: PiiPolicy[];
   /** @description The replacement logic for detected PII, can be "entity_type" or "hash". See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details. */

package/src/types/realtime/index.ts

@@ -6,7 +6,7 @@ import {
   RealtimeTranscriptType,
 } from "../asyncapi.generated";
 
-type CreateRealtimeServiceParams = {
+type CreateRealtimeTranscriberParams = {
   realtimeUrl?: string;
   sampleRate?: number;
   wordBoost?: string[];
@@ -20,7 +20,12 @@ type CreateRealtimeServiceParams = {
     }
 );
 
-type RealtimeServiceParams = {
+/**
+ * @deprecated Use CreateRealtimeTranscriberParams instead
+ */
+type CreateRealtimeServiceParams = CreateRealtimeTranscriberParams;
+
+type RealtimeTranscriberParams = {
   realtimeUrl?: string;
   sampleRate?: number;
   wordBoost?: string[];
@@ -34,6 +39,11 @@ type RealtimeServiceParams = {
     }
 );
 
+/**
+ * @deprecated Use RealtimeTranscriberParams instead
+ */
+type RealtimeServiceParams = RealtimeTranscriberParams;
+
 type RealtimeEvents =
   | "open"
   | "close"
@@ -61,6 +71,8 @@ type RealtimeTokenParams = {
 };
 
 export type {
+  CreateRealtimeTranscriberParams,
+  RealtimeTranscriberParams,
   CreateRealtimeServiceParams,
   RealtimeServiceParams,
   RealtimeEvents,