@corti/sdk 3.1.0-rc → 3.1.0-rc.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 (220) hide show
  1. package/dist/cjs/BaseClient.js +2 -2
  2. package/dist/cjs/api/resources/documents/resources/sections/client/Client.d.ts +6 -0
  3. package/dist/cjs/api/resources/documents/resources/sections/client/Client.js +6 -0
  4. package/dist/cjs/api/resources/documents/resources/templates/client/Client.d.ts +7 -0
  5. package/dist/cjs/api/resources/documents/resources/templates/client/Client.js +7 -0
  6. package/dist/cjs/api/resources/documents/resources/templates/resources/versions/client/Client.d.ts +6 -0
  7. package/dist/cjs/api/resources/documents/resources/templates/resources/versions/client/Client.js +6 -0
  8. package/dist/cjs/api/resources/transcripts/client/Client.d.ts +1 -1
  9. package/dist/cjs/api/resources/transcripts/client/Client.js +1 -1
  10. package/dist/cjs/api/resources/transcripts/client/requests/TranscriptsCreateRequest.d.ts +3 -1
  11. package/dist/cjs/api/types/GuidedArrayNode.d.ts +3 -2
  12. package/dist/cjs/api/types/GuidedBoolNode.d.ts +2 -2
  13. package/dist/cjs/api/types/GuidedDocumentsGenerateBase.d.ts +2 -0
  14. package/dist/cjs/api/types/GuidedEphemeralDocument.d.ts +5 -0
  15. package/dist/cjs/api/types/GuidedFieldDefinition.d.ts +4 -1
  16. package/dist/cjs/api/types/GuidedNumberNode.d.ts +3 -3
  17. package/dist/cjs/api/types/GuidedObjectNode.d.ts +3 -3
  18. package/dist/cjs/api/types/GuidedSection.d.ts +0 -2
  19. package/dist/cjs/api/types/GuidedSectionsCreateBase.d.ts +0 -2
  20. package/dist/cjs/api/types/GuidedStringNode.d.ts +4 -4
  21. package/dist/cjs/api/types/GuidedTemplate.d.ts +0 -2
  22. package/dist/cjs/api/types/GuidedTemplatesCreateBase.d.ts +0 -2
  23. package/dist/cjs/api/types/StreamConfig.d.ts +5 -1
  24. package/dist/cjs/api/types/StreamConfigKeyterms.d.ts +8 -0
  25. package/dist/cjs/api/types/StreamConfigKeytermsTermsItem.d.ts +4 -0
  26. package/dist/cjs/api/types/StreamConfigReplacementsItem.d.ts +6 -0
  27. package/dist/cjs/api/types/StreamErrorDetail.d.ts +7 -5
  28. package/dist/cjs/api/types/TranscribeAudioEventsConfig.d.ts +1 -1
  29. package/dist/cjs/api/types/TranscribeCommand.d.ts +3 -3
  30. package/dist/cjs/api/types/TranscribeCommandVariable.d.ts +6 -5
  31. package/dist/cjs/api/types/TranscribeCommandVariableType.d.ts +6 -0
  32. package/dist/cjs/api/types/TranscribeCommandVariableType.js +9 -0
  33. package/dist/cjs/api/types/TranscribeConfig.d.ts +8 -4
  34. package/dist/cjs/api/types/TranscribeConfigKeyterms.d.ts +8 -0
  35. package/dist/cjs/api/types/TranscribeConfigKeytermsTermsItem.d.ts +4 -0
  36. package/dist/cjs/api/types/TranscribeConfigKeytermsTermsItem.js +3 -0
  37. package/dist/cjs/api/types/TranscribeConfigReplacementsItem.d.ts +6 -0
  38. package/dist/cjs/api/types/TranscribeConfigReplacementsItem.js +3 -0
  39. package/dist/cjs/api/types/TranscribeErrorMessageError.d.ts +7 -5
  40. package/dist/cjs/api/types/TranscribeSupportedLanguage.d.ts +1 -1
  41. package/dist/cjs/api/types/index.d.ts +7 -5
  42. package/dist/cjs/api/types/index.js +7 -5
  43. package/dist/cjs/custom/utils/dictationTranscript.d.ts +26 -0
  44. package/dist/cjs/custom/utils/dictationTranscript.js +77 -0
  45. package/dist/cjs/custom/utils/index.d.ts +1 -0
  46. package/dist/cjs/custom/utils/index.js +3 -1
  47. package/dist/cjs/serialization/resources/transcripts/client/requests/TranscriptsCreateRequest.d.ts +1 -0
  48. package/dist/cjs/serialization/resources/transcripts/client/requests/TranscriptsCreateRequest.js +1 -0
  49. package/dist/cjs/serialization/types/GuidedDocumentsGenerateBase.d.ts +2 -0
  50. package/dist/cjs/serialization/types/GuidedDocumentsGenerateBase.js +2 -0
  51. package/dist/cjs/serialization/types/GuidedEphemeralDocument.d.ts +3 -0
  52. package/dist/cjs/serialization/types/GuidedEphemeralDocument.js +3 -0
  53. package/dist/cjs/serialization/types/GuidedFieldDefinition.d.ts +1 -0
  54. package/dist/cjs/serialization/types/GuidedFieldDefinition.js +1 -0
  55. package/dist/cjs/serialization/types/GuidedSection.d.ts +0 -2
  56. package/dist/cjs/serialization/types/GuidedSection.js +0 -2
  57. package/dist/cjs/serialization/types/GuidedSectionsCreateBase.d.ts +0 -2
  58. package/dist/cjs/serialization/types/GuidedSectionsCreateBase.js +0 -2
  59. package/dist/cjs/serialization/types/GuidedTemplate.d.ts +0 -2
  60. package/dist/cjs/serialization/types/GuidedTemplate.js +0 -2
  61. package/dist/cjs/serialization/types/GuidedTemplatesCreateBase.d.ts +0 -2
  62. package/dist/cjs/serialization/types/GuidedTemplatesCreateBase.js +0 -2
  63. package/dist/cjs/serialization/types/StreamConfig.d.ts +4 -0
  64. package/dist/cjs/serialization/types/StreamConfig.js +4 -0
  65. package/dist/cjs/serialization/types/StreamConfigKeyterms.d.ts +10 -0
  66. package/dist/cjs/serialization/types/{GuidedTemplatesCreatePolicyRequest.js → StreamConfigKeyterms.js} +4 -5
  67. package/dist/cjs/serialization/types/StreamConfigKeytermsTermsItem.d.ts +9 -0
  68. package/dist/cjs/serialization/types/{GuidedSectionPolicy.js → StreamConfigKeytermsTermsItem.js} +3 -10
  69. package/dist/cjs/serialization/types/StreamConfigReplacementsItem.d.ts +10 -0
  70. package/dist/cjs/serialization/types/StreamConfigReplacementsItem.js +42 -0
  71. package/dist/cjs/serialization/types/StreamErrorDetail.d.ts +6 -5
  72. package/dist/cjs/serialization/types/StreamErrorDetail.js +6 -5
  73. package/dist/cjs/serialization/types/TranscribeAudioEventsConfig.d.ts +1 -1
  74. package/dist/cjs/serialization/types/TranscribeAudioEventsConfig.js +1 -1
  75. package/dist/cjs/serialization/types/TranscribeCommandVariable.d.ts +3 -2
  76. package/dist/cjs/serialization/types/TranscribeCommandVariable.js +3 -2
  77. package/dist/cjs/serialization/types/TranscribeCommandVariableType.d.ts +7 -0
  78. package/dist/cjs/serialization/types/{GuidedTemplatePolicyKind.js → TranscribeCommandVariableType.js} +2 -2
  79. package/dist/cjs/serialization/types/TranscribeConfig.d.ts +4 -0
  80. package/dist/cjs/serialization/types/TranscribeConfig.js +4 -0
  81. package/dist/cjs/serialization/types/TranscribeConfigKeyterms.d.ts +10 -0
  82. package/dist/cjs/serialization/types/TranscribeConfigKeyterms.js +42 -0
  83. package/dist/cjs/serialization/types/TranscribeConfigKeytermsTermsItem.d.ts +9 -0
  84. package/dist/cjs/serialization/types/{GuidedSectionsCreatePolicyRequest.js → TranscribeConfigKeytermsTermsItem.js} +3 -5
  85. package/dist/cjs/serialization/types/TranscribeConfigReplacementsItem.d.ts +10 -0
  86. package/dist/cjs/serialization/types/TranscribeConfigReplacementsItem.js +42 -0
  87. package/dist/cjs/serialization/types/TranscribeErrorMessageError.d.ts +6 -5
  88. package/dist/cjs/serialization/types/TranscribeErrorMessageError.js +6 -5
  89. package/dist/cjs/serialization/types/index.d.ts +7 -5
  90. package/dist/cjs/serialization/types/index.js +7 -5
  91. package/dist/cjs/version.d.ts +1 -1
  92. package/dist/cjs/version.js +1 -1
  93. package/dist/esm/BaseClient.mjs +2 -2
  94. package/dist/esm/api/resources/documents/resources/sections/client/Client.d.mts +6 -0
  95. package/dist/esm/api/resources/documents/resources/sections/client/Client.mjs +6 -0
  96. package/dist/esm/api/resources/documents/resources/templates/client/Client.d.mts +7 -0
  97. package/dist/esm/api/resources/documents/resources/templates/client/Client.mjs +7 -0
  98. package/dist/esm/api/resources/documents/resources/templates/resources/versions/client/Client.d.mts +6 -0
  99. package/dist/esm/api/resources/documents/resources/templates/resources/versions/client/Client.mjs +6 -0
  100. package/dist/esm/api/resources/transcripts/client/Client.d.mts +1 -1
  101. package/dist/esm/api/resources/transcripts/client/Client.mjs +1 -1
  102. package/dist/esm/api/resources/transcripts/client/requests/TranscriptsCreateRequest.d.mts +3 -1
  103. package/dist/esm/api/types/GuidedArrayNode.d.mts +3 -2
  104. package/dist/esm/api/types/GuidedBoolNode.d.mts +2 -2
  105. package/dist/esm/api/types/GuidedDocumentsGenerateBase.d.mts +2 -0
  106. package/dist/esm/api/types/GuidedEphemeralDocument.d.mts +5 -0
  107. package/dist/esm/api/types/GuidedFieldDefinition.d.mts +4 -1
  108. package/dist/esm/api/types/GuidedNumberNode.d.mts +3 -3
  109. package/dist/esm/api/types/GuidedObjectNode.d.mts +3 -3
  110. package/dist/esm/api/types/GuidedSection.d.mts +0 -2
  111. package/dist/esm/api/types/GuidedSectionsCreateBase.d.mts +0 -2
  112. package/dist/esm/api/types/GuidedStringNode.d.mts +4 -4
  113. package/dist/esm/api/types/GuidedTemplate.d.mts +0 -2
  114. package/dist/esm/api/types/GuidedTemplatesCreateBase.d.mts +0 -2
  115. package/dist/esm/api/types/StreamConfig.d.mts +5 -1
  116. package/dist/esm/api/types/StreamConfigKeyterms.d.mts +8 -0
  117. package/dist/esm/api/types/StreamConfigKeytermsTermsItem.d.mts +4 -0
  118. package/dist/esm/api/types/StreamConfigReplacementsItem.d.mts +6 -0
  119. package/dist/esm/api/types/StreamErrorDetail.d.mts +7 -5
  120. package/dist/esm/api/types/TranscribeAudioEventsConfig.d.mts +1 -1
  121. package/dist/esm/api/types/TranscribeCommand.d.mts +3 -3
  122. package/dist/esm/api/types/TranscribeCommandVariable.d.mts +6 -5
  123. package/dist/esm/api/types/TranscribeCommandVariableType.d.mts +6 -0
  124. package/dist/esm/api/types/TranscribeCommandVariableType.mjs +6 -0
  125. package/dist/esm/api/types/TranscribeConfig.d.mts +8 -4
  126. package/dist/esm/api/types/TranscribeConfigKeyterms.d.mts +8 -0
  127. package/dist/esm/api/types/TranscribeConfigKeytermsTermsItem.d.mts +4 -0
  128. package/dist/esm/api/types/TranscribeConfigKeytermsTermsItem.mjs +2 -0
  129. package/dist/esm/api/types/TranscribeConfigReplacementsItem.d.mts +6 -0
  130. package/dist/esm/api/types/TranscribeConfigReplacementsItem.mjs +2 -0
  131. package/dist/esm/api/types/TranscribeErrorMessageError.d.mts +7 -5
  132. package/dist/esm/api/types/TranscribeSupportedLanguage.d.mts +1 -1
  133. package/dist/esm/api/types/index.d.mts +7 -5
  134. package/dist/esm/api/types/index.mjs +7 -5
  135. package/dist/esm/custom/utils/dictationTranscript.d.mts +26 -0
  136. package/dist/esm/custom/utils/dictationTranscript.mjs +74 -0
  137. package/dist/esm/custom/utils/index.d.mts +1 -0
  138. package/dist/esm/custom/utils/index.mjs +1 -0
  139. package/dist/esm/serialization/resources/transcripts/client/requests/TranscriptsCreateRequest.d.mts +1 -0
  140. package/dist/esm/serialization/resources/transcripts/client/requests/TranscriptsCreateRequest.mjs +1 -0
  141. package/dist/esm/serialization/types/GuidedDocumentsGenerateBase.d.mts +2 -0
  142. package/dist/esm/serialization/types/GuidedDocumentsGenerateBase.mjs +2 -0
  143. package/dist/esm/serialization/types/GuidedEphemeralDocument.d.mts +3 -0
  144. package/dist/esm/serialization/types/GuidedEphemeralDocument.mjs +3 -0
  145. package/dist/esm/serialization/types/GuidedFieldDefinition.d.mts +1 -0
  146. package/dist/esm/serialization/types/GuidedFieldDefinition.mjs +1 -0
  147. package/dist/esm/serialization/types/GuidedSection.d.mts +0 -2
  148. package/dist/esm/serialization/types/GuidedSection.mjs +0 -2
  149. package/dist/esm/serialization/types/GuidedSectionsCreateBase.d.mts +0 -2
  150. package/dist/esm/serialization/types/GuidedSectionsCreateBase.mjs +0 -2
  151. package/dist/esm/serialization/types/GuidedTemplate.d.mts +0 -2
  152. package/dist/esm/serialization/types/GuidedTemplate.mjs +0 -2
  153. package/dist/esm/serialization/types/GuidedTemplatesCreateBase.d.mts +0 -2
  154. package/dist/esm/serialization/types/GuidedTemplatesCreateBase.mjs +0 -2
  155. package/dist/esm/serialization/types/StreamConfig.d.mts +4 -0
  156. package/dist/esm/serialization/types/StreamConfig.mjs +4 -0
  157. package/dist/esm/serialization/types/StreamConfigKeyterms.d.mts +10 -0
  158. package/dist/esm/serialization/types/StreamConfigKeyterms.mjs +6 -0
  159. package/dist/esm/serialization/types/StreamConfigKeytermsTermsItem.d.mts +9 -0
  160. package/dist/esm/serialization/types/StreamConfigKeytermsTermsItem.mjs +5 -0
  161. package/dist/esm/serialization/types/StreamConfigReplacementsItem.d.mts +10 -0
  162. package/dist/esm/serialization/types/StreamConfigReplacementsItem.mjs +6 -0
  163. package/dist/esm/serialization/types/StreamErrorDetail.d.mts +6 -5
  164. package/dist/esm/serialization/types/StreamErrorDetail.mjs +6 -5
  165. package/dist/esm/serialization/types/TranscribeAudioEventsConfig.d.mts +1 -1
  166. package/dist/esm/serialization/types/TranscribeAudioEventsConfig.mjs +1 -1
  167. package/dist/esm/serialization/types/TranscribeCommandVariable.d.mts +3 -2
  168. package/dist/esm/serialization/types/TranscribeCommandVariable.mjs +3 -2
  169. package/dist/esm/serialization/types/TranscribeCommandVariableType.d.mts +7 -0
  170. package/dist/esm/serialization/types/{GuidedTemplatePolicyKind.mjs → TranscribeCommandVariableType.mjs} +1 -1
  171. package/dist/esm/serialization/types/TranscribeConfig.d.mts +4 -0
  172. package/dist/esm/serialization/types/TranscribeConfig.mjs +4 -0
  173. package/dist/esm/serialization/types/TranscribeConfigKeyterms.d.mts +10 -0
  174. package/dist/esm/serialization/types/TranscribeConfigKeyterms.mjs +6 -0
  175. package/dist/esm/serialization/types/TranscribeConfigKeytermsTermsItem.d.mts +9 -0
  176. package/dist/esm/serialization/types/TranscribeConfigKeytermsTermsItem.mjs +5 -0
  177. package/dist/esm/serialization/types/TranscribeConfigReplacementsItem.d.mts +10 -0
  178. package/dist/esm/serialization/types/TranscribeConfigReplacementsItem.mjs +6 -0
  179. package/dist/esm/serialization/types/TranscribeErrorMessageError.d.mts +6 -5
  180. package/dist/esm/serialization/types/TranscribeErrorMessageError.mjs +6 -5
  181. package/dist/esm/serialization/types/index.d.mts +7 -5
  182. package/dist/esm/serialization/types/index.mjs +7 -5
  183. package/dist/esm/version.d.mts +1 -1
  184. package/dist/esm/version.mjs +1 -1
  185. package/package.json +1 -1
  186. package/dist/cjs/api/types/GuidedSectionPolicy.d.ts +0 -16
  187. package/dist/cjs/api/types/GuidedSectionsCreatePolicyRequest.d.ts +0 -6
  188. package/dist/cjs/api/types/GuidedTemplatePolicy.d.ts +0 -16
  189. package/dist/cjs/api/types/GuidedTemplatePolicyKind.d.ts +0 -6
  190. package/dist/cjs/api/types/GuidedTemplatePolicyKind.js +0 -9
  191. package/dist/cjs/api/types/GuidedTemplatesCreatePolicyRequest.d.ts +0 -6
  192. package/dist/cjs/serialization/types/GuidedSectionPolicy.d.ts +0 -16
  193. package/dist/cjs/serialization/types/GuidedSectionsCreatePolicyRequest.d.ts +0 -11
  194. package/dist/cjs/serialization/types/GuidedTemplatePolicy.d.ts +0 -16
  195. package/dist/cjs/serialization/types/GuidedTemplatePolicy.js +0 -48
  196. package/dist/cjs/serialization/types/GuidedTemplatePolicyKind.d.ts +0 -7
  197. package/dist/cjs/serialization/types/GuidedTemplatesCreatePolicyRequest.d.ts +0 -11
  198. package/dist/esm/api/types/GuidedSectionPolicy.d.mts +0 -16
  199. package/dist/esm/api/types/GuidedSectionsCreatePolicyRequest.d.mts +0 -6
  200. package/dist/esm/api/types/GuidedTemplatePolicy.d.mts +0 -16
  201. package/dist/esm/api/types/GuidedTemplatePolicyKind.d.mts +0 -6
  202. package/dist/esm/api/types/GuidedTemplatePolicyKind.mjs +0 -6
  203. package/dist/esm/api/types/GuidedTemplatesCreatePolicyRequest.d.mts +0 -6
  204. package/dist/esm/serialization/types/GuidedSectionPolicy.d.mts +0 -16
  205. package/dist/esm/serialization/types/GuidedSectionPolicy.mjs +0 -12
  206. package/dist/esm/serialization/types/GuidedSectionsCreatePolicyRequest.d.mts +0 -11
  207. package/dist/esm/serialization/types/GuidedSectionsCreatePolicyRequest.mjs +0 -7
  208. package/dist/esm/serialization/types/GuidedTemplatePolicy.d.mts +0 -16
  209. package/dist/esm/serialization/types/GuidedTemplatePolicy.mjs +0 -12
  210. package/dist/esm/serialization/types/GuidedTemplatePolicyKind.d.mts +0 -7
  211. package/dist/esm/serialization/types/GuidedTemplatesCreatePolicyRequest.d.mts +0 -11
  212. package/dist/esm/serialization/types/GuidedTemplatesCreatePolicyRequest.mjs +0 -7
  213. /package/dist/cjs/api/types/{GuidedSectionPolicy.js → StreamConfigKeyterms.js} +0 -0
  214. /package/dist/cjs/api/types/{GuidedSectionsCreatePolicyRequest.js → StreamConfigKeytermsTermsItem.js} +0 -0
  215. /package/dist/cjs/api/types/{GuidedTemplatePolicy.js → StreamConfigReplacementsItem.js} +0 -0
  216. /package/dist/cjs/api/types/{GuidedTemplatesCreatePolicyRequest.js → TranscribeConfigKeyterms.js} +0 -0
  217. /package/dist/esm/api/types/{GuidedSectionPolicy.mjs → StreamConfigKeyterms.mjs} +0 -0
  218. /package/dist/esm/api/types/{GuidedSectionsCreatePolicyRequest.mjs → StreamConfigKeytermsTermsItem.mjs} +0 -0
  219. /package/dist/esm/api/types/{GuidedTemplatePolicy.mjs → StreamConfigReplacementsItem.mjs} +0 -0
  220. /package/dist/esm/api/types/{GuidedTemplatesCreatePolicyRequest.mjs → TranscribeConfigKeyterms.mjs} +0 -0
@@ -36,8 +36,9 @@ var __importStar = (this && this.__importStar) || (function () {
36
36
  Object.defineProperty(exports, "__esModule", { value: true });
37
37
  exports.TranscribeCommandVariable = void 0;
38
38
  const core = __importStar(require("../../core/index.js"));
39
+ const TranscribeCommandVariableType_js_1 = require("./TranscribeCommandVariableType.js");
39
40
  exports.TranscribeCommandVariable = core.serialization.object({
40
41
  key: core.serialization.string(),
41
- type: core.serialization.stringLiteral("enum"),
42
- enum: core.serialization.list(core.serialization.string()),
42
+ type: TranscribeCommandVariableType_js_1.TranscribeCommandVariableType,
43
+ enum: core.serialization.list(core.serialization.string()).optional(),
43
44
  });
@@ -0,0 +1,7 @@
1
+ import type * as Corti from "../../api/index.js";
2
+ import * as core from "../../core/index.js";
3
+ import type * as serializers from "../index.js";
4
+ export declare const TranscribeCommandVariableType: core.serialization.Schema<serializers.TranscribeCommandVariableType.Raw, Corti.TranscribeCommandVariableType>;
5
+ export declare namespace TranscribeCommandVariableType {
6
+ type Raw = "enum" | "wildcard";
7
+ }
@@ -34,6 +34,6 @@ var __importStar = (this && this.__importStar) || (function () {
34
34
  };
35
35
  })();
36
36
  Object.defineProperty(exports, "__esModule", { value: true });
37
- exports.GuidedTemplatePolicyKind = void 0;
37
+ exports.TranscribeCommandVariableType = void 0;
38
38
  const core = __importStar(require("../../core/index.js"));
39
- exports.GuidedTemplatePolicyKind = core.serialization.enum_(["project", "customers"]);
39
+ exports.TranscribeCommandVariableType = core.serialization.enum_(["enum", "wildcard"]);
@@ -3,6 +3,8 @@ import * as core from "../../core/index.js";
3
3
  import type * as serializers from "../index.js";
4
4
  import { TranscribeAudioEventsConfig } from "./TranscribeAudioEventsConfig.js";
5
5
  import { TranscribeCommand } from "./TranscribeCommand.js";
6
+ import { TranscribeConfigKeyterms } from "./TranscribeConfigKeyterms.js";
7
+ import { TranscribeConfigReplacementsItem } from "./TranscribeConfigReplacementsItem.js";
6
8
  import { TranscribeFormatting } from "./TranscribeFormatting.js";
7
9
  import { TranscribeSupportedLanguage } from "./TranscribeSupportedLanguage.js";
8
10
  export declare const TranscribeConfig: core.serialization.ObjectSchema<serializers.TranscribeConfig.Raw, Corti.TranscribeConfig>;
@@ -16,5 +18,7 @@ export declare namespace TranscribeConfig {
16
18
  formatting?: TranscribeFormatting.Raw | null;
17
19
  audioEvents?: TranscribeAudioEventsConfig.Raw | null;
18
20
  audioFormat?: string | null;
21
+ replacements?: TranscribeConfigReplacementsItem.Raw[] | null;
22
+ keyterms?: TranscribeConfigKeyterms.Raw | null;
19
23
  }
20
24
  }
@@ -38,6 +38,8 @@ exports.TranscribeConfig = void 0;
38
38
  const core = __importStar(require("../../core/index.js"));
39
39
  const TranscribeAudioEventsConfig_js_1 = require("./TranscribeAudioEventsConfig.js");
40
40
  const TranscribeCommand_js_1 = require("./TranscribeCommand.js");
41
+ const TranscribeConfigKeyterms_js_1 = require("./TranscribeConfigKeyterms.js");
42
+ const TranscribeConfigReplacementsItem_js_1 = require("./TranscribeConfigReplacementsItem.js");
41
43
  const TranscribeFormatting_js_1 = require("./TranscribeFormatting.js");
42
44
  const TranscribeSupportedLanguage_js_1 = require("./TranscribeSupportedLanguage.js");
43
45
  exports.TranscribeConfig = core.serialization.object({
@@ -49,4 +51,6 @@ exports.TranscribeConfig = core.serialization.object({
49
51
  formatting: TranscribeFormatting_js_1.TranscribeFormatting.optional(),
50
52
  audioEvents: TranscribeAudioEventsConfig_js_1.TranscribeAudioEventsConfig.optional(),
51
53
  audioFormat: core.serialization.string().optional(),
54
+ replacements: core.serialization.list(TranscribeConfigReplacementsItem_js_1.TranscribeConfigReplacementsItem).optional(),
55
+ keyterms: TranscribeConfigKeyterms_js_1.TranscribeConfigKeyterms.optional(),
52
56
  });
@@ -0,0 +1,10 @@
1
+ import type * as Corti from "../../api/index.js";
2
+ import * as core from "../../core/index.js";
3
+ import type * as serializers from "../index.js";
4
+ import { TranscribeConfigKeytermsTermsItem } from "./TranscribeConfigKeytermsTermsItem.js";
5
+ export declare const TranscribeConfigKeyterms: core.serialization.ObjectSchema<serializers.TranscribeConfigKeyterms.Raw, Corti.TranscribeConfigKeyterms>;
6
+ export declare namespace TranscribeConfigKeyterms {
7
+ interface Raw {
8
+ terms?: TranscribeConfigKeytermsTermsItem.Raw[] | null;
9
+ }
10
+ }
@@ -0,0 +1,42 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
4
+ if (k2 === undefined) k2 = k;
5
+ var desc = Object.getOwnPropertyDescriptor(m, k);
6
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
7
+ desc = { enumerable: true, get: function() { return m[k]; } };
8
+ }
9
+ Object.defineProperty(o, k2, desc);
10
+ }) : (function(o, m, k, k2) {
11
+ if (k2 === undefined) k2 = k;
12
+ o[k2] = m[k];
13
+ }));
14
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
15
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
16
+ }) : function(o, v) {
17
+ o["default"] = v;
18
+ });
19
+ var __importStar = (this && this.__importStar) || (function () {
20
+ var ownKeys = function(o) {
21
+ ownKeys = Object.getOwnPropertyNames || function (o) {
22
+ var ar = [];
23
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
24
+ return ar;
25
+ };
26
+ return ownKeys(o);
27
+ };
28
+ return function (mod) {
29
+ if (mod && mod.__esModule) return mod;
30
+ var result = {};
31
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
32
+ __setModuleDefault(result, mod);
33
+ return result;
34
+ };
35
+ })();
36
+ Object.defineProperty(exports, "__esModule", { value: true });
37
+ exports.TranscribeConfigKeyterms = void 0;
38
+ const core = __importStar(require("../../core/index.js"));
39
+ const TranscribeConfigKeytermsTermsItem_js_1 = require("./TranscribeConfigKeytermsTermsItem.js");
40
+ exports.TranscribeConfigKeyterms = core.serialization.object({
41
+ terms: core.serialization.list(TranscribeConfigKeytermsTermsItem_js_1.TranscribeConfigKeytermsTermsItem).optional(),
42
+ });
@@ -0,0 +1,9 @@
1
+ import type * as Corti from "../../api/index.js";
2
+ import * as core from "../../core/index.js";
3
+ import type * as serializers from "../index.js";
4
+ export declare const TranscribeConfigKeytermsTermsItem: core.serialization.ObjectSchema<serializers.TranscribeConfigKeytermsTermsItem.Raw, Corti.TranscribeConfigKeytermsTermsItem>;
5
+ export declare namespace TranscribeConfigKeytermsTermsItem {
6
+ interface Raw {
7
+ term: string;
8
+ }
9
+ }
@@ -34,10 +34,8 @@ var __importStar = (this && this.__importStar) || (function () {
34
34
  };
35
35
  })();
36
36
  Object.defineProperty(exports, "__esModule", { value: true });
37
- exports.GuidedSectionsCreatePolicyRequest = void 0;
37
+ exports.TranscribeConfigKeytermsTermsItem = void 0;
38
38
  const core = __importStar(require("../../core/index.js"));
39
- const GuidedTemplatePolicyKind_js_1 = require("./GuidedTemplatePolicyKind.js");
40
- exports.GuidedSectionsCreatePolicyRequest = core.serialization.object({
41
- kind: GuidedTemplatePolicyKind_js_1.GuidedTemplatePolicyKind,
42
- customerIds: core.serialization.list(core.serialization.string()).optionalNullable(),
39
+ exports.TranscribeConfigKeytermsTermsItem = core.serialization.object({
40
+ term: core.serialization.string(),
43
41
  });
@@ -0,0 +1,10 @@
1
+ import type * as Corti from "../../api/index.js";
2
+ import * as core from "../../core/index.js";
3
+ import type * as serializers from "../index.js";
4
+ export declare const TranscribeConfigReplacementsItem: core.serialization.ObjectSchema<serializers.TranscribeConfigReplacementsItem.Raw, Corti.TranscribeConfigReplacementsItem>;
5
+ export declare namespace TranscribeConfigReplacementsItem {
6
+ interface Raw {
7
+ find: string;
8
+ replace: string;
9
+ }
10
+ }
@@ -0,0 +1,42 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
4
+ if (k2 === undefined) k2 = k;
5
+ var desc = Object.getOwnPropertyDescriptor(m, k);
6
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
7
+ desc = { enumerable: true, get: function() { return m[k]; } };
8
+ }
9
+ Object.defineProperty(o, k2, desc);
10
+ }) : (function(o, m, k, k2) {
11
+ if (k2 === undefined) k2 = k;
12
+ o[k2] = m[k];
13
+ }));
14
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
15
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
16
+ }) : function(o, v) {
17
+ o["default"] = v;
18
+ });
19
+ var __importStar = (this && this.__importStar) || (function () {
20
+ var ownKeys = function(o) {
21
+ ownKeys = Object.getOwnPropertyNames || function (o) {
22
+ var ar = [];
23
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
24
+ return ar;
25
+ };
26
+ return ownKeys(o);
27
+ };
28
+ return function (mod) {
29
+ if (mod && mod.__esModule) return mod;
30
+ var result = {};
31
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
32
+ __setModuleDefault(result, mod);
33
+ return result;
34
+ };
35
+ })();
36
+ Object.defineProperty(exports, "__esModule", { value: true });
37
+ exports.TranscribeConfigReplacementsItem = void 0;
38
+ const core = __importStar(require("../../core/index.js"));
39
+ exports.TranscribeConfigReplacementsItem = core.serialization.object({
40
+ find: core.serialization.string(),
41
+ replace: core.serialization.string(),
42
+ });
@@ -4,10 +4,11 @@ import type * as serializers from "../index.js";
4
4
  export declare const TranscribeErrorMessageError: core.serialization.ObjectSchema<serializers.TranscribeErrorMessageError.Raw, Corti.TranscribeErrorMessageError>;
5
5
  export declare namespace TranscribeErrorMessageError {
6
6
  interface Raw {
7
- id: string;
8
- title: string;
9
- status: number;
10
- details: string;
11
- doc: string;
7
+ requestid?: string | null;
8
+ id?: string | null;
9
+ title?: string | null;
10
+ status?: number | null;
11
+ details?: string | null;
12
+ doc?: string | null;
12
13
  }
13
14
  }
@@ -37,9 +37,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
37
37
  exports.TranscribeErrorMessageError = void 0;
38
38
  const core = __importStar(require("../../core/index.js"));
39
39
  exports.TranscribeErrorMessageError = core.serialization.object({
40
- id: core.serialization.string(),
41
- title: core.serialization.string(),
42
- status: core.serialization.number(),
43
- details: core.serialization.string(),
44
- doc: core.serialization.string(),
40
+ requestid: core.serialization.string().optional(),
41
+ id: core.serialization.string().optional(),
42
+ title: core.serialization.string().optional(),
43
+ status: core.serialization.number().optional(),
44
+ details: core.serialization.string().optional(),
45
+ doc: core.serialization.string().optional(),
45
46
  });
@@ -143,12 +143,10 @@ export * from "./GuidedSectionInstructionsOverride.js";
143
143
  export * from "./GuidedSectionInstructionsPartial.js";
144
144
  export * from "./GuidedSectionOverride.js";
145
145
  export * from "./GuidedSectionOverrides.js";
146
- export * from "./GuidedSectionPolicy.js";
147
146
  export * from "./GuidedSectionSource.js";
148
147
  export * from "./GuidedSectionsCreateBase.js";
149
148
  export * from "./GuidedSectionsCreateFromInheritanceRequest.js";
150
149
  export * from "./GuidedSectionsCreateFromScratchRequest.js";
151
- export * from "./GuidedSectionsCreatePolicyRequest.js";
152
150
  export * from "./GuidedSectionsCreateRequest.js";
153
151
  export * from "./GuidedSectionVersion.js";
154
152
  export * from "./GuidedShallowTemplateGeneration.js";
@@ -160,8 +158,6 @@ export * from "./GuidedTemplateGeneration.js";
160
158
  export * from "./GuidedTemplateInstructions.js";
161
159
  export * from "./GuidedTemplateInstructionsPartial.js";
162
160
  export * from "./GuidedTemplateOverrides.js";
163
- export * from "./GuidedTemplatePolicy.js";
164
- export * from "./GuidedTemplatePolicyKind.js";
165
161
  export * from "./GuidedTemplateRef.js";
166
162
  export * from "./GuidedTemplateSource.js";
167
163
  export * from "./GuidedTemplatesCreateBase.js";
@@ -169,7 +165,6 @@ export * from "./GuidedTemplatesCreateFromInheritanceRequest.js";
169
165
  export * from "./GuidedTemplatesCreateFromInheritanceRequestGeneration.js";
170
166
  export * from "./GuidedTemplatesCreateFromScratchRequest.js";
171
167
  export * from "./GuidedTemplatesCreateFromScratchRequestGeneration.js";
172
- export * from "./GuidedTemplatesCreatePolicyRequest.js";
173
168
  export * from "./GuidedTemplatesCreateRequest.js";
174
169
  export * from "./GuidedTemplatesVersionGeneration.js";
175
170
  export * from "./GuidedTemplatesVersionSectionRequest.js";
@@ -195,12 +190,15 @@ export * from "./StreamAudioEventDataEvent.js";
195
190
  export * from "./StreamAudioEventMessage.js";
196
191
  export * from "./StreamAudioEventsConfig.js";
197
192
  export * from "./StreamConfig.js";
193
+ export * from "./StreamConfigKeyterms.js";
194
+ export * from "./StreamConfigKeytermsTermsItem.js";
198
195
  export * from "./StreamConfigMessage.js";
199
196
  export * from "./StreamConfigMode.js";
200
197
  export * from "./StreamConfigModeFactGenerationInterval.js";
201
198
  export * from "./StreamConfigModeType.js";
202
199
  export * from "./StreamConfigParticipant.js";
203
200
  export * from "./StreamConfigParticipantRole.js";
201
+ export * from "./StreamConfigReplacementsItem.js";
204
202
  export * from "./StreamConfigRetentionPolicy.js";
205
203
  export * from "./StreamConfigStatusMessage.js";
206
204
  export * from "./StreamConfigStatusMessageType.js";
@@ -238,8 +236,12 @@ export * from "./TranscribeCommand.js";
238
236
  export * from "./TranscribeCommandData.js";
239
237
  export * from "./TranscribeCommandMessage.js";
240
238
  export * from "./TranscribeCommandVariable.js";
239
+ export * from "./TranscribeCommandVariableType.js";
241
240
  export * from "./TranscribeConfig.js";
241
+ export * from "./TranscribeConfigKeyterms.js";
242
+ export * from "./TranscribeConfigKeytermsTermsItem.js";
242
243
  export * from "./TranscribeConfigMessage.js";
244
+ export * from "./TranscribeConfigReplacementsItem.js";
243
245
  export * from "./TranscribeConfigStatusMessage.js";
244
246
  export * from "./TranscribeConfigStatusMessageType.js";
245
247
  export * from "./TranscribeDeltaUsageMessage.js";
@@ -159,12 +159,10 @@ __exportStar(require("./GuidedSectionInstructionsOverride.js"), exports);
159
159
  __exportStar(require("./GuidedSectionInstructionsPartial.js"), exports);
160
160
  __exportStar(require("./GuidedSectionOverride.js"), exports);
161
161
  __exportStar(require("./GuidedSectionOverrides.js"), exports);
162
- __exportStar(require("./GuidedSectionPolicy.js"), exports);
163
162
  __exportStar(require("./GuidedSectionSource.js"), exports);
164
163
  __exportStar(require("./GuidedSectionsCreateBase.js"), exports);
165
164
  __exportStar(require("./GuidedSectionsCreateFromInheritanceRequest.js"), exports);
166
165
  __exportStar(require("./GuidedSectionsCreateFromScratchRequest.js"), exports);
167
- __exportStar(require("./GuidedSectionsCreatePolicyRequest.js"), exports);
168
166
  __exportStar(require("./GuidedSectionsCreateRequest.js"), exports);
169
167
  __exportStar(require("./GuidedSectionVersion.js"), exports);
170
168
  __exportStar(require("./GuidedShallowTemplateGeneration.js"), exports);
@@ -176,8 +174,6 @@ __exportStar(require("./GuidedTemplateGeneration.js"), exports);
176
174
  __exportStar(require("./GuidedTemplateInstructions.js"), exports);
177
175
  __exportStar(require("./GuidedTemplateInstructionsPartial.js"), exports);
178
176
  __exportStar(require("./GuidedTemplateOverrides.js"), exports);
179
- __exportStar(require("./GuidedTemplatePolicy.js"), exports);
180
- __exportStar(require("./GuidedTemplatePolicyKind.js"), exports);
181
177
  __exportStar(require("./GuidedTemplateRef.js"), exports);
182
178
  __exportStar(require("./GuidedTemplateSource.js"), exports);
183
179
  __exportStar(require("./GuidedTemplatesCreateBase.js"), exports);
@@ -185,7 +181,6 @@ __exportStar(require("./GuidedTemplatesCreateFromInheritanceRequest.js"), export
185
181
  __exportStar(require("./GuidedTemplatesCreateFromInheritanceRequestGeneration.js"), exports);
186
182
  __exportStar(require("./GuidedTemplatesCreateFromScratchRequest.js"), exports);
187
183
  __exportStar(require("./GuidedTemplatesCreateFromScratchRequestGeneration.js"), exports);
188
- __exportStar(require("./GuidedTemplatesCreatePolicyRequest.js"), exports);
189
184
  __exportStar(require("./GuidedTemplatesCreateRequest.js"), exports);
190
185
  __exportStar(require("./GuidedTemplatesVersionGeneration.js"), exports);
191
186
  __exportStar(require("./GuidedTemplatesVersionSectionRequest.js"), exports);
@@ -211,12 +206,15 @@ __exportStar(require("./StreamAudioEventDataEvent.js"), exports);
211
206
  __exportStar(require("./StreamAudioEventMessage.js"), exports);
212
207
  __exportStar(require("./StreamAudioEventsConfig.js"), exports);
213
208
  __exportStar(require("./StreamConfig.js"), exports);
209
+ __exportStar(require("./StreamConfigKeyterms.js"), exports);
210
+ __exportStar(require("./StreamConfigKeytermsTermsItem.js"), exports);
214
211
  __exportStar(require("./StreamConfigMessage.js"), exports);
215
212
  __exportStar(require("./StreamConfigMode.js"), exports);
216
213
  __exportStar(require("./StreamConfigModeFactGenerationInterval.js"), exports);
217
214
  __exportStar(require("./StreamConfigModeType.js"), exports);
218
215
  __exportStar(require("./StreamConfigParticipant.js"), exports);
219
216
  __exportStar(require("./StreamConfigParticipantRole.js"), exports);
217
+ __exportStar(require("./StreamConfigReplacementsItem.js"), exports);
220
218
  __exportStar(require("./StreamConfigRetentionPolicy.js"), exports);
221
219
  __exportStar(require("./StreamConfigStatusMessage.js"), exports);
222
220
  __exportStar(require("./StreamConfigStatusMessageType.js"), exports);
@@ -254,8 +252,12 @@ __exportStar(require("./TranscribeCommand.js"), exports);
254
252
  __exportStar(require("./TranscribeCommandData.js"), exports);
255
253
  __exportStar(require("./TranscribeCommandMessage.js"), exports);
256
254
  __exportStar(require("./TranscribeCommandVariable.js"), exports);
255
+ __exportStar(require("./TranscribeCommandVariableType.js"), exports);
257
256
  __exportStar(require("./TranscribeConfig.js"), exports);
257
+ __exportStar(require("./TranscribeConfigKeyterms.js"), exports);
258
+ __exportStar(require("./TranscribeConfigKeytermsTermsItem.js"), exports);
258
259
  __exportStar(require("./TranscribeConfigMessage.js"), exports);
260
+ __exportStar(require("./TranscribeConfigReplacementsItem.js"), exports);
259
261
  __exportStar(require("./TranscribeConfigStatusMessage.js"), exports);
260
262
  __exportStar(require("./TranscribeConfigStatusMessageType.js"), exports);
261
263
  __exportStar(require("./TranscribeDeltaUsageMessage.js"), exports);
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "3.1.0-rc";
1
+ export declare const SDK_VERSION = "3.1.0-rc.2";
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.SDK_VERSION = void 0;
4
- exports.SDK_VERSION = "3.1.0-rc";
4
+ exports.SDK_VERSION = "3.1.0-rc.2";
@@ -6,8 +6,8 @@ export function normalizeClientOptions(options) {
6
6
  const headers = mergeHeaders({
7
7
  "X-Fern-Language": "JavaScript",
8
8
  "X-Fern-SDK-Name": "@corti/sdk",
9
- "X-Fern-SDK-Version": "3.1.0-rc",
10
- "User-Agent": "@corti/sdk/3.1.0-rc",
9
+ "X-Fern-SDK-Version": "3.1.0-rc.2",
10
+ "User-Agent": "@corti/sdk/3.1.0-rc.2",
11
11
  "X-Fern-Runtime": core.RUNTIME.type,
12
12
  "X-Fern-Runtime-Version": core.RUNTIME.version,
13
13
  "Tenant-Name": options === null || options === void 0 ? void 0 : options.tenantName,
@@ -14,6 +14,9 @@ export declare class SectionsClient {
14
14
  constructor(options: SectionsClient.Options);
15
15
  get versions(): VersionsClient;
16
16
  /**
17
+ * Returns a list of sections and their metadata. Fetch a sectionId to get the full generation content.
18
+ * Use query parameters to filter by language, region, specialty, label, publish status, or source.
19
+ *
17
20
  * @param {Corti.documents.GuidedSectionsListRequest} request
18
21
  * @param {SectionsClient.RequestOptions} requestOptions - Request-specific configuration.
19
22
  *
@@ -78,6 +81,9 @@ export declare class SectionsClient {
78
81
  delete(sectionID: string, requestOptions?: SectionsClient.RequestOptions): core.HttpResponsePromise<void>;
79
82
  private __delete;
80
83
  /**
84
+ * Updates the section's metadata fields (name, description, languages, regions, specialties, labels).
85
+ * Generation content (instructions, output schema) is managed through versions and cannot be updated here.
86
+ *
81
87
  * @param {string} sectionID
82
88
  * @param {Corti.documents.GuidedSectionsUpdateRequest} request
83
89
  * @param {SectionsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -25,6 +25,9 @@ export class SectionsClient {
25
25
  return ((_a = this._versions) !== null && _a !== void 0 ? _a : (this._versions = new VersionsClient(this._options)));
26
26
  }
27
27
  /**
28
+ * Returns a list of sections and their metadata. Fetch a sectionId to get the full generation content.
29
+ * Use query parameters to filter by language, region, specialty, label, publish status, or source.
30
+ *
28
31
  * @param {Corti.documents.GuidedSectionsListRequest} request
29
32
  * @param {SectionsClient.RequestOptions} requestOptions - Request-specific configuration.
30
33
  *
@@ -279,6 +282,9 @@ export class SectionsClient {
279
282
  });
280
283
  }
281
284
  /**
285
+ * Updates the section's metadata fields (name, description, languages, regions, specialties, labels).
286
+ * Generation content (instructions, output schema) is managed through versions and cannot be updated here.
287
+ *
282
288
  * @param {string} sectionID
283
289
  * @param {Corti.documents.GuidedSectionsUpdateRequest} request
284
290
  * @param {SectionsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -14,6 +14,9 @@ export declare class TemplatesClient {
14
14
  constructor(options: TemplatesClient.Options);
15
15
  get versions(): VersionsClient;
16
16
  /**
17
+ * Returns a list of templates and their metadata. Fetch a specific templateId to get the expanded sections.
18
+ * Use query parameters to filter by language, region, specialty, label, publish status, or source.
19
+ *
17
20
  * @param {Corti.documents.GuidedTemplatesListRequest} request
18
21
  * @param {TemplatesClient.RequestOptions} requestOptions - Request-specific configuration.
19
22
  *
@@ -74,6 +77,10 @@ export declare class TemplatesClient {
74
77
  delete(templateID: string, requestOptions?: TemplatesClient.RequestOptions): core.HttpResponsePromise<void>;
75
78
  private __delete;
76
79
  /**
80
+ * Updates the template's metadata fields (name, description, languages, regions, specialties, labels).
81
+ * Generation content (template instructions, section composition) is managed through versions
82
+ * and cannot be updated here.
83
+ *
77
84
  * @param {string} templateID
78
85
  * @param {Corti.documents.GuidedTemplatesUpdateRequest} request
79
86
  * @param {TemplatesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -25,6 +25,9 @@ export class TemplatesClient {
25
25
  return ((_a = this._versions) !== null && _a !== void 0 ? _a : (this._versions = new VersionsClient(this._options)));
26
26
  }
27
27
  /**
28
+ * Returns a list of templates and their metadata. Fetch a specific templateId to get the expanded sections.
29
+ * Use query parameters to filter by language, region, specialty, label, publish status, or source.
30
+ *
28
31
  * @param {Corti.documents.GuidedTemplatesListRequest} request
29
32
  * @param {TemplatesClient.RequestOptions} requestOptions - Request-specific configuration.
30
33
  *
@@ -275,6 +278,10 @@ export class TemplatesClient {
275
278
  });
276
279
  }
277
280
  /**
281
+ * Updates the template's metadata fields (name, description, languages, regions, specialties, labels).
282
+ * Generation content (template instructions, section composition) is managed through versions
283
+ * and cannot be updated here.
284
+ *
278
285
  * @param {string} templateID
279
286
  * @param {Corti.documents.GuidedTemplatesUpdateRequest} request
280
287
  * @param {TemplatesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -11,6 +11,9 @@ export declare class VersionsClient {
11
11
  protected readonly _options: NormalizedClientOptionsWithAuth<VersionsClient.Options>;
12
12
  constructor(options: VersionsClient.Options);
13
13
  /**
14
+ * Returns raw authored template versions without inheritance resolution or section expansion.
15
+ * To see resolved content, use GET /documents/templates/{templateID} instead.
16
+ *
14
17
  * @param {string} templateID
15
18
  * @param {VersionsClient.RequestOptions} requestOptions - Request-specific configuration.
16
19
  *
@@ -39,6 +42,9 @@ export declare class VersionsClient {
39
42
  create(templateID: string, request: Corti.documents.templates.GuidedTemplatesCreateVersionRequest, requestOptions?: VersionsClient.RequestOptions): core.HttpResponsePromise<Corti.GuidedShallowTemplateVersionResponse>;
40
43
  private __create;
41
44
  /**
45
+ * Returns the raw authored template version without inheritance resolution or section expansion.
46
+ * To see resolved content, use GET /documents/templates/{templateID} instead.
47
+ *
42
48
  * @param {string} templateID
43
49
  * @param {string} versionID
44
50
  * @param {VersionsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -20,6 +20,9 @@ export class VersionsClient {
20
20
  this._options = normalizeClientOptionsWithAuth(options);
21
21
  }
22
22
  /**
23
+ * Returns raw authored template versions without inheritance resolution or section expansion.
24
+ * To see resolved content, use GET /documents/templates/{templateID} instead.
25
+ *
23
26
  * @param {string} templateID
24
27
  * @param {VersionsClient.RequestOptions} requestOptions - Request-specific configuration.
25
28
  *
@@ -144,6 +147,9 @@ export class VersionsClient {
144
147
  });
145
148
  }
146
149
  /**
150
+ * Returns the raw authored template version without inheritance resolution or section expansion.
151
+ * To see resolved content, use GET /documents/templates/{templateID} instead.
152
+ *
147
153
  * @param {string} templateID
148
154
  * @param {string} versionID
149
155
  * @param {VersionsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -29,7 +29,7 @@ export declare class TranscriptsClient {
29
29
  list(id: Corti.Uuid, request?: Corti.TranscriptsListRequest, requestOptions?: TranscriptsClient.RequestOptions): core.HttpResponsePromise<Corti.TranscriptsListResponse>;
30
30
  private __list;
31
31
  /**
32
- * Create a transcript from an audio file uploaded to the interaction via `/recordings` endpoint.<br/><Note>Each interaction may have more than one audio file and transcript associated with it. Audio files up to 60 min in total duration, or 150 MB in total size, may be used.<br/><br/>Requests will process synchronously for 25 seconds before timeout, upon which processing will continue asynchronously. In the latter scenario, a partial or empty transcript with `status=processing` will be returned with a location header that can be used to retrieve the completed transcript.<br/><br/>The client can poll the `/transcripts` endpoint (`GET /interactions/{id}/transcripts/{transcriptId}/status`) for transcript status monitoring:<br/>- `200 OK` with status `processing`, `completed`, or `failed`<br/>- `404 Not Found` if the `interactionId` or `transcriptId` are invalid<br/><br/>The completed transcript can be retrieved via the Get Transcript request (`GET /interactions/{id}/transcripts/{transcriptId}/`).</Note>
32
+ * Create a transcript from an audio file uploaded to the interaction via `/recordings` endpoint.<br/><Note>Each interaction may have more than one audio file and transcript associated with it. Audio files up to 60 min in total duration, or 150 MB in total size, may be used.<br/><br/>By default, requests will process synchronously for 25 seconds before timeout, upon which processing will continue asynchronously. Set the `async` parameter to true to receive the location header immediately and process the request asynchronously. Read more [here](https://docs.corti.ai/stt/transcripts).</Note>
33
33
  *
34
34
  * @param {Corti.Uuid} id - The unique identifier of the interaction. Must be a valid UUID.
35
35
  * @param {Corti.TranscriptsCreateRequest} request
@@ -106,7 +106,7 @@ export class TranscriptsClient {
106
106
  });
107
107
  }
108
108
  /**
109
- * Create a transcript from an audio file uploaded to the interaction via `/recordings` endpoint.<br/><Note>Each interaction may have more than one audio file and transcript associated with it. Audio files up to 60 min in total duration, or 150 MB in total size, may be used.<br/><br/>Requests will process synchronously for 25 seconds before timeout, upon which processing will continue asynchronously. In the latter scenario, a partial or empty transcript with `status=processing` will be returned with a location header that can be used to retrieve the completed transcript.<br/><br/>The client can poll the `/transcripts` endpoint (`GET /interactions/{id}/transcripts/{transcriptId}/status`) for transcript status monitoring:<br/>- `200 OK` with status `processing`, `completed`, or `failed`<br/>- `404 Not Found` if the `interactionId` or `transcriptId` are invalid<br/><br/>The completed transcript can be retrieved via the Get Transcript request (`GET /interactions/{id}/transcripts/{transcriptId}/`).</Note>
109
+ * Create a transcript from an audio file uploaded to the interaction via `/recordings` endpoint.<br/><Note>Each interaction may have more than one audio file and transcript associated with it. Audio files up to 60 min in total duration, or 150 MB in total size, may be used.<br/><br/>By default, requests will process synchronously for 25 seconds before timeout, upon which processing will continue asynchronously. Set the `async` parameter to true to receive the location header immediately and process the request asynchronously. Read more [here](https://docs.corti.ai/stt/transcripts).</Note>
110
110
  *
111
111
  * @param {Corti.Uuid} id - The unique identifier of the interaction. Must be a valid UUID.
112
112
  * @param {Corti.TranscriptsCreateRequest} request
@@ -11,7 +11,7 @@ export interface TranscriptsCreateRequest {
11
11
  recordingId: Corti.Uuid;
12
12
  /** The primary spoken language of the recording. Check https://docs.corti.ai/stt/languages for more. */
13
13
  primaryLanguage: string;
14
- /** Indicates whether spoken dictation commands should be converted to punctuation (e.g., 'comma' → ','). */
14
+ /** If true, spoken punctuation will be converted to symbols (e.g., 'comma' → ','). */
15
15
  isDictation?: boolean;
16
16
  /** If true, each audio channel is transcribed separately. */
17
17
  isMultichannel?: boolean;
@@ -19,4 +19,6 @@ export interface TranscriptsCreateRequest {
19
19
  diarize?: boolean;
20
20
  /** An array of participants, each specifying a role and an assigned audio channel in the recording. Leave empty when shouldDiarize: true */
21
21
  participants?: Corti.TranscriptsParticipant[];
22
+ /** If true, the request will return immediately with a 202 status and the transcript will be processed asynchronously. Poll [Get Transcript Status](/api-reference/transcripts/get-transcript-status) to check transcript processing status - `processing`, `completed`, `failed`. */
23
+ async?: boolean;
22
24
  }
@@ -1,10 +1,11 @@
1
1
  import type * as Corti from "../index.mjs";
2
2
  export interface GuidedArrayNode {
3
3
  type: "array";
4
- /** Can be used to prompt the LLM with more guidance in addition to the section.instructions */
4
+ /** Guide the LLM in what to output for this node. Supplements the section-level instructions. */
5
5
  description?: string;
6
+ /** Must be another output schema node (string, number, boolean, array, or object). */
6
7
  items: Corti.GuidedOutputSchema;
7
- /** Controls how each array item is rendered in the generated output. Use `bullet` (default), `numbered`, or `plain`, or provide a custom format string containing the `{item}` placeholder. */
8
+ /** Format string used to render each array item in the generated output. Use the `{item}` placeholder for the item value. */
8
9
  itemFormat?: string;
9
10
  /** Minimum number of array items to generate. */
10
11
  minItems?: number | null;
@@ -1,7 +1,7 @@
1
1
  export interface GuidedBoolNode {
2
2
  type: "boolean";
3
- /** Can be used to prompt the LLM with more guidance in addition to the section.instructions */
3
+ /** Guide the LLM in what to output for this node. Supplements the section-level instructions. */
4
4
  description?: string;
5
- /** The default to output if nothing to output. */
5
+ /** If nothing is outputted, this default is used. */
6
6
  default?: boolean | null;
7
7
  }
@@ -9,4 +9,6 @@ export interface GuidedDocumentsGenerateBase {
9
9
  context?: Corti.GuidedDocumentContext[];
10
10
  /** When supplied, all facts and transcripts already attached to the referenced interaction are passed implicitly as input context. Facts with `isDiscarded: true` are not passed on. */
11
11
  interactionId?: string;
12
+ /** Key/value labels attached to the document. Used for filtering in the LIST /documents endpoint. */
13
+ labels?: Corti.GuidedLabel[];
12
14
  }
@@ -1,3 +1,4 @@
1
+ import type * as Corti from "../index.mjs";
1
2
  /**
2
3
  * A generated document that was not saved to the database.
3
4
  */
@@ -7,6 +8,10 @@ export interface GuidedEphemeralDocument {
7
8
  templateVersionId: string;
8
9
  /** The BCP 47 language tag of the generated output. */
9
10
  language: string;
11
+ /** The interaction whose context was used to generate this document, if supplied. */
12
+ interactionId?: string | null;
10
13
  stringDocument: Record<string, string>;
11
14
  structuredDocument?: Record<string, unknown> | null;
15
+ /** Key/value labels attached to this document. */
16
+ labels: Corti.GuidedLabel[];
12
17
  }
@@ -2,7 +2,10 @@ import type * as Corti from "../index.mjs";
2
2
  export interface GuidedFieldDefinition {
3
3
  /** Use to set a key to reference. */
4
4
  key: string;
5
- /** Can be used to prompt the LLM with more guidance in addition to the section.instructions */
5
+ /** Guide the LLM in what to output for this node. Supplements the section-level instructions. */
6
6
  description: string;
7
+ /** Must be another output schema node (string, number, boolean, array, or object). */
7
8
  value: Corti.GuidedOutputSchema;
9
+ /** If nothing is outputted for this field, this default value is used in the rendered output. */
10
+ default?: string | null;
8
11
  }