assemblyai 4.3.2 → 4.3.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,38 @@
1
1
  # Changelog
2
2
 
3
+ ## [4.3.4] - 2024-04-02
4
+
5
+ ### Added
6
+
7
+ - `SpeechModel.Best` enum
8
+ - `TranscriptListItem.error` property
9
+
10
+ ### Updated
11
+
12
+ - Make `PageDetails.prev_url` nullable
13
+ - Rename Realtime to Streaming inside code documentation
14
+ - More inline code documentation
15
+
16
+ ### Fixed
17
+
18
+ - Rename `SubstitutionPolicy` literal "entity_type" to "entity_name"
19
+ - Fix the pagination example in "List transcripts" sample on README
20
+
21
+ ## [4.3.3] - 2024-03-18
22
+
23
+ ### Added
24
+
25
+ - GitHub action to generate API reference
26
+ - Generate API reference with Typedoc and host on GitHub Pages
27
+
28
+ ### Changed
29
+
30
+ - Add `conformer-2` to `SpeechModel` type
31
+ - Change `language_code` field to accept any string
32
+ - Move from JSDoc to TSDoc
33
+ - Update `ws` to 8.13.0
34
+ - Update dev dependencies (no public facing changes)
35
+
3
36
  ## [4.3.2] - 2024-03-08
4
37
 
5
38
  ### Added
package/README.md CHANGED
@@ -184,13 +184,18 @@ const page = await client.transcripts.list();
184
184
  You can also paginate over all pages.
185
185
 
186
186
  ```typescript
187
- let nextPageUrl: string | null = null;
187
+ let previousPageUrl: string | null = null;
188
188
  do {
189
- const page = await client.transcripts.list(nextPageUrl);
190
- nextPageUrl = page.page_details.next_url;
191
- } while (nextPageUrl !== null);
189
+ const page = await client.transcripts.list(previousPageUrl);
190
+ previousPageUrl = page.page_details.prev_url;
191
+ } while (previousPageUrl !== null);
192
192
  ```
193
193
 
194
+ > [!NOTE]
195
+ > To paginate over all pages, you need to use the `page.page_details.prev_url`
196
+ > because the transcripts are returned in descending order by creation date and time.
197
+ > The first page is are the most recent transcript, and each "previous" page are older transcripts.
198
+
194
199
  </details>
195
200
 
196
201
  <details>
@@ -107,7 +107,7 @@ export type SessionTerminated = RealtimeBaseMessage & {
107
107
  };
108
108
  export type TerminateSession = {
109
109
  /**
110
- * Set to true to end your real-time session forever
110
+ * Set to true to end your streaming session forever
111
111
  */
112
112
  terminate_session: boolean;
113
113
  };