@deepgram/sdk 1.3.1 → 1.4.2

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.
Files changed (194) hide show
  1. package/CHANGELOG.md +7 -1
  2. package/dist/browser/index.js +1 -0
  3. package/dist/index.d.ts +1315 -24
  4. package/dist/index.js +1 -41
  5. package/package.json +16 -5
  6. package/tsconfig-es6.json +16 -0
  7. package/webpack.config.js +35 -0
  8. package/dist/billing.d.ts +0 -18
  9. package/dist/billing.js +0 -73
  10. package/dist/billing.js.map +0 -1
  11. package/dist/constants/defaultOptions.d.ts +0 -6
  12. package/dist/constants/defaultOptions.js +0 -10
  13. package/dist/constants/defaultOptions.js.map +0 -1
  14. package/dist/constants/index.d.ts +0 -1
  15. package/dist/constants/index.js +0 -18
  16. package/dist/constants/index.js.map +0 -1
  17. package/dist/enums/alternatives.d.ts +0 -4
  18. package/dist/enums/alternatives.js +0 -3
  19. package/dist/enums/alternatives.js.map +0 -1
  20. package/dist/enums/connectionState.d.ts +0 -6
  21. package/dist/enums/connectionState.js +0 -11
  22. package/dist/enums/connectionState.js.map +0 -1
  23. package/dist/enums/diarization.d.ts +0 -4
  24. package/dist/enums/diarization.js +0 -3
  25. package/dist/enums/diarization.js.map +0 -1
  26. package/dist/enums/index.d.ts +0 -7
  27. package/dist/enums/index.js +0 -24
  28. package/dist/enums/index.js.map +0 -1
  29. package/dist/enums/liveTranscriptionEvents.d.ts +0 -6
  30. package/dist/enums/liveTranscriptionEvents.js +0 -3
  31. package/dist/enums/liveTranscriptionEvents.js.map +0 -1
  32. package/dist/enums/models.d.ts +0 -5
  33. package/dist/enums/models.js +0 -3
  34. package/dist/enums/models.js.map +0 -1
  35. package/dist/enums/punctuation.d.ts +0 -4
  36. package/dist/enums/punctuation.js +0 -3
  37. package/dist/enums/punctuation.js.map +0 -1
  38. package/dist/enums/searchKind.d.ts +0 -4
  39. package/dist/enums/searchKind.js +0 -3
  40. package/dist/enums/searchKind.js.map +0 -1
  41. package/dist/helpers/index.d.ts +0 -1
  42. package/dist/helpers/index.js +0 -18
  43. package/dist/helpers/index.js.map +0 -1
  44. package/dist/helpers/secondsToTimestamp.d.ts +0 -1
  45. package/dist/helpers/secondsToTimestamp.js +0 -8
  46. package/dist/helpers/secondsToTimestamp.js.map +0 -1
  47. package/dist/httpRequest.d.ts +0 -3
  48. package/dist/httpRequest.js +0 -91
  49. package/dist/httpRequest.js.map +0 -1
  50. package/dist/index.js.map +0 -1
  51. package/dist/invitation.d.ts +0 -29
  52. package/dist/invitation.js +0 -99
  53. package/dist/invitation.js.map +0 -1
  54. package/dist/keys.d.ts +0 -32
  55. package/dist/keys.js +0 -132
  56. package/dist/keys.js.map +0 -1
  57. package/dist/members.d.ts +0 -18
  58. package/dist/members.js +0 -73
  59. package/dist/members.js.map +0 -1
  60. package/dist/projects.d.ts +0 -21
  61. package/dist/projects.js +0 -82
  62. package/dist/projects.js.map +0 -1
  63. package/dist/scopes.d.ts +0 -20
  64. package/dist/scopes.js +0 -77
  65. package/dist/scopes.js.map +0 -1
  66. package/dist/transcription/index.d.ts +0 -18
  67. package/dist/transcription/index.js +0 -72
  68. package/dist/transcription/index.js.map +0 -1
  69. package/dist/transcription/liveTranscription.d.ts +0 -23
  70. package/dist/transcription/liveTranscription.js +0 -83
  71. package/dist/transcription/liveTranscription.js.map +0 -1
  72. package/dist/transcription/preRecordedTranscription.d.ts +0 -8
  73. package/dist/transcription/preRecordedTranscription.js +0 -114
  74. package/dist/transcription/preRecordedTranscription.js.map +0 -1
  75. package/dist/types/balance.d.ts +0 -6
  76. package/dist/types/balance.js +0 -3
  77. package/dist/types/balance.js.map +0 -1
  78. package/dist/types/balanceList.d.ts +0 -4
  79. package/dist/types/balanceList.js +0 -3
  80. package/dist/types/balanceList.js.map +0 -1
  81. package/dist/types/channel.d.ts +0 -25
  82. package/dist/types/channel.js +0 -3
  83. package/dist/types/channel.js.map +0 -1
  84. package/dist/types/createKeyOptions.d.ts +0 -13
  85. package/dist/types/createKeyOptions.js +0 -3
  86. package/dist/types/createKeyOptions.js.map +0 -1
  87. package/dist/types/hit.d.ts +0 -21
  88. package/dist/types/hit.js +0 -3
  89. package/dist/types/hit.js.map +0 -1
  90. package/dist/types/index.d.ts +0 -35
  91. package/dist/types/index.js +0 -52
  92. package/dist/types/index.js.map +0 -1
  93. package/dist/types/invitationList.d.ts +0 -4
  94. package/dist/types/invitationList.js +0 -3
  95. package/dist/types/invitationList.js.map +0 -1
  96. package/dist/types/invitationOptions.d.ts +0 -4
  97. package/dist/types/invitationOptions.js +0 -3
  98. package/dist/types/invitationOptions.js.map +0 -1
  99. package/dist/types/key.d.ts +0 -25
  100. package/dist/types/key.js +0 -3
  101. package/dist/types/key.js.map +0 -1
  102. package/dist/types/keyResponse.d.ts +0 -50
  103. package/dist/types/keyResponse.js +0 -3
  104. package/dist/types/keyResponse.js.map +0 -1
  105. package/dist/types/keyword.d.ts +0 -4
  106. package/dist/types/keyword.js +0 -3
  107. package/dist/types/keyword.js.map +0 -1
  108. package/dist/types/liveTranscriptionOptions.d.ts +0 -148
  109. package/dist/types/liveTranscriptionOptions.js +0 -3
  110. package/dist/types/liveTranscriptionOptions.js.map +0 -1
  111. package/dist/types/liveTranscriptionResponse.d.ts +0 -9
  112. package/dist/types/liveTranscriptionResponse.js +0 -3
  113. package/dist/types/liveTranscriptionResponse.js.map +0 -1
  114. package/dist/types/member.d.ts +0 -7
  115. package/dist/types/member.js +0 -3
  116. package/dist/types/member.js.map +0 -1
  117. package/dist/types/memberList.d.ts +0 -4
  118. package/dist/types/memberList.js +0 -3
  119. package/dist/types/memberList.js.map +0 -1
  120. package/dist/types/message.d.ts +0 -3
  121. package/dist/types/message.js +0 -3
  122. package/dist/types/message.js.map +0 -1
  123. package/dist/types/metadata.d.ts +0 -8
  124. package/dist/types/metadata.js +0 -3
  125. package/dist/types/metadata.js.map +0 -1
  126. package/dist/types/prerecordedTranscriptionOptions.d.ts +0 -126
  127. package/dist/types/prerecordedTranscriptionOptions.js +0 -3
  128. package/dist/types/prerecordedTranscriptionOptions.js.map +0 -1
  129. package/dist/types/prerecordedTranscriptionResponse.d.ts +0 -25
  130. package/dist/types/prerecordedTranscriptionResponse.js +0 -51
  131. package/dist/types/prerecordedTranscriptionResponse.js.map +0 -1
  132. package/dist/types/project.d.ts +0 -17
  133. package/dist/types/project.js +0 -3
  134. package/dist/types/project.js.map +0 -1
  135. package/dist/types/projectPatchResponse.d.ts +0 -6
  136. package/dist/types/projectPatchResponse.js +0 -3
  137. package/dist/types/projectPatchResponse.js.map +0 -1
  138. package/dist/types/projectResponse.d.ts +0 -4
  139. package/dist/types/projectResponse.js +0 -3
  140. package/dist/types/projectResponse.js.map +0 -1
  141. package/dist/types/scopeList.d.ts +0 -3
  142. package/dist/types/scopeList.js +0 -3
  143. package/dist/types/scopeList.js.map +0 -1
  144. package/dist/types/search.d.ts +0 -14
  145. package/dist/types/search.js +0 -3
  146. package/dist/types/search.js.map +0 -1
  147. package/dist/types/transcriptionSource.d.ts +0 -14
  148. package/dist/types/transcriptionSource.js +0 -3
  149. package/dist/types/transcriptionSource.js.map +0 -1
  150. package/dist/types/usageCallback.d.ts +0 -4
  151. package/dist/types/usageCallback.js +0 -3
  152. package/dist/types/usageCallback.js.map +0 -1
  153. package/dist/types/usageField.d.ts +0 -7
  154. package/dist/types/usageField.js +0 -3
  155. package/dist/types/usageField.js.map +0 -1
  156. package/dist/types/usageFieldOptions.d.ts +0 -4
  157. package/dist/types/usageFieldOptions.js +0 -3
  158. package/dist/types/usageFieldOptions.js.map +0 -1
  159. package/dist/types/usageOptions.d.ts +0 -23
  160. package/dist/types/usageOptions.js +0 -3
  161. package/dist/types/usageOptions.js.map +0 -1
  162. package/dist/types/usageRequest.d.ts +0 -11
  163. package/dist/types/usageRequest.js +0 -3
  164. package/dist/types/usageRequest.js.map +0 -1
  165. package/dist/types/usageRequestDetail.d.ts +0 -30
  166. package/dist/types/usageRequestDetail.js +0 -3
  167. package/dist/types/usageRequestDetail.js.map +0 -1
  168. package/dist/types/usageRequestList.d.ts +0 -6
  169. package/dist/types/usageRequestList.js +0 -3
  170. package/dist/types/usageRequestList.js.map +0 -1
  171. package/dist/types/usageRequestListOptions.d.ts +0 -7
  172. package/dist/types/usageRequestListOptions.js +0 -3
  173. package/dist/types/usageRequestListOptions.js.map +0 -1
  174. package/dist/types/usageRequestMessage.d.ts +0 -3
  175. package/dist/types/usageRequestMessage.js +0 -3
  176. package/dist/types/usageRequestMessage.js.map +0 -1
  177. package/dist/types/usageResponse.d.ts +0 -10
  178. package/dist/types/usageResponse.js +0 -3
  179. package/dist/types/usageResponse.js.map +0 -1
  180. package/dist/types/usageResponseDetail.d.ts +0 -6
  181. package/dist/types/usageResponseDetail.js +0 -3
  182. package/dist/types/usageResponseDetail.js.map +0 -1
  183. package/dist/types/utterance.d.ts +0 -39
  184. package/dist/types/utterance.js +0 -3
  185. package/dist/types/utterance.js.map +0 -1
  186. package/dist/types/wordBase.d.ts +0 -8
  187. package/dist/types/wordBase.js +0 -3
  188. package/dist/types/wordBase.js.map +0 -1
  189. package/dist/usage.d.ts +0 -34
  190. package/dist/usage.js +0 -122
  191. package/dist/usage.js.map +0 -1
  192. package/dist/userAgent.d.ts +0 -1
  193. package/dist/userAgent.js +0 -20
  194. package/dist/userAgent.js.map +0 -1
@@ -1,52 +0,0 @@
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("./balance"), exports);
18
- __exportStar(require("./balanceList"), exports);
19
- __exportStar(require("./channel"), exports);
20
- __exportStar(require("./createKeyOptions"), exports);
21
- __exportStar(require("./hit"), exports);
22
- __exportStar(require("./invitationList"), exports);
23
- __exportStar(require("./invitationOptions"), exports);
24
- __exportStar(require("./key"), exports);
25
- __exportStar(require("./keyResponse"), exports);
26
- __exportStar(require("./liveTranscriptionOptions"), exports);
27
- __exportStar(require("./liveTranscriptionResponse"), exports);
28
- __exportStar(require("./member"), exports);
29
- __exportStar(require("./memberList"), exports);
30
- __exportStar(require("./message"), exports);
31
- __exportStar(require("./metadata"), exports);
32
- __exportStar(require("./prerecordedTranscriptionOptions"), exports);
33
- __exportStar(require("./prerecordedTranscriptionResponse"), exports);
34
- __exportStar(require("./project"), exports);
35
- __exportStar(require("./projectPatchResponse"), exports);
36
- __exportStar(require("./projectResponse"), exports);
37
- __exportStar(require("./scopeList"), exports);
38
- __exportStar(require("./search"), exports);
39
- __exportStar(require("./transcriptionSource"), exports);
40
- __exportStar(require("./usageCallback"), exports);
41
- __exportStar(require("./usageField"), exports);
42
- __exportStar(require("./usageFieldOptions"), exports);
43
- __exportStar(require("./usageOptions"), exports);
44
- __exportStar(require("./usageRequest"), exports);
45
- __exportStar(require("./usageRequestDetail"), exports);
46
- __exportStar(require("./usageRequestList"), exports);
47
- __exportStar(require("./usageRequestListOptions"), exports);
48
- __exportStar(require("./usageResponse"), exports);
49
- __exportStar(require("./usageResponseDetail"), exports);
50
- __exportStar(require("./utterance"), exports);
51
- __exportStar(require("./wordBase"), exports);
52
- //# sourceMappingURL=index.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAA0B;AAC1B,gDAA8B;AAC9B,4CAA0B;AAC1B,qDAAmC;AACnC,wCAAsB;AACtB,mDAAiC;AACjC,sDAAoC;AACpC,wCAAsB;AACtB,gDAA8B;AAC9B,6DAA2C;AAC3C,8DAA4C;AAC5C,2CAAyB;AACzB,+CAA6B;AAC7B,4CAA0B;AAC1B,6CAA2B;AAC3B,oEAAkD;AAClD,qEAAmD;AACnD,4CAA0B;AAC1B,yDAAuC;AACvC,oDAAkC;AAClC,8CAA4B;AAC5B,2CAAyB;AACzB,wDAAsC;AACtC,kDAAgC;AAChC,+CAA6B;AAC7B,sDAAoC;AACpC,iDAA+B;AAC/B,iDAA+B;AAC/B,uDAAqC;AACrC,qDAAmC;AACnC,4DAA0C;AAC1C,kDAAgC;AAChC,wDAAsC;AACtC,8CAA4B;AAC5B,6CAA2B"}
@@ -1,4 +0,0 @@
1
- import { InvitationOptions } from "./invitationOptions";
2
- export declare type InvitationList = {
3
- invites?: Array<InvitationOptions>;
4
- };
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=invitationList.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"invitationList.js","sourceRoot":"","sources":["../../src/types/invitationList.ts"],"names":[],"mappings":""}
@@ -1,4 +0,0 @@
1
- export declare type InvitationOptions = {
2
- email?: string;
3
- scope?: string;
4
- };
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=invitationOptions.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"invitationOptions.js","sourceRoot":"","sources":["../../src/types/invitationOptions.ts"],"names":[],"mappings":""}
@@ -1,25 +0,0 @@
1
- /**
2
- * API key used for authenticating with the Deepgram API
3
- */
4
- export declare type Key = {
5
- /**
6
- * Unique identifier of the key to use in API requests
7
- */
8
- api_key_id: string;
9
- /**
10
- * API key to send in API requests (Only displayed when first created)
11
- */
12
- key?: string;
13
- /**
14
- * Comment for user reference
15
- */
16
- comment: string;
17
- /**
18
- * Timestamp of the date/time the key was created
19
- */
20
- created: string;
21
- /**
22
- * Array of scopes assigned to the key
23
- */
24
- scopes: Array<string>;
25
- };
package/dist/types/key.js DELETED
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=key.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"key.js","sourceRoot":"","sources":["../../src/types/key.ts"],"names":[],"mappings":""}
@@ -1,50 +0,0 @@
1
- import { Key } from "./key";
2
- import { Member } from "./member";
3
- /**
4
- * Response from the Deepgram API to list keys
5
- */
6
- export declare type KeyResponse = {
7
- /**
8
- * Array of API keys associated with the project
9
- */
10
- api_keys: Array<{
11
- /**
12
- * Optional member associated with the API key
13
- */
14
- member?: Member;
15
- /**
16
- * API key
17
- */
18
- api_key: Key;
19
- /**
20
- * Unique identifier of the key to use in API requests
21
- * @deprecated This property has moved to api_key.api_key_id and will
22
- * be removed in future versions.
23
- */
24
- api_key_id: string;
25
- /**
26
- * API key to send in API requests (Only displayed when first created)
27
- * @deprecated This property has moved to api_key.key and will
28
- * be removed in future versions.
29
- */
30
- key?: string;
31
- /**
32
- * Comment for user reference
33
- * @deprecated This property has moved to api_key.comment and will
34
- * be removed in future versions.
35
- */
36
- comment: string;
37
- /**
38
- * Timestamp of the date/time the key was created
39
- * @deprecated This property has moved to api_key.created and will
40
- * be removed in future versions.
41
- */
42
- created: string;
43
- /**
44
- * Array of scopes assigned to the key
45
- * @deprecated This property has moved to api_key.scopes and will
46
- * be removed in future versions.
47
- */
48
- scopes: Array<string>;
49
- }>;
50
- };
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=keyResponse.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"keyResponse.js","sourceRoot":"","sources":["../../src/types/keyResponse.ts"],"names":[],"mappings":""}
@@ -1,4 +0,0 @@
1
- export declare type Keyword = {
2
- keyword: string;
3
- boost?: number;
4
- };
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=keyword.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"keyword.js","sourceRoot":"","sources":["../../src/types/keyword.ts"],"names":[],"mappings":""}
@@ -1,148 +0,0 @@
1
- import { Models } from "../enums";
2
- /**
3
- * Options for transcription
4
- */
5
- export declare type LiveTranscriptionOptions = {
6
- /**
7
- * AI model used to process submitted audio.
8
- * @default general
9
- * @remarks Possible values are general, phonecall, meeting or a custom string
10
- * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeAudio/properties/model
11
- */
12
- model?: Models | string;
13
- /**
14
- * Version of the model to use.
15
- * @default latest
16
- * @remarks latest OR <version_id>
17
- * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeAudio/properties/version
18
- */
19
- version?: string;
20
- /**
21
- * BCP-47 language tag that hints at the primary spoken language.
22
- * @default en-US
23
- * @remarks Possible values are en-GB, en-IN, en-NZ, en-US, es, fr, ko, pt,
24
- * pt-BR, ru, tr or null
25
- * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeAudio/properties/language
26
- */
27
- language?: string;
28
- /**
29
- * Indicates whether to add punctuation and capitalization to the transcript.
30
- * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeAudio/properties/punctuate
31
- */
32
- punctuate?: boolean;
33
- /**
34
- * Indicates whether to remove profanity from the transcript.
35
- * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeAudio/properties/profanity_filter
36
- */
37
- profanity_filter?: boolean;
38
- /**
39
- * Indicates whether to redact sensitive information, replacing redacted content with asterisks (*).
40
- * @remarks Options include:
41
- * `pci`: Redacts sensitive credit card information, including credit card number, expiration date, and CVV
42
- * `numbers` (or `true)`: Aggressively redacts strings of numerals
43
- * `ssn` (*beta*): Redacts social security numbers
44
- * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeAudio/properties/redact
45
- */
46
- redact?: Array<string>;
47
- /**
48
- * Indicates whether to recognize speaker changes. When set to true, each word
49
- * in the transcript will be assigned a speaker number starting at 0.
50
- * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeAudio/properties/diarize
51
- */
52
- diarize?: boolean;
53
- /**
54
- * Indicates whether to transcribe each audio channel independently. When set
55
- * to true, you will receive one transcript for each channel, which means you
56
- * can apply a different model to each channel using the model parameter (e.g.,
57
- * set model to general:phonecall, which applies the general model to channel
58
- * 0 and the phonecall model to channel 1).
59
- * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeAudio/properties/multichannel
60
- */
61
- multichannel?: boolean;
62
- /**
63
- * Maximum number of transcript alternatives to return. Just like a human listener,
64
- * Deepgram can provide multiple possible interpretations of what it hears.
65
- * @default 1
66
- */
67
- alternatives?: number;
68
- /**
69
- * Indicates whether to convert numbers from written format (e.g., one) to
70
- * numerical format (e.g., 1). Deepgram can format numbers up to 999,999.
71
- * @remarks Converted numbers do not include punctuation. For example,
72
- * 999,999 would be transcribed as 999999.
73
- * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeAudio/properties/numerals
74
- */
75
- numerals?: boolean;
76
- /**
77
- * Terms or phrases to search for in the submitted audio. Deepgram searches
78
- * for acoustic patterns in audio rather than text patterns in transcripts
79
- * because we have noticed that acoustic pattern matching is more performant.
80
- * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeAudio/properties/search
81
- */
82
- search?: Array<string>;
83
- /**
84
- * Callback URL to provide if you would like your submitted audio to be
85
- * processed asynchronously. When passed, Deepgram will immediately respond
86
- * with a request_id. When it has finished analyzing the audio, it will send
87
- * a POST request to the provided URL with an appropriate HTTP status code.
88
- * @remarks You may embed basic authentication credentials in the callback URL.
89
- * Only ports 80, 443, 8080, and 8443 can be used for callbacks.
90
- * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeAudio/properties/callback
91
- */
92
- callback?: string;
93
- /**
94
- * Keywords to which the model should pay particular attention to boosting
95
- * or suppressing to help it understand context. Just like a human listener,
96
- * Deepgram can better understand mumbled, distorted, or otherwise
97
- * hard-to-decipher speech when it knows the context of the conversation.
98
- * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeAudio/properties/keywords
99
- */
100
- keywords?: Array<string>;
101
- /**
102
- * Indicates whether the streaming endpoint should send you updates to its
103
- * transcription as more audio becomes available. By default, the streaming
104
- * endpoint returns regular updates, which means transcription results will
105
- * likely change for a period of time. You can avoid receiving these updates
106
- * by setting this flag to false.
107
- * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeStreamingAudio/properties/interim_results
108
- */
109
- interim_results?: boolean;
110
- /**
111
- * Indicates whether Deepgram will detect whether a speaker has finished
112
- * speaking (or paused for a significant period of time, indicating the
113
- * completion of an idea). When Deepgram detects an endpoint, it assumes
114
- * that no additional data will improve its prediction, so it immediately
115
- * finalizes the result for the processed time range and returns the
116
- * transcript with a speech_final parameter set to true.
117
- * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeStreamingAudio/properties/endpointing
118
- */
119
- endpointing?: boolean;
120
- /**
121
- * Length of time in milliseconds of silence that voice activation detection
122
- * (VAD) will use to detect that a speaker has finished speaking. Used when
123
- * endpointing is enabled. Defaults to 10 ms. Deepgram customers may configure
124
- * a value between 10 ms and 500 ms; on-premise customers may remove this
125
- * restriction.
126
- * @default 10
127
- * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeStreamingAudio/properties/vad_turnoff
128
- */
129
- vad_turnoff?: number;
130
- /**
131
- * Expected encoding of the submitted streaming audio.
132
- * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeStreamingAudio/properties/encoding
133
- */
134
- encoding?: string;
135
- /**
136
- * Number of independent audio channels contained in submitted streaming
137
- * audio. Only read when a value is provided for encoding.
138
- * @default 1
139
- * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeStreamingAudio/properties/channels
140
- */
141
- channels?: number;
142
- /**
143
- * Sample rate of submitted streaming audio. Required (and only read)
144
- * when a value is provided for encoding.
145
- * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeStreamingAudio/properties/sample_rate
146
- */
147
- sample_rate?: number;
148
- };
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=liveTranscriptionOptions.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"liveTranscriptionOptions.js","sourceRoot":"","sources":["../../src/types/liveTranscriptionOptions.ts"],"names":[],"mappings":""}
@@ -1,9 +0,0 @@
1
- import { Channel } from "./channel";
2
- export declare type LiveTranscriptionResponse = {
3
- channel_index: Array<number>;
4
- duration: number;
5
- start: number;
6
- is_final: boolean;
7
- speech_final: boolean;
8
- channel: Channel;
9
- };
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=liveTranscriptionResponse.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"liveTranscriptionResponse.js","sourceRoot":"","sources":["../../src/types/liveTranscriptionResponse.ts"],"names":[],"mappings":""}
@@ -1,7 +0,0 @@
1
- export declare type Member = {
2
- member_id: string;
3
- first_name?: string;
4
- last_name?: string;
5
- scopes?: Array<string>;
6
- email: string;
7
- };
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=member.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"member.js","sourceRoot":"","sources":["../../src/types/member.ts"],"names":[],"mappings":""}
@@ -1,4 +0,0 @@
1
- import { Member } from "./member";
2
- export declare type MemberList = {
3
- members?: Array<Member>;
4
- };
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=memberList.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"memberList.js","sourceRoot":"","sources":["../../src/types/memberList.ts"],"names":[],"mappings":""}
@@ -1,3 +0,0 @@
1
- export declare type Message = {
2
- message?: string;
3
- };
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=message.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"message.js","sourceRoot":"","sources":["../../src/types/message.ts"],"names":[],"mappings":""}
@@ -1,8 +0,0 @@
1
- export declare type Metadata = {
2
- request_id: string;
3
- transaction_key: string;
4
- sha256: string;
5
- created: string;
6
- duration: number;
7
- channels: number;
8
- };
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=metadata.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"metadata.js","sourceRoot":"","sources":["../../src/types/metadata.ts"],"names":[],"mappings":""}
@@ -1,126 +0,0 @@
1
- import { Models } from "../enums";
2
- /**
3
- * Options for transcription
4
- */
5
- export declare type PrerecordedTranscriptionOptions = {
6
- /**
7
- * AI model used to process submitted audio.
8
- * @default general
9
- * @remarks Possible values are general, phonecall, meeting or a custom string
10
- * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeAudio/properties/model
11
- */
12
- model?: Models | string;
13
- /**
14
- * Version of the model to use.
15
- * @default latest
16
- * @remarks latest OR <version_id>
17
- * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeAudio/properties/version
18
- */
19
- version?: string;
20
- /**
21
- * BCP-47 language tag that hints at the primary spoken language.
22
- * @default en-US
23
- * @remarks Possible values are en-GB, en-IN, en-NZ, en-US, es, fr, ko, pt,
24
- * pt-BR, ru, tr or null
25
- * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeAudio/properties/language
26
- */
27
- language?: string;
28
- /**
29
- * Indicates whether to add punctuation and capitalization to the transcript.
30
- * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeAudio/properties/punctuate
31
- */
32
- punctuate?: boolean;
33
- /**
34
- * Indicates whether to remove profanity from the transcript.
35
- * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeAudio/properties/profanity_filter
36
- */
37
- profanity_filter?: boolean;
38
- /**
39
- * Indicates whether to redact sensitive information, replacing redacted content with asterisks (*).
40
- * @remarks Options include:
41
- * `pci`: Redacts sensitive credit card information, including credit card number, expiration date, and CVV
42
- * `numbers` (or `true)`: Aggressively redacts strings of numerals
43
- * `ssn` (*beta*): Redacts social security numbers
44
- * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeAudio/properties/redact
45
- */
46
- redact?: Array<string>;
47
- /**
48
- * Indicates whether to recognize speaker changes. When set to true, each word
49
- * in the transcript will be assigned a speaker number starting at 0.
50
- * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeAudio/properties/diarize
51
- */
52
- diarize?: boolean;
53
- /**
54
- * Indicates whether to transcribe each audio channel independently. When set
55
- * to true, you will receive one transcript for each channel, which means you
56
- * can apply a different model to each channel using the model parameter (e.g.,
57
- * set model to general:phonecall, which applies the general model to channel
58
- * 0 and the phonecall model to channel 1).
59
- * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeAudio/properties/multichannel
60
- */
61
- multichannel?: boolean;
62
- /**
63
- * Maximum number of transcript alternatives to return. Just like a human listener,
64
- * Deepgram can provide multiple possible interpretations of what it hears.
65
- * @default 1
66
- */
67
- alternatives?: number;
68
- /**
69
- * Indicates whether to convert numbers from written format (e.g., one) to
70
- * numerical format (e.g., 1). Deepgram can format numbers up to 999,999.
71
- * @remarks Converted numbers do not include punctuation. For example,
72
- * 999,999 would be transcribed as 999999.
73
- * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeAudio/properties/numerals
74
- */
75
- numerals?: boolean;
76
- /**
77
- * Terms or phrases to search for in the submitted audio. Deepgram searches
78
- * for acoustic patterns in audio rather than text patterns in transcripts
79
- * because we have noticed that acoustic pattern matching is more performant.
80
- * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeAudio/properties/search
81
- */
82
- search?: Array<string>;
83
- /**
84
- * Callback URL to provide if you would like your submitted audio to be
85
- * processed asynchronously. When passed, Deepgram will immediately respond
86
- * with a request_id. When it has finished analyzing the audio, it will send
87
- * a POST request to the provided URL with an appropriate HTTP status code.
88
- * @remarks You may embed basic authentication credentials in the callback URL.
89
- * Only ports 80, 443, 8080, and 8443 can be used for callbacks.
90
- * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeAudio/properties/callback
91
- */
92
- callback?: string;
93
- /**
94
- * Keywords to which the model should pay particular attention to boosting
95
- * or suppressing to help it understand context. Just like a human listener,
96
- * Deepgram can better understand mumbled, distorted, or otherwise
97
- * hard-to-decipher speech when it knows the context of the conversation.
98
- * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeAudio/properties/keywords
99
- */
100
- keywords?: Array<string>;
101
- /**
102
- * Indicates whether Deepgram will segment speech into meaningful semantic
103
- * units, which allows the model to interact more naturally and effectively
104
- * with speakers' spontaneous speech patterns. For example, when humans
105
- * speak to each other conversationally, they often pause mid-sentence to
106
- * reformulate their thoughts, or stop and restart a badly-worded sentence.
107
- * When utterances is set to true, these utterances are identified and
108
- * returned in the transcript results.
109
- *
110
- * By default, when utterances is enabled, it starts a new utterance after
111
- * 0.8 s of silence. You can customize the length of time used to determine
112
- * where to split utterances by submitting the utt_split parameter.
113
- * @remarks **BETA FEATURE**
114
- * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeAudio/properties/utterances
115
- */
116
- utterances?: boolean;
117
- /**
118
- * Length of time in seconds of silence between words that Deepgram will
119
- * use when determining where to split utterances. Used when utterances
120
- * is enabled.
121
- * @default 0.8 seconds
122
- * @remarks **BETA FEATURE**
123
- * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeAudio/properties/utt_split
124
- */
125
- utt_split?: number;
126
- };
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=prerecordedTranscriptionOptions.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"prerecordedTranscriptionOptions.js","sourceRoot":"","sources":["../../src/types/prerecordedTranscriptionOptions.ts"],"names":[],"mappings":""}
@@ -1,25 +0,0 @@
1
- import { Metadata } from "./metadata";
2
- import { Channel } from "./channel";
3
- import { Utterance } from "./utterance";
4
- export declare class PrerecordedTranscriptionResponse {
5
- request_id?: string;
6
- metadata?: Metadata;
7
- results?: {
8
- channels: Array<Channel>;
9
- utterances?: Array<Utterance>;
10
- };
11
- /**
12
- * Converts the transcription to the WebVTT format
13
- * @remarks In order to translate the transcription to WebVTT, the utterances
14
- * feature must be used.
15
- * @returns A string with the transcription in the WebVTT format
16
- */
17
- toWebVTT(): string;
18
- /**
19
- * Converts the transcription to the SRT format
20
- * @remarks In order to translate the transcription to SRT, the utterances
21
- * feature must be used.
22
- * @returns A string with the transcription in the SRT format
23
- */
24
- toSRT(): string;
25
- }