@corti/sdk 0.8.0 → 0.9.0-rc
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +1 -1
- package/dist/cjs/Client.js +2 -2
- package/dist/cjs/api/resources/facts/client/Client.d.ts +4 -4
- package/dist/cjs/api/resources/facts/client/Client.js +4 -4
- package/dist/cjs/api/resources/facts/client/requests/FactsBatchUpdateRequest.d.ts +1 -1
- package/dist/cjs/api/resources/facts/client/requests/FactsUpdateRequest.d.ts +1 -1
- package/dist/cjs/api/types/DocumentsCreateRequest.d.ts +1 -1
- package/dist/cjs/api/types/DocumentsCreateRequestWithTemplate.d.ts +1 -0
- package/dist/cjs/api/types/DocumentsCreateRequestWithTemplateKey.d.ts +1 -0
- package/dist/cjs/api/types/DocumentsSectionOverride.d.ts +17 -0
- package/dist/cjs/api/types/DocumentsSectionOverride.js +5 -0
- package/dist/cjs/api/types/DocumentsTemplate.d.ts +7 -1
- package/dist/cjs/api/types/DocumentsTemplateWithSections.d.ts +11 -0
- package/dist/cjs/api/types/DocumentsTemplateWithSections.js +5 -0
- package/dist/cjs/api/types/FactsBatchUpdateInput.d.ts +1 -2
- package/dist/cjs/api/types/FactsBatchUpdateItem.d.ts +1 -1
- package/dist/cjs/api/types/FactsContext.d.ts +1 -1
- package/dist/cjs/api/types/FactsCreateInput.d.ts +1 -1
- package/dist/cjs/api/types/FactsCreateItem.d.ts +2 -2
- package/dist/cjs/api/types/FactsListItem.d.ts +2 -2
- package/dist/cjs/api/types/FactsUpdateResponse.d.ts +1 -1
- package/dist/cjs/api/types/TemplatesDocumentationModeEnum.d.ts +11 -0
- package/dist/cjs/api/types/TemplatesDocumentationModeEnum.js +10 -0
- package/dist/cjs/api/types/TemplatesFormatRule.d.ts +7 -0
- package/dist/cjs/api/types/TemplatesFormatRule.js +5 -0
- package/dist/cjs/api/types/TemplatesItem.d.ts +9 -6
- package/dist/cjs/api/types/TemplatesSection.d.ts +17 -10
- package/dist/cjs/api/types/TemplatesSectionSorted.d.ts +3 -3
- package/dist/cjs/api/types/TemplatesSectionTranslation.d.ts +4 -4
- package/dist/cjs/api/types/TemplatesTranslation.d.ts +4 -4
- package/dist/cjs/api/types/TemplatesWritingStyle.d.ts +1 -1
- package/dist/cjs/api/types/TranscribeConfig.d.ts +2 -0
- package/dist/cjs/api/types/TranscribeFormatting.d.ts +18 -0
- package/dist/cjs/api/types/TranscribeFormatting.js +5 -0
- package/dist/cjs/api/types/TranscribeFormattingDates.d.ts +14 -0
- package/dist/cjs/api/types/TranscribeFormattingDates.js +13 -0
- package/dist/cjs/api/types/TranscribeFormattingMeasurements.d.ts +11 -0
- package/dist/cjs/api/types/TranscribeFormattingMeasurements.js +10 -0
- package/dist/cjs/api/types/TranscribeFormattingNumbers.d.ts +12 -0
- package/dist/cjs/api/types/TranscribeFormattingNumbers.js +11 -0
- package/dist/cjs/api/types/TranscribeFormattingNumericRanges.d.ts +11 -0
- package/dist/cjs/api/types/TranscribeFormattingNumericRanges.js +10 -0
- package/dist/cjs/api/types/TranscribeFormattingOrdinals.d.ts +11 -0
- package/dist/cjs/api/types/TranscribeFormattingOrdinals.js +10 -0
- package/dist/cjs/api/types/TranscribeFormattingTimes.d.ts +12 -0
- package/dist/cjs/api/types/TranscribeFormattingTimes.js +11 -0
- package/dist/cjs/api/types/index.d.ts +11 -0
- package/dist/cjs/api/types/index.js +11 -0
- package/dist/cjs/serialization/types/DocumentsCreateRequestWithTemplate.d.ts +2 -0
- package/dist/cjs/serialization/types/DocumentsCreateRequestWithTemplate.js +2 -0
- package/dist/cjs/serialization/types/DocumentsCreateRequestWithTemplateKey.d.ts +2 -0
- package/dist/cjs/serialization/types/DocumentsCreateRequestWithTemplateKey.js +2 -0
- package/dist/cjs/serialization/types/DocumentsSectionOverride.d.ts +17 -0
- package/dist/cjs/serialization/types/DocumentsSectionOverride.js +48 -0
- package/dist/cjs/serialization/types/DocumentsTemplate.d.ts +3 -2
- package/dist/cjs/serialization/types/DocumentsTemplate.js +36 -1
- package/dist/cjs/serialization/types/DocumentsTemplateWithSections.d.ts +15 -0
- package/dist/cjs/serialization/types/DocumentsTemplateWithSections.js +46 -0
- package/dist/cjs/serialization/types/FactsBatchUpdateInput.d.ts +1 -2
- package/dist/cjs/serialization/types/FactsBatchUpdateInput.js +1 -2
- package/dist/cjs/serialization/types/FactsBatchUpdateItem.d.ts +1 -1
- package/dist/cjs/serialization/types/FactsBatchUpdateItem.js +1 -1
- package/dist/cjs/serialization/types/FactsCreateItem.d.ts +1 -1
- package/dist/cjs/serialization/types/FactsCreateItem.js +1 -1
- package/dist/cjs/serialization/types/FactsListItem.d.ts +1 -1
- package/dist/cjs/serialization/types/FactsListItem.js +1 -1
- package/dist/cjs/serialization/types/FactsUpdateResponse.d.ts +1 -1
- package/dist/cjs/serialization/types/FactsUpdateResponse.js +1 -1
- package/dist/cjs/serialization/types/TemplatesDocumentationModeEnum.d.ts +10 -0
- package/dist/cjs/serialization/types/TemplatesDocumentationModeEnum.js +41 -0
- package/dist/cjs/serialization/types/TemplatesFormatRule.d.ts +12 -0
- package/dist/cjs/serialization/types/TemplatesFormatRule.js +43 -0
- package/dist/cjs/serialization/types/TemplatesItem.d.ts +5 -2
- package/dist/cjs/serialization/types/TemplatesItem.js +5 -2
- package/dist/cjs/serialization/types/TemplatesSection.d.ts +10 -4
- package/dist/cjs/serialization/types/TemplatesSection.js +10 -4
- package/dist/cjs/serialization/types/TemplatesSectionSorted.d.ts +1 -1
- package/dist/cjs/serialization/types/TemplatesSectionSorted.js +1 -1
- package/dist/cjs/serialization/types/TemplatesSectionTranslation.d.ts +1 -1
- package/dist/cjs/serialization/types/TemplatesSectionTranslation.js +1 -1
- package/dist/cjs/serialization/types/TemplatesTranslation.d.ts +1 -1
- package/dist/cjs/serialization/types/TemplatesTranslation.js +1 -1
- package/dist/cjs/serialization/types/TranscribeConfig.d.ts +2 -0
- package/dist/cjs/serialization/types/TranscribeConfig.js +2 -0
- package/dist/cjs/serialization/types/TranscribeFormatting.d.ts +23 -0
- package/dist/cjs/serialization/types/TranscribeFormatting.js +54 -0
- package/dist/cjs/serialization/types/TranscribeFormattingDates.d.ts +10 -0
- package/dist/cjs/serialization/types/TranscribeFormattingDates.js +41 -0
- package/dist/cjs/serialization/types/TranscribeFormattingMeasurements.d.ts +10 -0
- package/dist/cjs/serialization/types/TranscribeFormattingMeasurements.js +41 -0
- package/dist/cjs/serialization/types/TranscribeFormattingNumbers.d.ts +10 -0
- package/dist/cjs/serialization/types/TranscribeFormattingNumbers.js +41 -0
- package/dist/cjs/serialization/types/TranscribeFormattingNumericRanges.d.ts +10 -0
- package/dist/cjs/serialization/types/TranscribeFormattingNumericRanges.js +41 -0
- package/dist/cjs/serialization/types/TranscribeFormattingOrdinals.d.ts +10 -0
- package/dist/cjs/serialization/types/TranscribeFormattingOrdinals.js +41 -0
- package/dist/cjs/serialization/types/TranscribeFormattingTimes.d.ts +10 -0
- package/dist/cjs/serialization/types/TranscribeFormattingTimes.js +41 -0
- package/dist/cjs/serialization/types/index.d.ts +11 -0
- package/dist/cjs/serialization/types/index.js +11 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/Client.mjs +2 -2
- package/dist/esm/api/resources/facts/client/Client.d.mts +4 -4
- package/dist/esm/api/resources/facts/client/Client.mjs +4 -4
- package/dist/esm/api/resources/facts/client/requests/FactsBatchUpdateRequest.d.mts +1 -1
- package/dist/esm/api/resources/facts/client/requests/FactsUpdateRequest.d.mts +1 -1
- package/dist/esm/api/types/DocumentsCreateRequest.d.mts +1 -1
- package/dist/esm/api/types/DocumentsCreateRequestWithTemplate.d.mts +1 -0
- package/dist/esm/api/types/DocumentsCreateRequestWithTemplateKey.d.mts +1 -0
- package/dist/esm/api/types/DocumentsSectionOverride.d.mts +17 -0
- package/dist/esm/api/types/DocumentsSectionOverride.mjs +4 -0
- package/dist/esm/api/types/DocumentsTemplate.d.mts +7 -1
- package/dist/esm/api/types/DocumentsTemplateWithSections.d.mts +11 -0
- package/dist/esm/api/types/DocumentsTemplateWithSections.mjs +4 -0
- package/dist/esm/api/types/FactsBatchUpdateInput.d.mts +1 -2
- package/dist/esm/api/types/FactsBatchUpdateItem.d.mts +1 -1
- package/dist/esm/api/types/FactsContext.d.mts +1 -1
- package/dist/esm/api/types/FactsCreateInput.d.mts +1 -1
- package/dist/esm/api/types/FactsCreateItem.d.mts +2 -2
- package/dist/esm/api/types/FactsListItem.d.mts +2 -2
- package/dist/esm/api/types/FactsUpdateResponse.d.mts +1 -1
- package/dist/esm/api/types/TemplatesDocumentationModeEnum.d.mts +11 -0
- package/dist/esm/api/types/TemplatesDocumentationModeEnum.mjs +7 -0
- package/dist/esm/api/types/TemplatesFormatRule.d.mts +7 -0
- package/dist/esm/api/types/TemplatesFormatRule.mjs +4 -0
- package/dist/esm/api/types/TemplatesItem.d.mts +9 -6
- package/dist/esm/api/types/TemplatesSection.d.mts +17 -10
- package/dist/esm/api/types/TemplatesSectionSorted.d.mts +3 -3
- package/dist/esm/api/types/TemplatesSectionTranslation.d.mts +4 -4
- package/dist/esm/api/types/TemplatesTranslation.d.mts +4 -4
- package/dist/esm/api/types/TemplatesWritingStyle.d.mts +1 -1
- package/dist/esm/api/types/TranscribeConfig.d.mts +2 -0
- package/dist/esm/api/types/TranscribeFormatting.d.mts +18 -0
- package/dist/esm/api/types/TranscribeFormatting.mjs +4 -0
- package/dist/esm/api/types/TranscribeFormattingDates.d.mts +14 -0
- package/dist/esm/api/types/TranscribeFormattingDates.mjs +10 -0
- package/dist/esm/api/types/TranscribeFormattingMeasurements.d.mts +11 -0
- package/dist/esm/api/types/TranscribeFormattingMeasurements.mjs +7 -0
- package/dist/esm/api/types/TranscribeFormattingNumbers.d.mts +12 -0
- package/dist/esm/api/types/TranscribeFormattingNumbers.mjs +8 -0
- package/dist/esm/api/types/TranscribeFormattingNumericRanges.d.mts +11 -0
- package/dist/esm/api/types/TranscribeFormattingNumericRanges.mjs +7 -0
- package/dist/esm/api/types/TranscribeFormattingOrdinals.d.mts +11 -0
- package/dist/esm/api/types/TranscribeFormattingOrdinals.mjs +7 -0
- package/dist/esm/api/types/TranscribeFormattingTimes.d.mts +12 -0
- package/dist/esm/api/types/TranscribeFormattingTimes.mjs +8 -0
- package/dist/esm/api/types/index.d.mts +11 -0
- package/dist/esm/api/types/index.mjs +11 -0
- package/dist/esm/serialization/types/DocumentsCreateRequestWithTemplate.d.mts +2 -0
- package/dist/esm/serialization/types/DocumentsCreateRequestWithTemplate.mjs +2 -0
- package/dist/esm/serialization/types/DocumentsCreateRequestWithTemplateKey.d.mts +2 -0
- package/dist/esm/serialization/types/DocumentsCreateRequestWithTemplateKey.mjs +2 -0
- package/dist/esm/serialization/types/DocumentsSectionOverride.d.mts +17 -0
- package/dist/esm/serialization/types/DocumentsSectionOverride.mjs +12 -0
- package/dist/esm/serialization/types/DocumentsTemplate.d.mts +3 -2
- package/dist/esm/serialization/types/DocumentsTemplate.mjs +3 -1
- package/dist/esm/serialization/types/DocumentsTemplateWithSections.d.mts +15 -0
- package/dist/esm/serialization/types/DocumentsTemplateWithSections.mjs +10 -0
- package/dist/esm/serialization/types/FactsBatchUpdateInput.d.mts +1 -2
- package/dist/esm/serialization/types/FactsBatchUpdateInput.mjs +1 -2
- package/dist/esm/serialization/types/FactsBatchUpdateItem.d.mts +1 -1
- package/dist/esm/serialization/types/FactsBatchUpdateItem.mjs +1 -1
- package/dist/esm/serialization/types/FactsCreateItem.d.mts +1 -1
- package/dist/esm/serialization/types/FactsCreateItem.mjs +1 -1
- package/dist/esm/serialization/types/FactsListItem.d.mts +1 -1
- package/dist/esm/serialization/types/FactsListItem.mjs +1 -1
- package/dist/esm/serialization/types/FactsUpdateResponse.d.mts +1 -1
- package/dist/esm/serialization/types/FactsUpdateResponse.mjs +1 -1
- package/dist/esm/serialization/types/TemplatesDocumentationModeEnum.d.mts +10 -0
- package/dist/esm/serialization/types/TemplatesDocumentationModeEnum.mjs +5 -0
- package/dist/esm/serialization/types/TemplatesFormatRule.d.mts +12 -0
- package/dist/esm/serialization/types/TemplatesFormatRule.mjs +7 -0
- package/dist/esm/serialization/types/TemplatesItem.d.mts +5 -2
- package/dist/esm/serialization/types/TemplatesItem.mjs +5 -2
- package/dist/esm/serialization/types/TemplatesSection.d.mts +10 -4
- package/dist/esm/serialization/types/TemplatesSection.mjs +10 -4
- package/dist/esm/serialization/types/TemplatesSectionSorted.d.mts +1 -1
- package/dist/esm/serialization/types/TemplatesSectionSorted.mjs +1 -1
- package/dist/esm/serialization/types/TemplatesSectionTranslation.d.mts +1 -1
- package/dist/esm/serialization/types/TemplatesSectionTranslation.mjs +1 -1
- package/dist/esm/serialization/types/TemplatesTranslation.d.mts +1 -1
- package/dist/esm/serialization/types/TemplatesTranslation.mjs +1 -1
- package/dist/esm/serialization/types/TranscribeConfig.d.mts +2 -0
- package/dist/esm/serialization/types/TranscribeConfig.mjs +2 -0
- package/dist/esm/serialization/types/TranscribeFormatting.d.mts +23 -0
- package/dist/esm/serialization/types/TranscribeFormatting.mjs +18 -0
- package/dist/esm/serialization/types/TranscribeFormattingDates.d.mts +10 -0
- package/dist/esm/serialization/types/TranscribeFormattingDates.mjs +5 -0
- package/dist/esm/serialization/types/TranscribeFormattingMeasurements.d.mts +10 -0
- package/dist/esm/serialization/types/TranscribeFormattingMeasurements.mjs +5 -0
- package/dist/esm/serialization/types/TranscribeFormattingNumbers.d.mts +10 -0
- package/dist/esm/serialization/types/TranscribeFormattingNumbers.mjs +5 -0
- package/dist/esm/serialization/types/TranscribeFormattingNumericRanges.d.mts +10 -0
- package/dist/esm/serialization/types/TranscribeFormattingNumericRanges.mjs +5 -0
- package/dist/esm/serialization/types/TranscribeFormattingOrdinals.d.mts +10 -0
- package/dist/esm/serialization/types/TranscribeFormattingOrdinals.mjs +5 -0
- package/dist/esm/serialization/types/TranscribeFormattingTimes.d.mts +10 -0
- package/dist/esm/serialization/types/TranscribeFormattingTimes.mjs +5 -0
- package/dist/esm/serialization/types/index.d.mts +11 -0
- package/dist/esm/serialization/types/index.mjs +11 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
package/LICENSE
CHANGED
package/dist/cjs/Client.js
CHANGED
|
@@ -64,8 +64,8 @@ class CortiClient {
|
|
|
64
64
|
"Tenant-Name": _options === null || _options === void 0 ? void 0 : _options.tenantName,
|
|
65
65
|
"X-Fern-Language": "JavaScript",
|
|
66
66
|
"X-Fern-SDK-Name": "@corti/sdk",
|
|
67
|
-
"X-Fern-SDK-Version": "0.
|
|
68
|
-
"User-Agent": "@corti/sdk/0.
|
|
67
|
+
"X-Fern-SDK-Version": "0.9.0-rc",
|
|
68
|
+
"User-Agent": "@corti/sdk/0.9.0-rc",
|
|
69
69
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
70
70
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
71
71
|
}, _options === null || _options === void 0 ? void 0 : _options.headers) });
|
|
@@ -87,7 +87,7 @@ export declare class Facts {
|
|
|
87
87
|
* @example
|
|
88
88
|
* await client.facts.batchUpdate("f47ac10b-58cc-4372-a567-0e02b2c3d479", {
|
|
89
89
|
* facts: [{
|
|
90
|
-
* factId: "
|
|
90
|
+
* factId: "3c9d8a12-7f44-4b3e-9e6f-9271c2bbfa08"
|
|
91
91
|
* }]
|
|
92
92
|
* })
|
|
93
93
|
*/
|
|
@@ -97,16 +97,16 @@ export declare class Facts {
|
|
|
97
97
|
* Updates an existing fact associated with a specific interaction.
|
|
98
98
|
*
|
|
99
99
|
* @param {Corti.Uuid} id - The unique identifier of the interaction. Must be a valid UUID.
|
|
100
|
-
* @param {
|
|
100
|
+
* @param {string} factId - The unique identifier of the fact to update. Must be a valid UUID.
|
|
101
101
|
* @param {Corti.FactsUpdateRequest} request
|
|
102
102
|
* @param {Facts.RequestOptions} requestOptions - Request-specific configuration.
|
|
103
103
|
*
|
|
104
104
|
* @throws {@link Corti.GatewayTimeoutError}
|
|
105
105
|
*
|
|
106
106
|
* @example
|
|
107
|
-
* await client.facts.update("f47ac10b-58cc-4372-a567-0e02b2c3d479", "
|
|
107
|
+
* await client.facts.update("f47ac10b-58cc-4372-a567-0e02b2c3d479", "3c9d8a12-7f44-4b3e-9e6f-9271c2bbfa08")
|
|
108
108
|
*/
|
|
109
|
-
update(id: Corti.Uuid, factId:
|
|
109
|
+
update(id: Corti.Uuid, factId: string, request?: Corti.FactsUpdateRequest, requestOptions?: Facts.RequestOptions): core.HttpResponsePromise<Corti.FactsUpdateResponse>;
|
|
110
110
|
private __update;
|
|
111
111
|
/**
|
|
112
112
|
* Extract facts from provided text, without storing them.
|
|
@@ -303,7 +303,7 @@ class Facts {
|
|
|
303
303
|
* @example
|
|
304
304
|
* await client.facts.batchUpdate("f47ac10b-58cc-4372-a567-0e02b2c3d479", {
|
|
305
305
|
* facts: [{
|
|
306
|
-
* factId: "
|
|
306
|
+
* factId: "3c9d8a12-7f44-4b3e-9e6f-9271c2bbfa08"
|
|
307
307
|
* }]
|
|
308
308
|
* })
|
|
309
309
|
*/
|
|
@@ -381,14 +381,14 @@ class Facts {
|
|
|
381
381
|
* Updates an existing fact associated with a specific interaction.
|
|
382
382
|
*
|
|
383
383
|
* @param {Corti.Uuid} id - The unique identifier of the interaction. Must be a valid UUID.
|
|
384
|
-
* @param {
|
|
384
|
+
* @param {string} factId - The unique identifier of the fact to update. Must be a valid UUID.
|
|
385
385
|
* @param {Corti.FactsUpdateRequest} request
|
|
386
386
|
* @param {Facts.RequestOptions} requestOptions - Request-specific configuration.
|
|
387
387
|
*
|
|
388
388
|
* @throws {@link Corti.GatewayTimeoutError}
|
|
389
389
|
*
|
|
390
390
|
* @example
|
|
391
|
-
* await client.facts.update("f47ac10b-58cc-4372-a567-0e02b2c3d479", "
|
|
391
|
+
* await client.facts.update("f47ac10b-58cc-4372-a567-0e02b2c3d479", "3c9d8a12-7f44-4b3e-9e6f-9271c2bbfa08")
|
|
392
392
|
*/
|
|
393
393
|
update(id, factId, request = {}, requestOptions) {
|
|
394
394
|
return core.HttpResponsePromise.fromPromise(this.__update(id, factId, request, requestOptions));
|
|
@@ -397,7 +397,7 @@ class Facts {
|
|
|
397
397
|
return __awaiter(this, arguments, void 0, function* (id, factId, request = {}, requestOptions) {
|
|
398
398
|
var _a, _b;
|
|
399
399
|
const _response = yield core.fetcher({
|
|
400
|
-
url: core.url.join((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment)).base, `interactions/${encodeURIComponent(serializers.Uuid.jsonOrThrow(id, { omitUndefined: true }))}/facts/${encodeURIComponent(
|
|
400
|
+
url: core.url.join((_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment)).base, `interactions/${encodeURIComponent(serializers.Uuid.jsonOrThrow(id, { omitUndefined: true }))}/facts/${encodeURIComponent(factId)}`),
|
|
401
401
|
method: "PATCH",
|
|
402
402
|
headers: (0, headers_js_1.mergeHeaders)((_b = this._options) === null || _b === void 0 ? void 0 : _b.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
|
|
403
403
|
Authorization: yield this._getAuthorizationHeader(),
|
|
@@ -11,7 +11,7 @@ export interface FactsUpdateRequest {
|
|
|
11
11
|
text?: string;
|
|
12
12
|
/** The updated group key for the fact. */
|
|
13
13
|
group?: string;
|
|
14
|
-
/**
|
|
14
|
+
/** To track the updated source of the fact. Set to 'user' to indicate a change by an end-user. */
|
|
15
15
|
source?: Corti.CommonSourceEnum;
|
|
16
16
|
/** Set this to true if discarded by an end-user, then filter out from the document generation request. */
|
|
17
17
|
isDiscarded?: boolean;
|
|
@@ -7,5 +7,5 @@ export type DocumentsCreateRequest =
|
|
|
7
7
|
* Standard method for document generation: Use template key to generate document based on pre-defined template. */
|
|
8
8
|
Corti.DocumentsCreateRequestWithTemplateKey
|
|
9
9
|
/**
|
|
10
|
-
* Advanced method for document generation: Define
|
|
10
|
+
* Advanced method for document generation: Define Sections in the request to build a template dynamically. See a detailed example [here](/templates/documents-advanced#assemble-a-template-with-extra-instructions). */
|
|
11
11
|
| Corti.DocumentsCreateRequestWithTemplate;
|
|
@@ -13,4 +13,5 @@ export interface DocumentsCreateRequestWithTemplate {
|
|
|
13
13
|
outputLanguage: string;
|
|
14
14
|
/** Set to true to disable guardrails during document generation, default is false. */
|
|
15
15
|
disableGuardrails?: boolean;
|
|
16
|
+
documentationMode?: Corti.TemplatesDocumentationModeEnum;
|
|
16
17
|
}
|
|
@@ -13,4 +13,5 @@ export interface DocumentsCreateRequestWithTemplateKey {
|
|
|
13
13
|
outputLanguage: string;
|
|
14
14
|
/** Set to true to disable guardrails during document generation, default is false. */
|
|
15
15
|
disableGuardrails?: boolean;
|
|
16
|
+
documentationMode?: Corti.TemplatesDocumentationModeEnum;
|
|
16
17
|
}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
export interface DocumentsSectionOverride {
|
|
5
|
+
/** The key that references the section to use for document generation. */
|
|
6
|
+
key: string;
|
|
7
|
+
/** Overrides the section name used in document generation and response. */
|
|
8
|
+
nameOverride?: string;
|
|
9
|
+
/** Overrides the section's default writing style with your custom prompt. */
|
|
10
|
+
writingStyleOverride?: string;
|
|
11
|
+
/** Overrides the section's default format rule with your custom prompt. */
|
|
12
|
+
formatRuleOverride?: string;
|
|
13
|
+
/** Overrides and sets the section-level additional instructions with your custom prompt. */
|
|
14
|
+
additionalInstructionsOverride?: string;
|
|
15
|
+
/** Overrides the section's content prompt used for input assignment with documentationMode: routed_parallel, and section generation. */
|
|
16
|
+
contentOverride?: string;
|
|
17
|
+
}
|
|
@@ -2,4 +2,10 @@
|
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
*/
|
|
4
4
|
import * as Corti from "../index.js";
|
|
5
|
-
export type DocumentsTemplate =
|
|
5
|
+
export type DocumentsTemplate =
|
|
6
|
+
/**
|
|
7
|
+
* Flexible sections to be used in document generation. */
|
|
8
|
+
Corti.DocumentsTemplateWithSections
|
|
9
|
+
/**
|
|
10
|
+
* Section keys to be used in document generation, without overrides. */
|
|
11
|
+
| Corti.DocumentsTemplateWithSectionKeys;
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as Corti from "../index.js";
|
|
5
|
+
export interface DocumentsTemplateWithSections {
|
|
6
|
+
sections: Corti.DocumentsSectionOverride[];
|
|
7
|
+
/** A brief description of the document that can help give the LLM some context. */
|
|
8
|
+
description?: string;
|
|
9
|
+
/** Overrides and sets template-level additional instructions. */
|
|
10
|
+
additionalInstructionsOverride?: string;
|
|
11
|
+
}
|
|
@@ -1,10 +1,9 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
*/
|
|
4
|
-
import * as Corti from "../index.js";
|
|
5
4
|
export interface FactsBatchUpdateInput {
|
|
6
5
|
/** The unique identifier of the fact to be updated. */
|
|
7
|
-
factId:
|
|
6
|
+
factId: string;
|
|
8
7
|
/** Set this to true for facts discarded by an end-user, then filter those out from the document generation request. */
|
|
9
8
|
isDiscarded?: boolean;
|
|
10
9
|
/** The updated text content of the fact. */
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
import * as Corti from "../index.js";
|
|
5
5
|
export interface FactsBatchUpdateItem {
|
|
6
6
|
/** The unique identifier of the updated fact. */
|
|
7
|
-
id:
|
|
7
|
+
id: string;
|
|
8
8
|
/** The updated text content of the fact. */
|
|
9
9
|
text: string;
|
|
10
10
|
/** The updated group key to which the fact belongs. */
|
|
@@ -7,6 +7,6 @@ export interface FactsContext {
|
|
|
7
7
|
text: string;
|
|
8
8
|
/** The group to which the fact belongs. */
|
|
9
9
|
group?: string;
|
|
10
|
-
/**
|
|
10
|
+
/** Source 'core' indicates facts generated by the LLM, 'user' for facts added by the user, 'system' for system-derived facts (e.g. EHR). */
|
|
11
11
|
source: Corti.CommonSourceEnum;
|
|
12
12
|
}
|
|
@@ -7,6 +7,6 @@ export interface FactsCreateInput {
|
|
|
7
7
|
text: string;
|
|
8
8
|
/** The key identifying the group to which the fact belongs. */
|
|
9
9
|
group: string;
|
|
10
|
-
/**
|
|
10
|
+
/** To track the source of a fact. Set 'user' for an end-user, 'system' for EHR-derived facts. 'core' is used for facts generated by the LLM. */
|
|
11
11
|
source?: Corti.CommonSourceEnum;
|
|
12
12
|
}
|
|
@@ -4,14 +4,14 @@
|
|
|
4
4
|
import * as Corti from "../index.js";
|
|
5
5
|
export interface FactsCreateItem {
|
|
6
6
|
/** The unique identifier of the newly created fact. */
|
|
7
|
-
id?:
|
|
7
|
+
id?: string;
|
|
8
8
|
/** The textual content of the created fact. */
|
|
9
9
|
text?: string;
|
|
10
10
|
/** The group key categorizing the fact. */
|
|
11
11
|
group?: string;
|
|
12
12
|
/** The unique identifier of the group to which the fact belongs. */
|
|
13
13
|
groupId?: Corti.Uuid;
|
|
14
|
-
/**
|
|
14
|
+
/** To track the source of a fact. Set 'user' for an end-user, 'system' for EHR-derived facts. 'core' is used for facts generated by the LLM. */
|
|
15
15
|
source?: Corti.CommonSourceEnum;
|
|
16
16
|
/** Indicates whether the fact has been marked as discarded by an end-user. */
|
|
17
17
|
isDiscarded?: boolean;
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
import * as Corti from "../index.js";
|
|
5
5
|
export interface FactsListItem {
|
|
6
6
|
/** The unique identifier of the fact. */
|
|
7
|
-
id?:
|
|
7
|
+
id?: string;
|
|
8
8
|
/** The text content of the fact. */
|
|
9
9
|
text?: string;
|
|
10
10
|
/** The key identifying the group to which the fact belongs. */
|
|
@@ -13,7 +13,7 @@ export interface FactsListItem {
|
|
|
13
13
|
groupId?: Corti.Uuid;
|
|
14
14
|
/** Indicates whether the fact has been marked as discarded by an end-user. */
|
|
15
15
|
isDiscarded?: boolean;
|
|
16
|
-
/**
|
|
16
|
+
/** Source 'core' indicates facts generated by the LLM, 'user' for facts added by the user, 'system' for system-derived facts (e.g. EHR). */
|
|
17
17
|
source?: Corti.CommonSourceEnum;
|
|
18
18
|
/** The timestamp when the fact was created. */
|
|
19
19
|
createdAt?: Date;
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
import * as Corti from "../index.js";
|
|
5
5
|
export interface FactsUpdateResponse {
|
|
6
6
|
/** The unique identifier of the fact. */
|
|
7
|
-
id:
|
|
7
|
+
id: string;
|
|
8
8
|
/** The updated text content of the fact. */
|
|
9
9
|
text: string;
|
|
10
10
|
/** The updated group key to which the fact belongs. */
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* Configures the approach and underlying system prompt that govern how the LLM generates documentation.
|
|
6
|
+
*/
|
|
7
|
+
export type TemplatesDocumentationModeEnum = "global_sequential" | "routed_parallel";
|
|
8
|
+
export declare const TemplatesDocumentationModeEnum: {
|
|
9
|
+
readonly GlobalSequential: "global_sequential";
|
|
10
|
+
readonly RoutedParallel: "routed_parallel";
|
|
11
|
+
};
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
4
|
+
*/
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.TemplatesDocumentationModeEnum = void 0;
|
|
7
|
+
exports.TemplatesDocumentationModeEnum = {
|
|
8
|
+
GlobalSequential: "global_sequential",
|
|
9
|
+
RoutedParallel: "routed_parallel",
|
|
10
|
+
};
|
|
@@ -4,17 +4,20 @@
|
|
|
4
4
|
import * as Corti from "../index.js";
|
|
5
5
|
export interface TemplatesItem {
|
|
6
6
|
/** The timestamp when the template was updated. */
|
|
7
|
-
|
|
8
|
-
/** Name of the template */
|
|
7
|
+
updatedAt?: Date | null;
|
|
8
|
+
/** Name of the template. */
|
|
9
9
|
name: string;
|
|
10
|
-
/** Description of the template */
|
|
10
|
+
/** Description of the template. */
|
|
11
11
|
description: string;
|
|
12
|
-
/**
|
|
12
|
+
/** Instructions or context for all template sections. */
|
|
13
|
+
additionalInstructions?: string | null;
|
|
14
|
+
/** Unique key for the template. */
|
|
13
15
|
key: string;
|
|
14
16
|
/** Status of the template. */
|
|
15
17
|
status: string;
|
|
16
|
-
|
|
18
|
+
documentationMode?: Corti.TemplatesDocumentationModeEnum;
|
|
19
|
+
/** List of sections included in the template. */
|
|
17
20
|
templateSections: Corti.TemplatesSectionSorted[];
|
|
18
|
-
/** Available translations for the template */
|
|
21
|
+
/** Available translations for the template. */
|
|
19
22
|
translations: Corti.TemplatesTranslation[];
|
|
20
23
|
}
|
|
@@ -4,19 +4,26 @@
|
|
|
4
4
|
import * as Corti from "../index.js";
|
|
5
5
|
export interface TemplatesSection {
|
|
6
6
|
/** The timestamp when the section was updated. */
|
|
7
|
-
|
|
8
|
-
/** Name of the section */
|
|
7
|
+
updatedAt?: Date | null;
|
|
8
|
+
/** Name of the section. */
|
|
9
9
|
name: string;
|
|
10
|
-
/** Alternate
|
|
11
|
-
|
|
12
|
-
/** Unique key for the section */
|
|
10
|
+
/** Alternate name for the section. Not used by LLM response. */
|
|
11
|
+
alternateName?: string;
|
|
12
|
+
/** Unique key for the section. */
|
|
13
13
|
key: string;
|
|
14
|
-
/** Description of the section */
|
|
14
|
+
/** Description of the section. */
|
|
15
15
|
description: string;
|
|
16
|
-
/** Default writing style for the section */
|
|
16
|
+
/** Default writing style for the section. */
|
|
17
17
|
defaultWritingStyle: Corti.TemplatesWritingStyle;
|
|
18
|
-
/**
|
|
19
|
-
|
|
20
|
-
/**
|
|
18
|
+
/** Default format rule for the section. */
|
|
19
|
+
defaultFormatRule?: Corti.TemplatesFormatRule;
|
|
20
|
+
/** Additional instructions or context for the section. */
|
|
21
|
+
additionalInstructions?: string;
|
|
22
|
+
/** Used to guide input assignment in documentationMode: routed_parallel, and for section generation. */
|
|
23
|
+
content?: string;
|
|
24
|
+
documentationMode?: Corti.TemplatesDocumentationModeEnum;
|
|
25
|
+
/** Type of section. */
|
|
26
|
+
type: string;
|
|
27
|
+
/** Available translations for the section. */
|
|
21
28
|
translations: Corti.TemplatesSectionTranslation[];
|
|
22
29
|
}
|
|
@@ -3,8 +3,8 @@
|
|
|
3
3
|
*/
|
|
4
4
|
import * as Corti from "../index.js";
|
|
5
5
|
export interface TemplatesSectionSorted {
|
|
6
|
-
/** Sort order of the section within the template */
|
|
6
|
+
/** Sort order of the section within the template. */
|
|
7
7
|
sort: number;
|
|
8
|
-
/** The section details */
|
|
9
|
-
|
|
8
|
+
/** The section details. */
|
|
9
|
+
section: Corti.TemplatesSection;
|
|
10
10
|
}
|
|
@@ -2,10 +2,10 @@
|
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
*/
|
|
4
4
|
export interface TemplatesSectionTranslation {
|
|
5
|
-
/** Language
|
|
6
|
-
|
|
7
|
-
/** Localized name */
|
|
5
|
+
/** Language code. */
|
|
6
|
+
languageId: string;
|
|
7
|
+
/** Localized name. */
|
|
8
8
|
name?: string | null;
|
|
9
|
-
/** Localized description */
|
|
9
|
+
/** Localized description. */
|
|
10
10
|
description?: string | null;
|
|
11
11
|
}
|
|
@@ -2,10 +2,10 @@
|
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
*/
|
|
4
4
|
export interface TemplatesTranslation {
|
|
5
|
-
/** Language
|
|
6
|
-
|
|
7
|
-
/** Localized name */
|
|
5
|
+
/** Language code. */
|
|
6
|
+
languageId: string;
|
|
7
|
+
/** Localized name. */
|
|
8
8
|
name?: string;
|
|
9
|
-
/** Localized description */
|
|
9
|
+
/** Localized description. */
|
|
10
10
|
description?: string;
|
|
11
11
|
}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as Corti from "../index.js";
|
|
5
|
+
export interface TranscribeFormatting {
|
|
6
|
+
/** Formatting for dates. */
|
|
7
|
+
dates?: Corti.TranscribeFormattingDates;
|
|
8
|
+
/** Formatting for times. */
|
|
9
|
+
times?: Corti.TranscribeFormattingTimes;
|
|
10
|
+
/** Formatting for numbers. */
|
|
11
|
+
numbers?: Corti.TranscribeFormattingNumbers;
|
|
12
|
+
/** Formatting for measurements. */
|
|
13
|
+
measurements?: Corti.TranscribeFormattingMeasurements;
|
|
14
|
+
/** Formatting for numeric ranges. */
|
|
15
|
+
numericRanges?: Corti.TranscribeFormattingNumericRanges;
|
|
16
|
+
/** Formatting for ordinals. */
|
|
17
|
+
ordinals?: Corti.TranscribeFormattingOrdinals;
|
|
18
|
+
}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* Formatting for dates.
|
|
6
|
+
*/
|
|
7
|
+
export type TranscribeFormattingDates = "as_dictated" | "eu_slash" | "iso_compact" | "long_text" | "us_slash";
|
|
8
|
+
export declare const TranscribeFormattingDates: {
|
|
9
|
+
readonly AsDictated: "as_dictated";
|
|
10
|
+
readonly EuSlash: "eu_slash";
|
|
11
|
+
readonly IsoCompact: "iso_compact";
|
|
12
|
+
readonly LongText: "long_text";
|
|
13
|
+
readonly UsSlash: "us_slash";
|
|
14
|
+
};
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
4
|
+
*/
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.TranscribeFormattingDates = void 0;
|
|
7
|
+
exports.TranscribeFormattingDates = {
|
|
8
|
+
AsDictated: "as_dictated",
|
|
9
|
+
EuSlash: "eu_slash",
|
|
10
|
+
IsoCompact: "iso_compact",
|
|
11
|
+
LongText: "long_text",
|
|
12
|
+
UsSlash: "us_slash",
|
|
13
|
+
};
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* Formatting for measurements.
|
|
6
|
+
*/
|
|
7
|
+
export type TranscribeFormattingMeasurements = "abbreviated" | "as_dictated";
|
|
8
|
+
export declare const TranscribeFormattingMeasurements: {
|
|
9
|
+
readonly Abbreviated: "abbreviated";
|
|
10
|
+
readonly AsDictated: "as_dictated";
|
|
11
|
+
};
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
4
|
+
*/
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.TranscribeFormattingMeasurements = void 0;
|
|
7
|
+
exports.TranscribeFormattingMeasurements = {
|
|
8
|
+
Abbreviated: "abbreviated",
|
|
9
|
+
AsDictated: "as_dictated",
|
|
10
|
+
};
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* Formatting for numbers.
|
|
6
|
+
*/
|
|
7
|
+
export type TranscribeFormattingNumbers = "as_dictated" | "numerals" | "numerals_above_nine";
|
|
8
|
+
export declare const TranscribeFormattingNumbers: {
|
|
9
|
+
readonly AsDictated: "as_dictated";
|
|
10
|
+
readonly Numerals: "numerals";
|
|
11
|
+
readonly NumeralsAboveNine: "numerals_above_nine";
|
|
12
|
+
};
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
4
|
+
*/
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.TranscribeFormattingNumbers = void 0;
|
|
7
|
+
exports.TranscribeFormattingNumbers = {
|
|
8
|
+
AsDictated: "as_dictated",
|
|
9
|
+
Numerals: "numerals",
|
|
10
|
+
NumeralsAboveNine: "numerals_above_nine",
|
|
11
|
+
};
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* Formatting for numeric ranges.
|
|
6
|
+
*/
|
|
7
|
+
export type TranscribeFormattingNumericRanges = "as_dictated" | "numerals";
|
|
8
|
+
export declare const TranscribeFormattingNumericRanges: {
|
|
9
|
+
readonly AsDictated: "as_dictated";
|
|
10
|
+
readonly Numerals: "numerals";
|
|
11
|
+
};
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
4
|
+
*/
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.TranscribeFormattingNumericRanges = void 0;
|
|
7
|
+
exports.TranscribeFormattingNumericRanges = {
|
|
8
|
+
AsDictated: "as_dictated",
|
|
9
|
+
Numerals: "numerals",
|
|
10
|
+
};
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* Formatting for ordinals.
|
|
6
|
+
*/
|
|
7
|
+
export type TranscribeFormattingOrdinals = "as_dictated" | "numerals";
|
|
8
|
+
export declare const TranscribeFormattingOrdinals: {
|
|
9
|
+
readonly AsDictated: "as_dictated";
|
|
10
|
+
readonly Numerals: "numerals";
|
|
11
|
+
};
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
4
|
+
*/
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.TranscribeFormattingOrdinals = void 0;
|
|
7
|
+
exports.TranscribeFormattingOrdinals = {
|
|
8
|
+
AsDictated: "as_dictated",
|
|
9
|
+
Numerals: "numerals",
|
|
10
|
+
};
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* Formatting for times.
|
|
6
|
+
*/
|
|
7
|
+
export type TranscribeFormattingTimes = "as_dictated" | "h12" | "h24";
|
|
8
|
+
export declare const TranscribeFormattingTimes: {
|
|
9
|
+
readonly AsDictated: "as_dictated";
|
|
10
|
+
readonly H12: "h12";
|
|
11
|
+
readonly H24: "h24";
|
|
12
|
+
};
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
4
|
+
*/
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.TranscribeFormattingTimes = void 0;
|
|
7
|
+
exports.TranscribeFormattingTimes = {
|
|
8
|
+
AsDictated: "as_dictated",
|
|
9
|
+
H12: "h12",
|
|
10
|
+
H24: "h24",
|
|
11
|
+
};
|