@deepgram/sdk 1.4.5 → 1.4.7

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 DELETED
@@ -1,234 +0,0 @@
1
- # Changelog
2
-
3
- All notable changes to this project will be documented in this file.
4
-
5
- The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6
- and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
-
8
- ## [Unreleased]
9
-
10
- ---
11
-
12
- ## [1.4.5]
13
-
14
- ### Updated
15
-
16
- - Updated ReadStream to Readable
17
-
18
- ## [1.4.4]
19
-
20
- ### Added
21
-
22
- - Added `replace` to transcription option types
23
-
24
- ## [1.4.3]
25
-
26
- ### Added
27
-
28
- - Added `tier` to transcription option types
29
-
30
- ## [1.4.2]
31
-
32
- ### Added
33
-
34
- - Updated build step to build separate files for browser version
35
-
36
- ## [1.4.1]
37
-
38
- ### Added
39
-
40
- - Small fix for npm deployment
41
-
42
- ## [1.4.0]
43
-
44
- ### Added
45
-
46
- - Added Browser compatible versions of the live and preRecorded transcription methods
47
-
48
- ## [1.3.1]
49
-
50
- ### Updated
51
-
52
- - Updated user-agent header to be generated on build rather than on demand. This should remove warnings when using webpack
53
-
54
- ## [1.3.0]
55
-
56
- ### Added
57
-
58
- - Added Message Class for generic message responses
59
- - Added member endpoint functionality
60
- - This includes the `listMembers` and `removeMember` methods
61
- - Added Member and MemberList Class
62
- - Added scopes endpoint functionality
63
- - This includes the `get` and `update` methods
64
- - Added ScopeList Class
65
- - Added invites endpoint functionality
66
- - This includes the `list`, `send`, `leave` and `delete` methods
67
- - Added InvitationOptions and InvitationList Class
68
- - Added balances endpoint functionality
69
- - This includes the `listBalances` and `getBalance` methods
70
- - Added Balance and BalanceList Class
71
-
72
- ## [1.2.4]
73
-
74
- ### Fixed
75
-
76
- - Getting the list of API keys was returning the wrong type of object. The SDK now returns the correct object type, but also returns what was previously implemented with deprecation notices.
77
- - The `version` parameter was typed as required for both pre-recorded and live transcription. Changed this to be optional.
78
-
79
- ## [1.2.2]
80
-
81
- ### Updated
82
-
83
- - Updated the `wordBase` type to include an optional `speaker` property.
84
- - Updated the documentation for the speaker property of the `utterance` type.
85
-
86
- ## [1.2.1]
87
-
88
- ### Fixed
89
-
90
- - Fixed a bug that caused real-time transcriptions to not close correctly. This
91
- would result in the user not received the final transcription.
92
-
93
- ## [1.2.0]
94
-
95
- ### Updated
96
-
97
- - Updated the `keys.create` function to allow new `expirationDate` or `timeToLive`
98
- values. These are optional and one at most can be provided. Providing both will
99
- throw an error.
100
-
101
- ## [1.1.0]
102
-
103
- ### Added
104
-
105
- - Prerecorded transcription responses can now be used to generate WebVTT and
106
- SRT caption files. Example:
107
-
108
- ```js
109
- const response = await deepgram.transcription.preRecorded(
110
- { url: "URL_TO_FILE" },
111
- {
112
- punctuate: true,
113
- utterances: true,
114
- }
115
- );
116
- const webVTT = response.toWebVTT();
117
- const SRT = response.toSRT();
118
- ```
119
-
120
- The [utterances](https://developers.deepgram.com/documentation/features/utterances/)
121
- feature is required to use this functionality.
122
-
123
- ## [1.0.3]
124
-
125
- ### Added
126
-
127
- - In addition to a Url and Buffer, `trascricription.preRecorded` now accepts a
128
- ReadStream as a source of the file to transcribe.
129
-
130
- ### Updated
131
-
132
- - Removed a console log that occurred when an HTTP request ended
133
-
134
- ## [1.0.2]
135
-
136
- ### Added
137
-
138
- - `deepgram.projects.update` will now update a project
139
- - Prerecorded transcription responses now include utterances
140
-
141
- ### Updated
142
-
143
- - The project type has been modified to the following:
144
-
145
- ```ts
146
- {
147
- project_id: string;
148
- name?: string;
149
- company?: string;
150
- };
151
- ```
152
-
153
- - The key type has been modified to the following:
154
-
155
- ```ts
156
- {
157
- api_key_id: string;
158
- key?: string;
159
- comment: string;
160
- created: string;
161
- scopes: Array<string>;
162
- };
163
- ```
164
-
165
- - The usage request type has been modified to the following:
166
-
167
- ```ts
168
- {
169
- request_id: string;
170
- created: string;
171
- path: string;
172
- accessor: string;
173
- response?: UsageRequestDetail | UsageRequestMessage;
174
- callback?: UsageCallback;
175
- };
176
- ```
177
-
178
- ## [1.0.0]
179
-
180
- ### Added
181
-
182
- #### Live transcription
183
-
184
- - `deepgram.transcription.live` now manages a websocket connection to Deepgram's API
185
- for live transcription
186
-
187
- #### Projects
188
-
189
- - `deepgram.projects` allows listing projects or getting a specific project from
190
- your Deepgram account
191
-
192
- ### Updated
193
-
194
- #### Pre-recorded transcription
195
-
196
- - `deepgram.batch` has been moved to `deepgram.transcription.preRecorded`
197
- - Type of `source` parameter of pre-recorded transcriptions has changed. You can now
198
- send one of two types of objects: `{ url: YOUR_FILES_URL }` or
199
- `{ buffer: BUFFER_OF_YOUR_FILE, mimetype: FILES_MIME_TYPE }`
200
-
201
- #### API Key management
202
-
203
- - All `deepgram.keys` methods now require a `projectId`.
204
- - `deepgram.keys.create` now requires an additional parameter `scopes`. This is a
205
- string array specifying the scopes available to the newly created API key
206
-
207
- ## [0.6.5]
208
-
209
- - Added notice to README to denote the library is in a very unstable state.
210
-
211
- ## [0.6.4]
212
-
213
- ### Added
214
-
215
- - `transcribe` method will now return transcription results for both urls or buffers.
216
- - `keys` now provides `create`, `list`, and `delete` methods that allow managing of
217
- API keys.
218
-
219
- ---
220
-
221
- [unreleased]: https://github.com/deepgram/node-sdk/compare/1.4.0...HEAD
222
- [1.4.0]: https://github.com/deepgram/node-sdk/compare/1.3.1...1.4.0
223
- [1.3.1]: https://github.com/deepgram/node-sdk/compare/1.3.0...1.3.1
224
- [1.3.0]: https://github.com/deepgram/node-sdk/compare/1.2.4...1.3.0
225
- [1.2.4]: https://github.com/deepgram/node-sdk/compare/1.2.2...1.2.4
226
- [1.2.2]: https://github.com/deepgram/node-sdk/compare/1.2.1...1.2.2
227
- [1.2.1]: https://github.com/deepgram/node-sdk/compare/1.2.0...1.2.1
228
- [1.2.0]: https://github.com/deepgram/node-sdk/compare/1.1.0...1.2.0
229
- [1.1.0]: https://github.com/deepgram/node-sdk/compare/1.0.3...1.1.0
230
- [1.0.3]: https://github.com/deepgram/node-sdk/compare/1.0.2...1.0.3
231
- [1.0.2]: https://github.com/deepgram/node-sdk/compare/1.0.0...1.0.2
232
- [1.0.0]: https://github.com/deepgram/node-sdk/compare/0.6.5...1.0.0
233
- [0.6.5]: https://github.com/deepgram/node-sdk/compare/0.6.4...0.6.5
234
- [0.6.4]: https://github.com/deepgram/node-sdk/compare/edc07b4...0.6.4