@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,51 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.PrerecordedTranscriptionResponse = void 0;
4
- var helpers_1 = require("../helpers");
5
- var PrerecordedTranscriptionResponse = /** @class */ (function () {
6
- function PrerecordedTranscriptionResponse() {
7
- }
8
- /**
9
- * Converts the transcription to the WebVTT format
10
- * @remarks In order to translate the transcription to WebVTT, the utterances
11
- * feature must be used.
12
- * @returns A string with the transcription in the WebVTT format
13
- */
14
- PrerecordedTranscriptionResponse.prototype.toWebVTT = function () {
15
- var _a, _b, _c, _d;
16
- if (!this.results || !this.results.utterances) {
17
- throw new Error("This function requires a transcript that was generated with the utterances feature.");
18
- }
19
- var webVTT = "WEBVTT\n\n";
20
- webVTT += "NOTE\nTranscription provided by Deepgram\nRequest Id: ".concat((_a = this.metadata) === null || _a === void 0 ? void 0 : _a.request_id, "\nCreated: ").concat((_b = this.metadata) === null || _b === void 0 ? void 0 : _b.created, "\nDuration: ").concat((_c = this.metadata) === null || _c === void 0 ? void 0 : _c.duration, "\nChannels: ").concat((_d = this.metadata) === null || _d === void 0 ? void 0 : _d.channels, "\n\n");
21
- for (var i = 0; i < this.results.utterances.length; i++) {
22
- var utterance = this.results.utterances[i];
23
- var start = (0, helpers_1.secondsToTimestamp)(utterance.start);
24
- var end = (0, helpers_1.secondsToTimestamp)(utterance.end);
25
- webVTT += "".concat(i + 1, "\n").concat(start, " --> ").concat(end, "\n- ").concat(utterance.transcript, "\n\n");
26
- }
27
- return webVTT;
28
- };
29
- /**
30
- * Converts the transcription to the SRT format
31
- * @remarks In order to translate the transcription to SRT, the utterances
32
- * feature must be used.
33
- * @returns A string with the transcription in the SRT format
34
- */
35
- PrerecordedTranscriptionResponse.prototype.toSRT = function () {
36
- if (!this.results || !this.results.utterances) {
37
- throw new Error("This function requires a transcript that was generated with the utterances feature.");
38
- }
39
- var srt = "";
40
- for (var i = 0; i < this.results.utterances.length; i++) {
41
- var utterance = this.results.utterances[i];
42
- var start = (0, helpers_1.secondsToTimestamp)(utterance.start).replace(".", ",");
43
- var end = (0, helpers_1.secondsToTimestamp)(utterance.end).replace(".", ",");
44
- srt += "".concat(i + 1, "\n").concat(start, " --> ").concat(end, "\n").concat(utterance.transcript, "\n\n");
45
- }
46
- return srt;
47
- };
48
- return PrerecordedTranscriptionResponse;
49
- }());
50
- exports.PrerecordedTranscriptionResponse = PrerecordedTranscriptionResponse;
51
- //# sourceMappingURL=prerecordedTranscriptionResponse.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"prerecordedTranscriptionResponse.js","sourceRoot":"","sources":["../../src/types/prerecordedTranscriptionResponse.ts"],"names":[],"mappings":";;;AAGA,sCAAgD;AAEhD;IAAA;IA2DA,CAAC;IAnDC;;;;;OAKG;IACI,mDAAQ,GAAf;;QACE,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE;YAC7C,MAAM,IAAI,KAAK,CACb,qFAAqF,CACtF,CAAC;SACH;QAED,IAAI,MAAM,GAAG,YAAY,CAAC;QAE1B,MAAM,IAAI,gEAAyD,MAAA,IAAI,CAAC,QAAQ,0CAAE,UAAU,wBAAc,MAAA,IAAI,CAAC,QAAQ,0CAAE,OAAO,yBAAe,MAAA,IAAI,CAAC,QAAQ,0CAAE,QAAQ,yBAAe,MAAA,IAAI,CAAC,QAAQ,0CAAE,QAAQ,SAAM,CAAC;QAEnN,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YACvD,IAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;YAC7C,IAAM,KAAK,GAAG,IAAA,4BAAkB,EAAC,SAAS,CAAC,KAAK,CAAC,CAAC;YAClD,IAAM,GAAG,GAAG,IAAA,4BAAkB,EAAC,SAAS,CAAC,GAAG,CAAC,CAAC;YAC9C,MAAM,IAAI,UAAG,CAAC,GAAG,CAAC,eAAK,KAAK,kBAAQ,GAAG,iBAAO,SAAS,CAAC,UAAU,SAAM,CAAC;SAC1E;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;OAKG;IACI,gDAAK,GAAZ;QACE,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE;YAC7C,MAAM,IAAI,KAAK,CACb,qFAAqF,CACtF,CAAC;SACH;QAED,IAAI,GAAG,GAAG,EAAE,CAAC;QAEb,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YACvD,IAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;YAC7C,IAAM,KAAK,GAAG,IAAA,4BAAkB,EAAC,SAAS,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;YACpE,IAAM,GAAG,GAAG,IAAA,4BAAkB,EAAC,SAAS,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;YAChE,GAAG,IAAI,UAAG,CAAC,GAAG,CAAC,eAAK,KAAK,kBAAQ,GAAG,eAAK,SAAS,CAAC,UAAU,SAAM,CAAC;SACrE;QAED,OAAO,GAAG,CAAC;IACb,CAAC;IACH,uCAAC;AAAD,CAAC,AA3DD,IA2DC;AA3DY,4EAAgC"}
@@ -1,17 +0,0 @@
1
- /**
2
- * Deepgram project
3
- */
4
- export declare type Project = {
5
- /**
6
- * Unique identifier of the project
7
- */
8
- project_id: string;
9
- /**
10
- * User provided name of the project
11
- */
12
- name?: string;
13
- /**
14
- * Name of the company associated with the project. Optional.
15
- */
16
- company?: string;
17
- };
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=project.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"project.js","sourceRoot":"","sources":["../../src/types/project.ts"],"names":[],"mappings":""}
@@ -1,6 +0,0 @@
1
- export declare type ProjectPatchResponse = {
2
- /**
3
- * Success message.
4
- */
5
- message: string;
6
- };
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=projectPatchResponse.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"projectPatchResponse.js","sourceRoot":"","sources":["../../src/types/projectPatchResponse.ts"],"names":[],"mappings":""}
@@ -1,4 +0,0 @@
1
- import { Project } from "./project";
2
- export declare type ProjectResponse = {
3
- projects: Array<Project>;
4
- };
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=projectResponse.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"projectResponse.js","sourceRoot":"","sources":["../../src/types/projectResponse.ts"],"names":[],"mappings":""}
@@ -1,3 +0,0 @@
1
- export declare type ScopeList = {
2
- scopes: Array<string>;
3
- };
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=scopeList.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"scopeList.js","sourceRoot":"","sources":["../../src/types/scopeList.ts"],"names":[],"mappings":""}
@@ -1,14 +0,0 @@
1
- import { Hit } from "./hit";
2
- /**
3
- * Search result for a transcription
4
- */
5
- export declare type Search = {
6
- /**
7
- * Term for which Deepgram is searching.
8
- */
9
- query: string;
10
- /**
11
- * Instances of query found in transcript
12
- */
13
- hits: Array<Hit>;
14
- };
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=search.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"search.js","sourceRoot":"","sources":["../../src/types/search.ts"],"names":[],"mappings":""}
@@ -1,14 +0,0 @@
1
- /// <reference types="node" />
2
- import { ReadStream } from "fs";
3
- export declare type TranscriptionSource = UrlSource | BufferSource | ReadStreamSource;
4
- export declare type ReadStreamSource = {
5
- stream: ReadStream;
6
- mimetype: string;
7
- };
8
- export declare type UrlSource = {
9
- url: string;
10
- };
11
- export declare type BufferSource = {
12
- buffer: Buffer;
13
- mimetype: string;
14
- };
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=transcriptionSource.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"transcriptionSource.js","sourceRoot":"","sources":["../../src/types/transcriptionSource.ts"],"names":[],"mappings":""}
@@ -1,4 +0,0 @@
1
- export declare type UsageCallback = {
2
- code: number;
3
- completed: string;
4
- };
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=usageCallback.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"usageCallback.js","sourceRoot":"","sources":["../../src/types/usageCallback.ts"],"names":[],"mappings":""}
@@ -1,7 +0,0 @@
1
- export declare type UsageField = {
2
- tags: Array<string>;
3
- models: Array<string>;
4
- processing_methods: Array<string>;
5
- languages: Array<string>;
6
- features: Array<string>;
7
- };
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=usageField.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"usageField.js","sourceRoot":"","sources":["../../src/types/usageField.ts"],"names":[],"mappings":""}
@@ -1,4 +0,0 @@
1
- export declare type UsageFieldOptions = {
2
- start?: string;
3
- end?: string;
4
- };
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=usageFieldOptions.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"usageFieldOptions.js","sourceRoot":"","sources":["../../src/types/usageFieldOptions.ts"],"names":[],"mappings":""}
@@ -1,23 +0,0 @@
1
- export declare type UsageOptions = {
2
- start?: string;
3
- end?: string;
4
- accessor?: string;
5
- tag?: Array<string>;
6
- method?: "sync" | "async" | "streaming";
7
- model?: string;
8
- multichannel?: boolean;
9
- interim_results?: boolean;
10
- punctuate?: boolean;
11
- ner?: boolean;
12
- utterances?: boolean;
13
- replace?: boolean;
14
- profanity_filter?: boolean;
15
- keywords?: boolean;
16
- sentiment?: boolean;
17
- diarize?: boolean;
18
- detect_language?: boolean;
19
- search?: boolean;
20
- redact?: boolean;
21
- alternatives?: boolean;
22
- numerals?: boolean;
23
- };
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=usageOptions.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"usageOptions.js","sourceRoot":"","sources":["../../src/types/usageOptions.ts"],"names":[],"mappings":""}
@@ -1,11 +0,0 @@
1
- import { UsageCallback } from "./usageCallback";
2
- import { UsageRequestDetail } from "./usageRequestDetail";
3
- import { UsageRequestMessage } from "./usageRequestMessage";
4
- export declare type UsageRequest = {
5
- request_id: string;
6
- created: string;
7
- path: string;
8
- accessor: string;
9
- response?: UsageRequestDetail | UsageRequestMessage;
10
- callback?: UsageCallback;
11
- };
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=usageRequest.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"usageRequest.js","sourceRoot":"","sources":["../../src/types/usageRequest.ts"],"names":[],"mappings":""}
@@ -1,30 +0,0 @@
1
- export declare type UsageRequestDetail = {
2
- details: {
3
- usd: number;
4
- duration: number;
5
- total_audio: number;
6
- channels: number;
7
- streams: number;
8
- model: string;
9
- method: "sync" | "async" | "streaming";
10
- tags: Array<string>;
11
- features: Array<string>;
12
- config: {
13
- multichannel?: boolean;
14
- interim_results?: boolean;
15
- punctuate?: boolean;
16
- ner?: boolean;
17
- utterances?: boolean;
18
- replace?: boolean;
19
- profanity_filter?: boolean;
20
- keywords?: boolean;
21
- sentiment?: boolean;
22
- diarize?: boolean;
23
- detect_language?: boolean;
24
- search?: boolean;
25
- redact?: boolean;
26
- alternatives?: boolean;
27
- numerals?: boolean;
28
- };
29
- };
30
- };
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=usageRequestDetail.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"usageRequestDetail.js","sourceRoot":"","sources":["../../src/types/usageRequestDetail.ts"],"names":[],"mappings":""}
@@ -1,6 +0,0 @@
1
- import { UsageRequest } from "./usageRequest";
2
- export declare type UsageRequestList = {
3
- page: number;
4
- limit: number;
5
- requests?: Array<UsageRequest>;
6
- };
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=usageRequestList.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"usageRequestList.js","sourceRoot":"","sources":["../../src/types/usageRequestList.ts"],"names":[],"mappings":""}
@@ -1,7 +0,0 @@
1
- export declare type UsageRequestListOptions = {
2
- start?: string;
3
- end?: string;
4
- page?: number;
5
- limit?: number;
6
- status?: "succeeded" | "failed";
7
- };
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=usageRequestListOptions.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"usageRequestListOptions.js","sourceRoot":"","sources":["../../src/types/usageRequestListOptions.ts"],"names":[],"mappings":""}
@@ -1,3 +0,0 @@
1
- export declare type UsageRequestMessage = {
2
- message?: string;
3
- };
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=usageRequestMessage.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"usageRequestMessage.js","sourceRoot":"","sources":["../../src/types/usageRequestMessage.ts"],"names":[],"mappings":""}
@@ -1,10 +0,0 @@
1
- import { UsageResponseDetail } from "./usageResponseDetail";
2
- export declare type UsageResponse = {
3
- start: string;
4
- end: string;
5
- resolution: {
6
- units: string;
7
- amount: number;
8
- };
9
- results: Array<UsageResponseDetail>;
10
- };
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=usageResponse.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"usageResponse.js","sourceRoot":"","sources":["../../src/types/usageResponse.ts"],"names":[],"mappings":""}
@@ -1,6 +0,0 @@
1
- export declare type UsageResponseDetail = {
2
- start: string;
3
- end: string;
4
- hours: number;
5
- requests: number;
6
- };
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=usageResponseDetail.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"usageResponseDetail.js","sourceRoot":"","sources":["../../src/types/usageResponseDetail.ts"],"names":[],"mappings":""}
@@ -1,39 +0,0 @@
1
- import { WordBase } from "./wordBase";
2
- export declare type Utterance = {
3
- /**
4
- * Start time (in seconds) from the beginning of the audio stream.
5
- */
6
- start: number;
7
- /**
8
- * End time (in seconds) from the beginning of the audio stream.
9
- */
10
- end: number;
11
- /**
12
- * Floating point value between 0 and 1 that indicates overall transcript
13
- * reliability. Larger values indicate higher confidence.
14
- */
15
- confidence: number;
16
- /**
17
- * Audio channel to which the utterance belongs. When using multichannel audio,
18
- * utterances are chronologically ordered by channel.
19
- */
20
- channel: number;
21
- /**
22
- * Transcript for the audio segment being processed.
23
- */
24
- transcript: string;
25
- /**
26
- * Object containing each word in the transcript, along with its start time
27
- * and end time (in seconds) from the beginning of the audio stream, and a confidence value.
28
- */
29
- words: Array<WordBase>;
30
- /**
31
- * Integer indicating the predicted speaker of the majority of words
32
- * in the utterance who is saying the words being processed.
33
- */
34
- speaker?: number;
35
- /**
36
- * Unique identifier of the utterance
37
- */
38
- id: string;
39
- };
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=utterance.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"utterance.js","sourceRoot":"","sources":["../../src/types/utterance.ts"],"names":[],"mappings":""}
@@ -1,8 +0,0 @@
1
- export declare type WordBase = {
2
- word: string;
3
- start: number;
4
- end: number;
5
- confidence: number;
6
- punctuated_word?: string;
7
- speaker?: number;
8
- };
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=wordBase.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"wordBase.js","sourceRoot":"","sources":["../../src/types/wordBase.ts"],"names":[],"mappings":""}
package/dist/usage.d.ts DELETED
@@ -1,34 +0,0 @@
1
- import { UsageField, UsageFieldOptions, UsageOptions, UsageRequest, UsageRequestList, UsageRequestListOptions, UsageResponse } from "./types";
2
- export declare class Usage {
3
- private _credentials;
4
- private _apiUrl;
5
- constructor(_credentials: string, _apiUrl: string);
6
- private apiPath;
7
- /**
8
- * Retrieves all requests associated with the provided projectId based
9
- * on the provided options
10
- * @param projectId Unique identifier of the project
11
- * @param options Additional filter options
12
- */
13
- listRequests(projectId: string, options?: UsageRequestListOptions): Promise<UsageRequestList>;
14
- /**
15
- * Retrieves a specific request associated with the provided projectId
16
- * @param projectId Unique identifier of the project
17
- * @param requestId Unique identifier for the request to retrieve
18
- */
19
- getRequest(projectId: string, requestId: string): Promise<UsageRequest>;
20
- /**
21
- * Retrieves usage associated with the provided projectId based
22
- * on the provided options
23
- * @param projectId Unique identifier of the project
24
- * @param options Options to filter usage
25
- */
26
- getUsage(projectId: string, options?: UsageOptions): Promise<UsageResponse>;
27
- /**
28
- * Retrieves features used by the provided projectId based
29
- * on the provided options
30
- * @param projectId Unique identifier of the project
31
- * @param options Options to filter usage
32
- */
33
- getFields(projectId: string, options?: UsageFieldOptions): Promise<UsageField>;
34
- }
package/dist/usage.js DELETED
@@ -1,122 +0,0 @@
1
- "use strict";
2
- var __assign = (this && this.__assign) || function () {
3
- __assign = Object.assign || function(t) {
4
- for (var s, i = 1, n = arguments.length; i < n; i++) {
5
- s = arguments[i];
6
- for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
7
- t[p] = s[p];
8
- }
9
- return t;
10
- };
11
- return __assign.apply(this, arguments);
12
- };
13
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
14
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
15
- return new (P || (P = Promise))(function (resolve, reject) {
16
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
17
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
18
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
19
- step((generator = generator.apply(thisArg, _arguments || [])).next());
20
- });
21
- };
22
- var __generator = (this && this.__generator) || function (thisArg, body) {
23
- var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
24
- return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
25
- function verb(n) { return function (v) { return step([n, v]); }; }
26
- function step(op) {
27
- if (f) throw new TypeError("Generator is already executing.");
28
- while (_) try {
29
- 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;
30
- if (y = 0, t) op = [op[0] & 2, t.value];
31
- switch (op[0]) {
32
- case 0: case 1: t = op; break;
33
- case 4: _.label++; return { value: op[1], done: false };
34
- case 5: _.label++; y = op[1]; op = [0]; continue;
35
- case 7: op = _.ops.pop(); _.trys.pop(); continue;
36
- default:
37
- if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
38
- if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
39
- if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
40
- if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
41
- if (t[2]) _.ops.pop();
42
- _.trys.pop(); continue;
43
- }
44
- op = body.call(thisArg, _);
45
- } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
46
- if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
47
- }
48
- };
49
- var __importDefault = (this && this.__importDefault) || function (mod) {
50
- return (mod && mod.__esModule) ? mod : { "default": mod };
51
- };
52
- Object.defineProperty(exports, "__esModule", { value: true });
53
- exports.Usage = void 0;
54
- var querystring_1 = __importDefault(require("querystring"));
55
- var httpRequest_1 = require("./httpRequest");
56
- var Usage = /** @class */ (function () {
57
- function Usage(_credentials, _apiUrl) {
58
- this._credentials = _credentials;
59
- this._apiUrl = _apiUrl;
60
- this.apiPath = "/v1/projects";
61
- }
62
- /**
63
- * Retrieves all requests associated with the provided projectId based
64
- * on the provided options
65
- * @param projectId Unique identifier of the project
66
- * @param options Additional filter options
67
- */
68
- Usage.prototype.listRequests = function (projectId, options) {
69
- return __awaiter(this, void 0, void 0, function () {
70
- var requestOptions;
71
- return __generator(this, function (_a) {
72
- requestOptions = __assign({}, options);
73
- return [2 /*return*/, (0, httpRequest_1._request)("GET", this._credentials, this._apiUrl, "".concat(this.apiPath, "/").concat(projectId, "/requests?").concat(querystring_1.default.stringify(requestOptions)))];
74
- });
75
- });
76
- };
77
- /**
78
- * Retrieves a specific request associated with the provided projectId
79
- * @param projectId Unique identifier of the project
80
- * @param requestId Unique identifier for the request to retrieve
81
- */
82
- Usage.prototype.getRequest = function (projectId, requestId) {
83
- return __awaiter(this, void 0, void 0, function () {
84
- return __generator(this, function (_a) {
85
- return [2 /*return*/, (0, httpRequest_1._request)("GET", this._credentials, this._apiUrl, "".concat(this.apiPath, "/").concat(projectId, "/requests/").concat(requestId))];
86
- });
87
- });
88
- };
89
- /**
90
- * Retrieves usage associated with the provided projectId based
91
- * on the provided options
92
- * @param projectId Unique identifier of the project
93
- * @param options Options to filter usage
94
- */
95
- Usage.prototype.getUsage = function (projectId, options) {
96
- return __awaiter(this, void 0, void 0, function () {
97
- var requestOptions;
98
- return __generator(this, function (_a) {
99
- requestOptions = __assign({}, options);
100
- return [2 /*return*/, (0, httpRequest_1._request)("GET", this._credentials, this._apiUrl, "".concat(this.apiPath, "/").concat(projectId, "/usage?").concat(querystring_1.default.stringify(requestOptions)))];
101
- });
102
- });
103
- };
104
- /**
105
- * Retrieves features used by the provided projectId based
106
- * on the provided options
107
- * @param projectId Unique identifier of the project
108
- * @param options Options to filter usage
109
- */
110
- Usage.prototype.getFields = function (projectId, options) {
111
- return __awaiter(this, void 0, void 0, function () {
112
- var requestOptions;
113
- return __generator(this, function (_a) {
114
- requestOptions = __assign({}, options);
115
- return [2 /*return*/, (0, httpRequest_1._request)("GET", this._credentials, this._apiUrl, "".concat(this.apiPath, "/").concat(projectId, "/usage/fields?").concat(querystring_1.default.stringify(requestOptions)))];
116
- });
117
- });
118
- };
119
- return Usage;
120
- }());
121
- exports.Usage = Usage;
122
- //# sourceMappingURL=usage.js.map