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