@deepgram/sdk 1.3.0 → 1.3.1-beta
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/.devcontainer/Dockerfile +16 -0
- package/.devcontainer/devcontainer.json +29 -0
- package/CHANGELOG.md +196 -190
- package/CODE_OF_CONDUCT.md +127 -127
- package/CONTRIBUTING.md +50 -50
- package/LICENSE +21 -21
- package/README.md +151 -151
- package/dist/billing.d.ts +18 -18
- package/dist/billing.js +72 -72
- package/dist/billing.js.map +1 -1
- package/dist/constants/defaultOptions.d.ts +6 -6
- package/dist/constants/defaultOptions.js +9 -9
- package/dist/constants/defaultOptions.js.map +0 -0
- package/dist/constants/index.d.ts +1 -1
- package/dist/constants/index.js +17 -13
- package/dist/constants/index.js.map +1 -1
- package/dist/enums/alternatives.d.ts +4 -4
- package/dist/enums/alternatives.js +2 -2
- package/dist/enums/alternatives.js.map +0 -0
- package/dist/enums/connectionState.d.ts +6 -6
- package/dist/enums/connectionState.js +10 -10
- package/dist/enums/connectionState.js.map +0 -0
- package/dist/enums/diarization.d.ts +4 -4
- package/dist/enums/diarization.js +2 -2
- package/dist/enums/diarization.js.map +0 -0
- package/dist/enums/index.d.ts +7 -7
- package/dist/enums/index.js +23 -19
- package/dist/enums/index.js.map +1 -1
- package/dist/enums/liveTranscriptionEvents.d.ts +6 -6
- package/dist/enums/liveTranscriptionEvents.js +2 -2
- package/dist/enums/liveTranscriptionEvents.js.map +0 -0
- package/dist/enums/models.d.ts +5 -5
- package/dist/enums/models.js +2 -2
- package/dist/enums/models.js.map +0 -0
- package/dist/enums/punctuation.d.ts +4 -4
- package/dist/enums/punctuation.js +2 -2
- package/dist/enums/punctuation.js.map +0 -0
- package/dist/enums/searchKind.d.ts +4 -4
- package/dist/enums/searchKind.js +2 -2
- package/dist/enums/searchKind.js.map +0 -0
- package/dist/helpers/index.d.ts +1 -1
- package/dist/helpers/index.js +17 -13
- package/dist/helpers/index.js.map +1 -1
- package/dist/helpers/secondsToTimestamp.d.ts +1 -1
- package/dist/helpers/secondsToTimestamp.js +7 -7
- package/dist/helpers/secondsToTimestamp.js.map +0 -0
- package/dist/httpRequest.d.ts +3 -3
- package/dist/httpRequest.js +90 -90
- package/dist/httpRequest.js.map +1 -1
- package/dist/index.d.ts +25 -25
- package/dist/index.js +40 -40
- package/dist/index.js.map +0 -0
- package/dist/invitation.d.ts +29 -29
- package/dist/invitation.js +98 -98
- package/dist/invitation.js.map +1 -1
- package/dist/keys.d.ts +32 -32
- package/dist/keys.js +131 -131
- package/dist/keys.js.map +1 -1
- package/dist/members.d.ts +18 -18
- package/dist/members.js +72 -72
- package/dist/members.js.map +1 -1
- package/dist/projects.d.ts +21 -21
- package/dist/projects.js +81 -81
- package/dist/projects.js.map +1 -1
- package/dist/scopes.d.ts +20 -20
- package/dist/scopes.js +76 -76
- package/dist/scopes.js.map +1 -1
- package/dist/transcription/index.d.ts +18 -18
- package/dist/transcription/index.js +71 -71
- package/dist/transcription/index.js.map +0 -0
- package/dist/transcription/liveTranscription.d.ts +23 -23
- package/dist/transcription/liveTranscription.js +82 -82
- package/dist/transcription/liveTranscription.js.map +1 -1
- package/dist/transcription/preRecordedTranscription.d.ts +8 -8
- package/dist/transcription/preRecordedTranscription.js +113 -113
- package/dist/transcription/preRecordedTranscription.js.map +1 -1
- package/dist/types/balance.d.ts +6 -6
- package/dist/types/balance.js +2 -2
- package/dist/types/balance.js.map +0 -0
- package/dist/types/balanceList.d.ts +4 -4
- package/dist/types/balanceList.js +2 -2
- package/dist/types/balanceList.js.map +0 -0
- package/dist/types/channel.d.ts +25 -25
- package/dist/types/channel.js +2 -2
- package/dist/types/channel.js.map +0 -0
- package/dist/types/createKeyOptions.d.ts +13 -13
- package/dist/types/createKeyOptions.js +2 -2
- package/dist/types/createKeyOptions.js.map +0 -0
- package/dist/types/hit.d.ts +21 -21
- package/dist/types/hit.js +2 -2
- package/dist/types/hit.js.map +0 -0
- package/dist/types/index.d.ts +35 -35
- package/dist/types/index.js +51 -47
- package/dist/types/index.js.map +1 -1
- package/dist/types/invitationList.d.ts +4 -4
- package/dist/types/invitationList.js +2 -2
- package/dist/types/invitationList.js.map +0 -0
- package/dist/types/invitationOptions.d.ts +4 -4
- package/dist/types/invitationOptions.js +2 -2
- package/dist/types/invitationOptions.js.map +0 -0
- package/dist/types/key.d.ts +25 -25
- package/dist/types/key.js +2 -2
- package/dist/types/key.js.map +0 -0
- package/dist/types/keyResponse.d.ts +50 -50
- package/dist/types/keyResponse.js +2 -2
- package/dist/types/keyResponse.js.map +0 -0
- package/dist/types/keyword.d.ts +4 -4
- package/dist/types/keyword.js +2 -2
- package/dist/types/keyword.js.map +0 -0
- package/dist/types/liveTranscriptionOptions.d.ts +148 -148
- package/dist/types/liveTranscriptionOptions.js +2 -2
- package/dist/types/liveTranscriptionOptions.js.map +0 -0
- package/dist/types/liveTranscriptionResponse.d.ts +9 -9
- package/dist/types/liveTranscriptionResponse.js +2 -2
- package/dist/types/liveTranscriptionResponse.js.map +0 -0
- package/dist/types/member.d.ts +7 -7
- package/dist/types/member.js +2 -2
- package/dist/types/member.js.map +0 -0
- package/dist/types/memberList.d.ts +4 -4
- package/dist/types/memberList.js +2 -2
- package/dist/types/memberList.js.map +0 -0
- package/dist/types/message.d.ts +3 -3
- package/dist/types/message.js +2 -2
- package/dist/types/message.js.map +0 -0
- package/dist/types/metadata.d.ts +8 -8
- package/dist/types/metadata.js +2 -2
- package/dist/types/metadata.js.map +0 -0
- package/dist/types/prerecordedTranscriptionOptions.d.ts +126 -126
- package/dist/types/prerecordedTranscriptionOptions.js +2 -2
- package/dist/types/prerecordedTranscriptionOptions.js.map +0 -0
- package/dist/types/prerecordedTranscriptionResponse.d.ts +25 -25
- package/dist/types/prerecordedTranscriptionResponse.js +50 -50
- package/dist/types/prerecordedTranscriptionResponse.js.map +1 -1
- package/dist/types/project.d.ts +17 -17
- package/dist/types/project.js +2 -2
- package/dist/types/project.js.map +0 -0
- package/dist/types/projectPatchResponse.d.ts +6 -6
- package/dist/types/projectPatchResponse.js +2 -2
- package/dist/types/projectPatchResponse.js.map +0 -0
- package/dist/types/projectResponse.d.ts +4 -4
- package/dist/types/projectResponse.js +2 -2
- package/dist/types/projectResponse.js.map +0 -0
- package/dist/types/scopeList.d.ts +3 -3
- package/dist/types/scopeList.js +2 -2
- package/dist/types/scopeList.js.map +0 -0
- package/dist/types/search.d.ts +14 -14
- package/dist/types/search.js +2 -2
- package/dist/types/search.js.map +0 -0
- package/dist/types/transcriptionSource.d.ts +14 -14
- package/dist/types/transcriptionSource.js +2 -2
- package/dist/types/transcriptionSource.js.map +0 -0
- package/dist/types/usageCallback.d.ts +4 -4
- package/dist/types/usageCallback.js +2 -2
- package/dist/types/usageCallback.js.map +0 -0
- package/dist/types/usageField.d.ts +7 -7
- package/dist/types/usageField.js +2 -2
- package/dist/types/usageField.js.map +0 -0
- package/dist/types/usageFieldOptions.d.ts +4 -4
- package/dist/types/usageFieldOptions.js +2 -2
- package/dist/types/usageFieldOptions.js.map +0 -0
- package/dist/types/usageOptions.d.ts +23 -23
- package/dist/types/usageOptions.js +2 -2
- package/dist/types/usageOptions.js.map +0 -0
- package/dist/types/usageRequest.d.ts +11 -11
- package/dist/types/usageRequest.js +2 -2
- package/dist/types/usageRequest.js.map +0 -0
- package/dist/types/usageRequestDetail.d.ts +30 -30
- package/dist/types/usageRequestDetail.js +2 -2
- package/dist/types/usageRequestDetail.js.map +0 -0
- package/dist/types/usageRequestList.d.ts +6 -6
- package/dist/types/usageRequestList.js +2 -2
- package/dist/types/usageRequestList.js.map +0 -0
- package/dist/types/usageRequestListOptions.d.ts +7 -7
- package/dist/types/usageRequestListOptions.js +2 -2
- package/dist/types/usageRequestListOptions.js.map +0 -0
- package/dist/types/usageRequestMessage.d.ts +3 -3
- package/dist/types/usageRequestMessage.js +2 -2
- package/dist/types/usageRequestMessage.js.map +0 -0
- package/dist/types/usageResponse.d.ts +10 -10
- package/dist/types/usageResponse.js +2 -2
- package/dist/types/usageResponse.js.map +0 -0
- package/dist/types/usageResponseDetail.d.ts +6 -6
- package/dist/types/usageResponseDetail.js +2 -2
- package/dist/types/usageResponseDetail.js.map +0 -0
- package/dist/types/utterance.d.ts +39 -39
- package/dist/types/utterance.js +2 -2
- package/dist/types/utterance.js.map +0 -0
- package/dist/types/wordBase.d.ts +8 -8
- package/dist/types/wordBase.js +2 -2
- package/dist/types/wordBase.js.map +0 -0
- package/dist/usage.d.ts +34 -34
- package/dist/usage.js +121 -121
- package/dist/usage.js.map +1 -1
- package/dist/userAgent.d.ts +1 -1
- package/dist/userAgent.js +19 -20
- package/dist/userAgent.js.map +1 -1
- package/package.json +59 -57
package/README.md
CHANGED
|
@@ -1,151 +1,151 @@
|
|
|
1
|
-
# Deepgram Node.js SDK
|
|
2
|
-
|
|
3
|
-
[](https://github.com/deepgram/node-sdk/actions/workflows/CI.yml) [](https://www.npmjs.com/package/@deepgram/sdk) [](CODE_OF_CONDUCT.md)
|
|
4
|
-
|
|
5
|
-
Official Node.js SDK for [Deepgram](https://www.deepgram.com/)'s automated
|
|
6
|
-
speech recognition APIs.
|
|
7
|
-
|
|
8
|
-
> This SDK only supports hosted usage of api.deepgram.com.
|
|
9
|
-
|
|
10
|
-
To access the API you will need a Deepgram account. Sign up for free at
|
|
11
|
-
[signup][signup].
|
|
12
|
-
|
|
13
|
-
## Documentation
|
|
14
|
-
|
|
15
|
-
Full documentation of the Node.js SDK can be found on the
|
|
16
|
-
[Deepgram Developer Portal](https://developers.deepgram.com/sdks-tools/sdks/node-sdk/).
|
|
17
|
-
|
|
18
|
-
You can learn more about the full Deepgram API at [https://developers.deepgram.com](https://developers.deepgram.com).
|
|
19
|
-
|
|
20
|
-
## Installation
|
|
21
|
-
|
|
22
|
-
### With NPM
|
|
23
|
-
|
|
24
|
-
```bash
|
|
25
|
-
npm install @deepgram/sdk
|
|
26
|
-
```
|
|
27
|
-
|
|
28
|
-
### With Yarn
|
|
29
|
-
|
|
30
|
-
```bash
|
|
31
|
-
yarn add @deepgram/sdk
|
|
32
|
-
```
|
|
33
|
-
|
|
34
|
-
## Constructor
|
|
35
|
-
|
|
36
|
-
```js
|
|
37
|
-
const { Deepgram } = require("@deepgram/sdk");
|
|
38
|
-
|
|
39
|
-
const deepgram = new Deepgram(DEEPGRAM_API_KEY);
|
|
40
|
-
```
|
|
41
|
-
|
|
42
|
-
## Examples
|
|
43
|
-
|
|
44
|
-
### Transcribe an Existing File
|
|
45
|
-
|
|
46
|
-
#### Remote Files
|
|
47
|
-
|
|
48
|
-
```js
|
|
49
|
-
const fileSource = { url: URL_OF_FILE };
|
|
50
|
-
|
|
51
|
-
const response = await deepgram.transcription.preRecorded(fileSource, {
|
|
52
|
-
punctuate: true,
|
|
53
|
-
});
|
|
54
|
-
```
|
|
55
|
-
|
|
56
|
-
#### Local Files
|
|
57
|
-
|
|
58
|
-
```js
|
|
59
|
-
const streamSource = {
|
|
60
|
-
stream: fs.createReadStream("/path/to/file"),
|
|
61
|
-
mimetype: MIMETYPE_OF_FILE,
|
|
62
|
-
};
|
|
63
|
-
|
|
64
|
-
const response = await deepgram.transcription.preRecorded(streamSource, {
|
|
65
|
-
punctuate: true,
|
|
66
|
-
});
|
|
67
|
-
```
|
|
68
|
-
|
|
69
|
-
### Transcribe Audio in Real-Time
|
|
70
|
-
|
|
71
|
-
```js
|
|
72
|
-
navigator.mediaDevices.getUserMedia({ audio: true }).then((stream) => {
|
|
73
|
-
const mediaRecorder = new MediaRecorder(stream, {
|
|
74
|
-
mimeType: 'audio/webm',
|
|
75
|
-
});
|
|
76
|
-
const deepgramSocket = deepgram.transcription.live({ punctuate: true });
|
|
77
|
-
|
|
78
|
-
deepgramSocket.addListener('open', () => {
|
|
79
|
-
mediaRecorder.addEventListener('dataavailable', async (event) => {
|
|
80
|
-
if (event.data.size > 0 && deepgramSocket.readyState == 1) {
|
|
81
|
-
deepgramSocket.send(event.data)
|
|
82
|
-
}
|
|
83
|
-
})
|
|
84
|
-
mediaRecorder.start(1000)
|
|
85
|
-
});
|
|
86
|
-
|
|
87
|
-
deepgramSocket.addListener("transcriptReceived", (received) => {
|
|
88
|
-
const transcript = received.channel.alternatives[0].transcript;
|
|
89
|
-
if (transcript && received.is_final) {
|
|
90
|
-
console.log(transcript);
|
|
91
|
-
}
|
|
92
|
-
});
|
|
93
|
-
});
|
|
94
|
-
```
|
|
95
|
-
|
|
96
|
-
## Samples
|
|
97
|
-
|
|
98
|
-
To run the sample code, first run the following in your terminal:
|
|
99
|
-
|
|
100
|
-
```bash
|
|
101
|
-
npm install
|
|
102
|
-
npm build
|
|
103
|
-
```
|
|
104
|
-
|
|
105
|
-
Then update the config object located at the top of the `index.js`
|
|
106
|
-
file in the sample folder.
|
|
107
|
-
|
|
108
|
-
```js
|
|
109
|
-
const config = {
|
|
110
|
-
deepgramApiKey: "YOUR_DEEPGRAM_API_KEY",
|
|
111
|
-
urlToFile:
|
|
112
|
-
"https://static.deepgram.com/examples/Bueller-Life-moves-pretty-fast.wav",
|
|
113
|
-
};
|
|
114
|
-
```
|
|
115
|
-
|
|
116
|
-
Finally, run the sample code using the following command in your terminal:
|
|
117
|
-
|
|
118
|
-
```bash
|
|
119
|
-
node sample/index.js
|
|
120
|
-
```
|
|
121
|
-
|
|
122
|
-
The sample demonstrates the following uses:
|
|
123
|
-
|
|
124
|
-
- Transcribing a prerecorded file
|
|
125
|
-
- Retrieving usage for a project
|
|
126
|
-
- Getting a project
|
|
127
|
-
- Creating an API key
|
|
128
|
-
- Deleting an API key
|
|
129
|
-
|
|
130
|
-
## Development and Contributing
|
|
131
|
-
|
|
132
|
-
Interested in contributing? We ❤️ pull requests!
|
|
133
|
-
|
|
134
|
-
To make sure our community is safe for all, be sure to review and agree to our
|
|
135
|
-
[Code of Conduct](./CODE_OF_CONDUCT.md). Then see the
|
|
136
|
-
[Contribution](./CONTRIBUTING.md) guidelines for more information.
|
|
137
|
-
|
|
138
|
-
## Getting Help
|
|
139
|
-
|
|
140
|
-
We love to hear from you so if you have questions, comments or find a bug in the
|
|
141
|
-
project, let us know! You can either:
|
|
142
|
-
|
|
143
|
-
- [Open an issue](https://github.com/deepgram/node-sdk/issues/new) on this repository
|
|
144
|
-
- Tweet at us! We're [@DeepgramDevs on Twitter](https://twitter.com/DeepgramDevs)
|
|
145
|
-
|
|
146
|
-
## Further Reading
|
|
147
|
-
|
|
148
|
-
Check out the Developer Documentation at [https://developers.deepgram.com/](https://developers.deepgram.com/)
|
|
149
|
-
|
|
150
|
-
[signup]: https://console.deepgram.com/signup?utm_medium=github&utm_source=DEVREL&utm_content=node-sdk
|
|
151
|
-
[license]: LICENSE.txt
|
|
1
|
+
# Deepgram Node.js SDK
|
|
2
|
+
|
|
3
|
+
[](https://github.com/deepgram/node-sdk/actions/workflows/CI.yml) [](https://www.npmjs.com/package/@deepgram/sdk) [](CODE_OF_CONDUCT.md)
|
|
4
|
+
|
|
5
|
+
Official Node.js SDK for [Deepgram](https://www.deepgram.com/)'s automated
|
|
6
|
+
speech recognition APIs.
|
|
7
|
+
|
|
8
|
+
> This SDK only supports hosted usage of api.deepgram.com.
|
|
9
|
+
|
|
10
|
+
To access the API you will need a Deepgram account. Sign up for free at
|
|
11
|
+
[signup][signup].
|
|
12
|
+
|
|
13
|
+
## Documentation
|
|
14
|
+
|
|
15
|
+
Full documentation of the Node.js SDK can be found on the
|
|
16
|
+
[Deepgram Developer Portal](https://developers.deepgram.com/sdks-tools/sdks/node-sdk/).
|
|
17
|
+
|
|
18
|
+
You can learn more about the full Deepgram API at [https://developers.deepgram.com](https://developers.deepgram.com).
|
|
19
|
+
|
|
20
|
+
## Installation
|
|
21
|
+
|
|
22
|
+
### With NPM
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
npm install @deepgram/sdk
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
### With Yarn
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
yarn add @deepgram/sdk
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
## Constructor
|
|
35
|
+
|
|
36
|
+
```js
|
|
37
|
+
const { Deepgram } = require("@deepgram/sdk");
|
|
38
|
+
|
|
39
|
+
const deepgram = new Deepgram(DEEPGRAM_API_KEY);
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
## Examples
|
|
43
|
+
|
|
44
|
+
### Transcribe an Existing File
|
|
45
|
+
|
|
46
|
+
#### Remote Files
|
|
47
|
+
|
|
48
|
+
```js
|
|
49
|
+
const fileSource = { url: URL_OF_FILE };
|
|
50
|
+
|
|
51
|
+
const response = await deepgram.transcription.preRecorded(fileSource, {
|
|
52
|
+
punctuate: true,
|
|
53
|
+
});
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
#### Local Files
|
|
57
|
+
|
|
58
|
+
```js
|
|
59
|
+
const streamSource = {
|
|
60
|
+
stream: fs.createReadStream("/path/to/file"),
|
|
61
|
+
mimetype: MIMETYPE_OF_FILE,
|
|
62
|
+
};
|
|
63
|
+
|
|
64
|
+
const response = await deepgram.transcription.preRecorded(streamSource, {
|
|
65
|
+
punctuate: true,
|
|
66
|
+
});
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### Transcribe Audio in Real-Time
|
|
70
|
+
|
|
71
|
+
```js
|
|
72
|
+
navigator.mediaDevices.getUserMedia({ audio: true }).then((stream) => {
|
|
73
|
+
const mediaRecorder = new MediaRecorder(stream, {
|
|
74
|
+
mimeType: 'audio/webm',
|
|
75
|
+
});
|
|
76
|
+
const deepgramSocket = deepgram.transcription.live({ punctuate: true });
|
|
77
|
+
|
|
78
|
+
deepgramSocket.addListener('open', () => {
|
|
79
|
+
mediaRecorder.addEventListener('dataavailable', async (event) => {
|
|
80
|
+
if (event.data.size > 0 && deepgramSocket.readyState == 1) {
|
|
81
|
+
deepgramSocket.send(event.data)
|
|
82
|
+
}
|
|
83
|
+
})
|
|
84
|
+
mediaRecorder.start(1000)
|
|
85
|
+
});
|
|
86
|
+
|
|
87
|
+
deepgramSocket.addListener("transcriptReceived", (received) => {
|
|
88
|
+
const transcript = received.channel.alternatives[0].transcript;
|
|
89
|
+
if (transcript && received.is_final) {
|
|
90
|
+
console.log(transcript);
|
|
91
|
+
}
|
|
92
|
+
});
|
|
93
|
+
});
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
## Samples
|
|
97
|
+
|
|
98
|
+
To run the sample code, first run the following in your terminal:
|
|
99
|
+
|
|
100
|
+
```bash
|
|
101
|
+
npm install
|
|
102
|
+
npm build
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
Then update the config object located at the top of the `index.js`
|
|
106
|
+
file in the sample folder.
|
|
107
|
+
|
|
108
|
+
```js
|
|
109
|
+
const config = {
|
|
110
|
+
deepgramApiKey: "YOUR_DEEPGRAM_API_KEY",
|
|
111
|
+
urlToFile:
|
|
112
|
+
"https://static.deepgram.com/examples/Bueller-Life-moves-pretty-fast.wav",
|
|
113
|
+
};
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
Finally, run the sample code using the following command in your terminal:
|
|
117
|
+
|
|
118
|
+
```bash
|
|
119
|
+
node sample/index.js
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
The sample demonstrates the following uses:
|
|
123
|
+
|
|
124
|
+
- Transcribing a prerecorded file
|
|
125
|
+
- Retrieving usage for a project
|
|
126
|
+
- Getting a project
|
|
127
|
+
- Creating an API key
|
|
128
|
+
- Deleting an API key
|
|
129
|
+
|
|
130
|
+
## Development and Contributing
|
|
131
|
+
|
|
132
|
+
Interested in contributing? We ❤️ pull requests!
|
|
133
|
+
|
|
134
|
+
To make sure our community is safe for all, be sure to review and agree to our
|
|
135
|
+
[Code of Conduct](./CODE_OF_CONDUCT.md). Then see the
|
|
136
|
+
[Contribution](./CONTRIBUTING.md) guidelines for more information.
|
|
137
|
+
|
|
138
|
+
## Getting Help
|
|
139
|
+
|
|
140
|
+
We love to hear from you so if you have questions, comments or find a bug in the
|
|
141
|
+
project, let us know! You can either:
|
|
142
|
+
|
|
143
|
+
- [Open an issue](https://github.com/deepgram/node-sdk/issues/new) on this repository
|
|
144
|
+
- Tweet at us! We're [@DeepgramDevs on Twitter](https://twitter.com/DeepgramDevs)
|
|
145
|
+
|
|
146
|
+
## Further Reading
|
|
147
|
+
|
|
148
|
+
Check out the Developer Documentation at [https://developers.deepgram.com/](https://developers.deepgram.com/)
|
|
149
|
+
|
|
150
|
+
[signup]: https://console.deepgram.com/signup?utm_medium=github&utm_source=DEVREL&utm_content=node-sdk
|
|
151
|
+
[license]: LICENSE.txt
|
package/dist/billing.d.ts
CHANGED
|
@@ -1,18 +1,18 @@
|
|
|
1
|
-
import { BalanceList, Balance } from "./types";
|
|
2
|
-
export declare class Billing {
|
|
3
|
-
private _credentials;
|
|
4
|
-
private _apiUrl;
|
|
5
|
-
constructor(_credentials: string, _apiUrl: string);
|
|
6
|
-
private apiPath;
|
|
7
|
-
/**
|
|
8
|
-
* Retrieves list of balance info of the specified project.
|
|
9
|
-
* @param projectId Unique identifier of the project
|
|
10
|
-
*/
|
|
11
|
-
listBalances(projectId: string): Promise<BalanceList>;
|
|
12
|
-
/**
|
|
13
|
-
* Retrieves balance info of a specified balance_id in the specified project.
|
|
14
|
-
* @param projectId Unique identifier of the project
|
|
15
|
-
* @param balanceId Unique identifier of the balance
|
|
16
|
-
*/
|
|
17
|
-
getBalance(projectId: string, balanceId: string): Promise<Balance>;
|
|
18
|
-
}
|
|
1
|
+
import { BalanceList, Balance } from "./types";
|
|
2
|
+
export declare class Billing {
|
|
3
|
+
private _credentials;
|
|
4
|
+
private _apiUrl;
|
|
5
|
+
constructor(_credentials: string, _apiUrl: string);
|
|
6
|
+
private apiPath;
|
|
7
|
+
/**
|
|
8
|
+
* Retrieves list of balance info of the specified project.
|
|
9
|
+
* @param projectId Unique identifier of the project
|
|
10
|
+
*/
|
|
11
|
+
listBalances(projectId: string): Promise<BalanceList>;
|
|
12
|
+
/**
|
|
13
|
+
* Retrieves balance info of a specified balance_id in the specified project.
|
|
14
|
+
* @param projectId Unique identifier of the project
|
|
15
|
+
* @param balanceId Unique identifier of the balance
|
|
16
|
+
*/
|
|
17
|
+
getBalance(projectId: string, balanceId: string): Promise<Balance>;
|
|
18
|
+
}
|
package/dist/billing.js
CHANGED
|
@@ -1,73 +1,73 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
3
|
-
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
4
|
-
return new (P || (P = Promise))(function (resolve, reject) {
|
|
5
|
-
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
6
|
-
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
7
|
-
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
8
|
-
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
9
|
-
});
|
|
10
|
-
};
|
|
11
|
-
var __generator = (this && this.__generator) || function (thisArg, body) {
|
|
12
|
-
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
|
|
13
|
-
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
|
|
14
|
-
function verb(n) { return function (v) { return step([n, v]); }; }
|
|
15
|
-
function step(op) {
|
|
16
|
-
if (f) throw new TypeError("Generator is already executing.");
|
|
17
|
-
while (_) try {
|
|
18
|
-
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
|
|
19
|
-
if (y = 0, t) op = [op[0] & 2, t.value];
|
|
20
|
-
switch (op[0]) {
|
|
21
|
-
case 0: case 1: t = op; break;
|
|
22
|
-
case 4: _.label++; return { value: op[1], done: false };
|
|
23
|
-
case 5: _.label++; y = op[1]; op = [0]; continue;
|
|
24
|
-
case 7: op = _.ops.pop(); _.trys.pop(); continue;
|
|
25
|
-
default:
|
|
26
|
-
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
|
|
27
|
-
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
|
|
28
|
-
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
|
|
29
|
-
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
|
|
30
|
-
if (t[2]) _.ops.pop();
|
|
31
|
-
_.trys.pop(); continue;
|
|
32
|
-
}
|
|
33
|
-
op = body.call(thisArg, _);
|
|
34
|
-
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
|
|
35
|
-
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
|
|
36
|
-
}
|
|
37
|
-
};
|
|
38
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
39
|
-
exports.Billing = void 0;
|
|
40
|
-
var httpRequest_1 = require("./httpRequest");
|
|
41
|
-
var Billing = /** @class */ (function () {
|
|
42
|
-
function Billing(_credentials, _apiUrl) {
|
|
43
|
-
this._credentials = _credentials;
|
|
44
|
-
this._apiUrl = _apiUrl;
|
|
45
|
-
this.apiPath = "/v1/projects";
|
|
46
|
-
}
|
|
47
|
-
/**
|
|
48
|
-
* Retrieves list of balance info of the specified project.
|
|
49
|
-
* @param projectId Unique identifier of the project
|
|
50
|
-
*/
|
|
51
|
-
Billing.prototype.listBalances = function (projectId) {
|
|
52
|
-
return __awaiter(this, void 0, void 0, function () {
|
|
53
|
-
return __generator(this, function (_a) {
|
|
54
|
-
return [2 /*return*/, (0, httpRequest_1._request)("GET", this._credentials, this._apiUrl, this.apiPath
|
|
55
|
-
});
|
|
56
|
-
});
|
|
57
|
-
};
|
|
58
|
-
/**
|
|
59
|
-
* Retrieves balance info of a specified balance_id in the specified project.
|
|
60
|
-
* @param projectId Unique identifier of the project
|
|
61
|
-
* @param balanceId Unique identifier of the balance
|
|
62
|
-
*/
|
|
63
|
-
Billing.prototype.getBalance = function (projectId, balanceId) {
|
|
64
|
-
return __awaiter(this, void 0, void 0, function () {
|
|
65
|
-
return __generator(this, function (_a) {
|
|
66
|
-
return [2 /*return*/, (0, httpRequest_1._request)("GET", this._credentials, this._apiUrl, this.apiPath
|
|
67
|
-
});
|
|
68
|
-
});
|
|
69
|
-
};
|
|
70
|
-
return Billing;
|
|
71
|
-
}());
|
|
72
|
-
exports.Billing = Billing;
|
|
1
|
+
"use strict";
|
|
2
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
3
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
4
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
5
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
6
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
7
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
8
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
9
|
+
});
|
|
10
|
+
};
|
|
11
|
+
var __generator = (this && this.__generator) || function (thisArg, body) {
|
|
12
|
+
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
|
|
13
|
+
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
|
|
14
|
+
function verb(n) { return function (v) { return step([n, v]); }; }
|
|
15
|
+
function step(op) {
|
|
16
|
+
if (f) throw new TypeError("Generator is already executing.");
|
|
17
|
+
while (_) try {
|
|
18
|
+
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
|
|
19
|
+
if (y = 0, t) op = [op[0] & 2, t.value];
|
|
20
|
+
switch (op[0]) {
|
|
21
|
+
case 0: case 1: t = op; break;
|
|
22
|
+
case 4: _.label++; return { value: op[1], done: false };
|
|
23
|
+
case 5: _.label++; y = op[1]; op = [0]; continue;
|
|
24
|
+
case 7: op = _.ops.pop(); _.trys.pop(); continue;
|
|
25
|
+
default:
|
|
26
|
+
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
|
|
27
|
+
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
|
|
28
|
+
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
|
|
29
|
+
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
|
|
30
|
+
if (t[2]) _.ops.pop();
|
|
31
|
+
_.trys.pop(); continue;
|
|
32
|
+
}
|
|
33
|
+
op = body.call(thisArg, _);
|
|
34
|
+
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
|
|
35
|
+
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
|
|
36
|
+
}
|
|
37
|
+
};
|
|
38
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
39
|
+
exports.Billing = void 0;
|
|
40
|
+
var httpRequest_1 = require("./httpRequest");
|
|
41
|
+
var Billing = /** @class */ (function () {
|
|
42
|
+
function Billing(_credentials, _apiUrl) {
|
|
43
|
+
this._credentials = _credentials;
|
|
44
|
+
this._apiUrl = _apiUrl;
|
|
45
|
+
this.apiPath = "/v1/projects";
|
|
46
|
+
}
|
|
47
|
+
/**
|
|
48
|
+
* Retrieves list of balance info of the specified project.
|
|
49
|
+
* @param projectId Unique identifier of the project
|
|
50
|
+
*/
|
|
51
|
+
Billing.prototype.listBalances = function (projectId) {
|
|
52
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
53
|
+
return __generator(this, function (_a) {
|
|
54
|
+
return [2 /*return*/, (0, httpRequest_1._request)("GET", this._credentials, this._apiUrl, "".concat(this.apiPath, "/").concat(projectId, "/balances"))];
|
|
55
|
+
});
|
|
56
|
+
});
|
|
57
|
+
};
|
|
58
|
+
/**
|
|
59
|
+
* Retrieves balance info of a specified balance_id in the specified project.
|
|
60
|
+
* @param projectId Unique identifier of the project
|
|
61
|
+
* @param balanceId Unique identifier of the balance
|
|
62
|
+
*/
|
|
63
|
+
Billing.prototype.getBalance = function (projectId, balanceId) {
|
|
64
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
65
|
+
return __generator(this, function (_a) {
|
|
66
|
+
return [2 /*return*/, (0, httpRequest_1._request)("GET", this._credentials, this._apiUrl, "".concat(this.apiPath, "/").concat(projectId, "/balances/").concat(balanceId))];
|
|
67
|
+
});
|
|
68
|
+
});
|
|
69
|
+
};
|
|
70
|
+
return Billing;
|
|
71
|
+
}());
|
|
72
|
+
exports.Billing = Billing;
|
|
73
73
|
//# sourceMappingURL=billing.js.map
|
package/dist/billing.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"billing.js","sourceRoot":"","sources":["../src/billing.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAAyC;AAGzC;IACE,iBAAoB,YAAoB,EAAU,OAAe;QAA7C,iBAAY,GAAZ,YAAY,CAAQ;QAAU,YAAO,GAAP,OAAO,CAAQ;QAEzD,YAAO,GAAG,cAAc,CAAC;IAFmC,CAAC;IAIrE;;;OAGG;IACG,8BAAY,GAAlB,UAAmB,SAAiB;;;gBAClC,sBAAO,IAAA,sBAAQ,EACb,KAAK,EACL,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,OAAO,
|
|
1
|
+
{"version":3,"file":"billing.js","sourceRoot":"","sources":["../src/billing.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAAyC;AAGzC;IACE,iBAAoB,YAAoB,EAAU,OAAe;QAA7C,iBAAY,GAAZ,YAAY,CAAQ;QAAU,YAAO,GAAP,OAAO,CAAQ;QAEzD,YAAO,GAAG,cAAc,CAAC;IAFmC,CAAC;IAIrE;;;OAGG;IACG,8BAAY,GAAlB,UAAmB,SAAiB;;;gBAClC,sBAAO,IAAA,sBAAQ,EACb,KAAK,EACL,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,OAAO,EACZ,UAAG,IAAI,CAAC,OAAO,cAAI,SAAS,cAAW,CACxC,EAAC;;;KACH;IAED;;;;OAIG;IAEG,4BAAU,GAAhB,UAAiB,SAAiB,EAAE,SAAiB;;;gBACnD,sBAAO,IAAA,sBAAQ,EACb,KAAK,EACL,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,OAAO,EACZ,UAAG,IAAI,CAAC,OAAO,cAAI,SAAS,uBAAa,SAAS,CAAE,CACrD,EAAC;;;KACH;IACH,cAAC;AAAD,CAAC,AAhCD,IAgCC;AAhCY,0BAAO"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Default SDK options
|
|
3
|
-
*/
|
|
4
|
-
export declare const DefaultOptions: {
|
|
5
|
-
apiUrl: string;
|
|
6
|
-
};
|
|
1
|
+
/**
|
|
2
|
+
* Default SDK options
|
|
3
|
+
*/
|
|
4
|
+
export declare const DefaultOptions: {
|
|
5
|
+
apiUrl: string;
|
|
6
|
+
};
|
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.DefaultOptions = void 0;
|
|
4
|
-
/**
|
|
5
|
-
* Default SDK options
|
|
6
|
-
*/
|
|
7
|
-
exports.DefaultOptions = {
|
|
8
|
-
apiUrl: "api.deepgram.com",
|
|
9
|
-
};
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.DefaultOptions = void 0;
|
|
4
|
+
/**
|
|
5
|
+
* Default SDK options
|
|
6
|
+
*/
|
|
7
|
+
exports.DefaultOptions = {
|
|
8
|
+
apiUrl: "api.deepgram.com",
|
|
9
|
+
};
|
|
10
10
|
//# sourceMappingURL=defaultOptions.js.map
|
|
File without changes
|
|
@@ -1 +1 @@
|
|
|
1
|
-
export * from "./defaultOptions";
|
|
1
|
+
export * from "./defaultOptions";
|
package/dist/constants/index.js
CHANGED
|
@@ -1,14 +1,18 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
-
if (k2 === undefined) k2 = k;
|
|
4
|
-
Object.
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
__exportStar(
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./defaultOptions"), exports);
|
|
14
18
|
//# sourceMappingURL=index.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/constants/index.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/constants/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAiC"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export declare const enum Alternatives {
|
|
2
|
-
One = "one-alternative",
|
|
3
|
-
Multiple = "multiple-alternatives"
|
|
4
|
-
}
|
|
1
|
+
export declare const enum Alternatives {
|
|
2
|
+
One = "one-alternative",
|
|
3
|
+
Multiple = "multiple-alternatives"
|
|
4
|
+
}
|
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
//# sourceMappingURL=alternatives.js.map
|
|
File without changes
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
export declare enum ConnectionState {
|
|
2
|
-
CONNECTING = 0,
|
|
3
|
-
OPEN = 1,
|
|
4
|
-
CLOSING = 2,
|
|
5
|
-
CLOSED = 3
|
|
6
|
-
}
|
|
1
|
+
export declare enum ConnectionState {
|
|
2
|
+
CONNECTING = 0,
|
|
3
|
+
OPEN = 1,
|
|
4
|
+
CLOSING = 2,
|
|
5
|
+
CLOSED = 3
|
|
6
|
+
}
|
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.ConnectionState = void 0;
|
|
4
|
-
var ConnectionState;
|
|
5
|
-
(function (ConnectionState) {
|
|
6
|
-
ConnectionState[ConnectionState["CONNECTING"] = 0] = "CONNECTING";
|
|
7
|
-
ConnectionState[ConnectionState["OPEN"] = 1] = "OPEN";
|
|
8
|
-
ConnectionState[ConnectionState["CLOSING"] = 2] = "CLOSING";
|
|
9
|
-
ConnectionState[ConnectionState["CLOSED"] = 3] = "CLOSED";
|
|
10
|
-
})(ConnectionState = exports.ConnectionState || (exports.ConnectionState = {}));
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.ConnectionState = void 0;
|
|
4
|
+
var ConnectionState;
|
|
5
|
+
(function (ConnectionState) {
|
|
6
|
+
ConnectionState[ConnectionState["CONNECTING"] = 0] = "CONNECTING";
|
|
7
|
+
ConnectionState[ConnectionState["OPEN"] = 1] = "OPEN";
|
|
8
|
+
ConnectionState[ConnectionState["CLOSING"] = 2] = "CLOSING";
|
|
9
|
+
ConnectionState[ConnectionState["CLOSED"] = 3] = "CLOSED";
|
|
10
|
+
})(ConnectionState = exports.ConnectionState || (exports.ConnectionState = {}));
|
|
11
11
|
//# sourceMappingURL=connectionState.js.map
|
|
File without changes
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export declare const enum Diarization {
|
|
2
|
-
Diarized = "diarized",
|
|
3
|
-
NonDiarized = "non-diarized"
|
|
4
|
-
}
|
|
1
|
+
export declare const enum Diarization {
|
|
2
|
+
Diarized = "diarized",
|
|
3
|
+
NonDiarized = "non-diarized"
|
|
4
|
+
}
|
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
//# sourceMappingURL=diarization.js.map
|
|
File without changes
|