@corti/sdk 4.0.0-rc → 4.0.0-rc.2

package/dist/cjs/serialization/types/index.d.ts

@@ -141,9 +141,10 @@ export * from "./GuidedSectionGenerationPartial.js";
 export * from "./GuidedSectionInstructions.js";
 export * from "./GuidedSectionInstructionsOverride.js";
 export * from "./GuidedSectionInstructionsPartial.js";
+export * from "./GuidedSectionListItem.js";
+export * from "./GuidedSectionListItemSource.js";
 export * from "./GuidedSectionOverride.js";
 export * from "./GuidedSectionOverrides.js";
-export * from "./GuidedSectionSource.js";
 export * from "./GuidedSectionsCreateBase.js";
 export * from "./GuidedSectionsCreateFromInheritanceRequest.js";
 export * from "./GuidedSectionsCreateFromScratchRequest.js";
@@ -157,9 +158,10 @@ export * from "./GuidedTemplate.js";
 export * from "./GuidedTemplateGeneration.js";
 export * from "./GuidedTemplateInstructions.js";
 export * from "./GuidedTemplateInstructionsPartial.js";
+export * from "./GuidedTemplateListItem.js";
+export * from "./GuidedTemplateListItemSource.js";
 export * from "./GuidedTemplateOverrides.js";
 export * from "./GuidedTemplateRef.js";
-export * from "./GuidedTemplateSource.js";
 export * from "./GuidedTemplatesCreateBase.js";
 export * from "./GuidedTemplatesCreateFromInheritanceRequest.js";
 export * from "./GuidedTemplatesCreateFromInheritanceRequestGeneration.js";
@@ -190,12 +192,15 @@ export * from "./StreamAudioEventDataEvent.js";
 export * from "./StreamAudioEventMessage.js";
 export * from "./StreamAudioEventsConfig.js";
 export * from "./StreamConfig.js";
+export * from "./StreamConfigKeyterms.js";
+export * from "./StreamConfigKeytermsTermsItem.js";
 export * from "./StreamConfigMessage.js";
 export * from "./StreamConfigMode.js";
 export * from "./StreamConfigModeFactGenerationInterval.js";
 export * from "./StreamConfigModeType.js";
 export * from "./StreamConfigParticipant.js";
 export * from "./StreamConfigParticipantRole.js";
+export * from "./StreamConfigReplacementsItem.js";
 export * from "./StreamConfigRetentionPolicy.js";
 export * from "./StreamConfigStatusMessage.js";
 export * from "./StreamConfigStatusMessageType.js";
@@ -235,6 +240,8 @@ export * from "./TranscribeCommandMessage.js";
 export * from "./TranscribeCommandVariable.js";
 export * from "./TranscribeCommandVariableType.js";
 export * from "./TranscribeConfig.js";
+export * from "./TranscribeConfigKeyterms.js";
+export * from "./TranscribeConfigKeytermsTermsItem.js";
 export * from "./TranscribeConfigMessage.js";
 export * from "./TranscribeConfigReplacementsItem.js";
 export * from "./TranscribeConfigStatusMessage.js";

package/dist/cjs/serialization/types/index.js

@@ -157,9 +157,10 @@ __exportStar(require("./GuidedSectionGenerationPartial.js"), exports);
 __exportStar(require("./GuidedSectionInstructions.js"), exports);
 __exportStar(require("./GuidedSectionInstructionsOverride.js"), exports);
 __exportStar(require("./GuidedSectionInstructionsPartial.js"), exports);
+__exportStar(require("./GuidedSectionListItem.js"), exports);
+__exportStar(require("./GuidedSectionListItemSource.js"), exports);
 __exportStar(require("./GuidedSectionOverride.js"), exports);
 __exportStar(require("./GuidedSectionOverrides.js"), exports);
-__exportStar(require("./GuidedSectionSource.js"), exports);
 __exportStar(require("./GuidedSectionsCreateBase.js"), exports);
 __exportStar(require("./GuidedSectionsCreateFromInheritanceRequest.js"), exports);
 __exportStar(require("./GuidedSectionsCreateFromScratchRequest.js"), exports);
@@ -173,9 +174,10 @@ __exportStar(require("./GuidedTemplate.js"), exports);
 __exportStar(require("./GuidedTemplateGeneration.js"), exports);
 __exportStar(require("./GuidedTemplateInstructions.js"), exports);
 __exportStar(require("./GuidedTemplateInstructionsPartial.js"), exports);
+__exportStar(require("./GuidedTemplateListItem.js"), exports);
+__exportStar(require("./GuidedTemplateListItemSource.js"), exports);
 __exportStar(require("./GuidedTemplateOverrides.js"), exports);
 __exportStar(require("./GuidedTemplateRef.js"), exports);
-__exportStar(require("./GuidedTemplateSource.js"), exports);
 __exportStar(require("./GuidedTemplatesCreateBase.js"), exports);
 __exportStar(require("./GuidedTemplatesCreateFromInheritanceRequest.js"), exports);
 __exportStar(require("./GuidedTemplatesCreateFromInheritanceRequestGeneration.js"), exports);
@@ -206,12 +208,15 @@ __exportStar(require("./StreamAudioEventDataEvent.js"), exports);
 __exportStar(require("./StreamAudioEventMessage.js"), exports);
 __exportStar(require("./StreamAudioEventsConfig.js"), exports);
 __exportStar(require("./StreamConfig.js"), exports);
+__exportStar(require("./StreamConfigKeyterms.js"), exports);
+__exportStar(require("./StreamConfigKeytermsTermsItem.js"), exports);
 __exportStar(require("./StreamConfigMessage.js"), exports);
 __exportStar(require("./StreamConfigMode.js"), exports);
 __exportStar(require("./StreamConfigModeFactGenerationInterval.js"), exports);
 __exportStar(require("./StreamConfigModeType.js"), exports);
 __exportStar(require("./StreamConfigParticipant.js"), exports);
 __exportStar(require("./StreamConfigParticipantRole.js"), exports);
+__exportStar(require("./StreamConfigReplacementsItem.js"), exports);
 __exportStar(require("./StreamConfigRetentionPolicy.js"), exports);
 __exportStar(require("./StreamConfigStatusMessage.js"), exports);
 __exportStar(require("./StreamConfigStatusMessageType.js"), exports);
@@ -251,6 +256,8 @@ __exportStar(require("./TranscribeCommandMessage.js"), exports);
 __exportStar(require("./TranscribeCommandVariable.js"), exports);
 __exportStar(require("./TranscribeCommandVariableType.js"), exports);
 __exportStar(require("./TranscribeConfig.js"), exports);
+__exportStar(require("./TranscribeConfigKeyterms.js"), exports);
+__exportStar(require("./TranscribeConfigKeytermsTermsItem.js"), exports);
 __exportStar(require("./TranscribeConfigMessage.js"), exports);
 __exportStar(require("./TranscribeConfigReplacementsItem.js"), exports);
 __exportStar(require("./TranscribeConfigStatusMessage.js"), exports);

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "4.0.0-rc";
+export declare const SDK_VERSION = "4.0.0-rc.2";

package/dist/cjs/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "4.0.0-rc";
+exports.SDK_VERSION = "4.0.0-rc.2";

package/dist/esm/BaseClient.mjs

@@ -6,8 +6,8 @@ export function normalizeClientOptions(options) {
     const headers = mergeHeaders({
         "X-Fern-Language": "JavaScript",
         "X-Fern-SDK-Name": "@corti/sdk",
-        "X-Fern-SDK-Version": "4.0.0-rc",
-        "User-Agent": "@corti/sdk/4.0.0-rc",
+        "X-Fern-SDK-Version": "4.0.0-rc.2",
+        "User-Agent": "@corti/sdk/4.0.0-rc.2",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
         "Tenant-Name": options === null || options === void 0 ? void 0 : options.tenantName,

package/dist/esm/api/resources/documents/resources/sections/client/Client.d.mts

@@ -23,7 +23,7 @@ export declare class SectionsClient {
      * @example
      *     await client.documents.sections.list()
      */
-    list(request?: Corti.documents.GuidedSectionsListRequest, requestOptions?: SectionsClient.RequestOptions): core.HttpResponsePromise<Corti.GuidedSection[]>;
+    list(request?: Corti.documents.GuidedSectionsListRequest, requestOptions?: SectionsClient.RequestOptions): core.HttpResponsePromise<Corti.GuidedSectionListItem[]>;
     private __list;
     /**
      * Creates a new section with an initial version. When `publish` is true (default),
@@ -38,15 +38,7 @@ export declare class SectionsClient {
      * @example
      *     await client.documents.sections.create({
      *         name: "name",
-     *         generation: {
-     *             heading: "heading",
-     *             instructions: {
-     *                 contentPrompt: "contentPrompt"
-     *             },
-     *             outputSchema: {
-     *                 type: "string"
-     *             }
-     *         }
+     *         inheritFromId: "inheritFromId"
      *     })
      */
     create(request: Corti.GuidedSectionsCreateRequest, requestOptions?: SectionsClient.RequestOptions): core.HttpResponsePromise<Corti.GuidedSection>;

package/dist/esm/api/resources/documents/resources/sections/client/Client.mjs

@@ -102,15 +102,7 @@ export class SectionsClient {
      * @example
      *     await client.documents.sections.create({
      *         name: "name",
-     *         generation: {
-     *             heading: "heading",
-     *             instructions: {
-     *                 contentPrompt: "contentPrompt"
-     *             },
-     *             outputSchema: {
-     *                 type: "string"
-     *             }
-     *         }
+     *         inheritFromId: "inheritFromId"
      *     })
      */
     create(request, requestOptions) {

package/dist/esm/api/resources/documents/resources/templates/client/Client.d.mts

@@ -23,7 +23,7 @@ export declare class TemplatesClient {
      * @example
      *     await client.documents.templates.list()
      */
-    list(request?: Corti.documents.GuidedTemplatesListRequest, requestOptions?: TemplatesClient.RequestOptions): core.HttpResponsePromise<Corti.GuidedTemplate[]>;
+    list(request?: Corti.documents.GuidedTemplatesListRequest, requestOptions?: TemplatesClient.RequestOptions): core.HttpResponsePromise<Corti.GuidedTemplateListItem[]>;
     private __list;
     /**
      * Creates a new template with an initial version. When `publish` is true (default),
@@ -38,11 +38,7 @@ export declare class TemplatesClient {
      * @example
      *     await client.documents.templates.create({
      *         name: "name",
-     *         generation: {
-     *             instructions: {
-     *                 prompt: "prompt"
-     *             }
-     *         }
+     *         inheritFromId: "inheritFromId"
      *     })
      */
     create(request: Corti.GuidedTemplatesCreateRequest, requestOptions?: TemplatesClient.RequestOptions): core.HttpResponsePromise<Corti.GuidedTemplate>;

package/dist/esm/api/resources/documents/resources/templates/client/Client.mjs

@@ -102,11 +102,7 @@ export class TemplatesClient {
      * @example
      *     await client.documents.templates.create({
      *         name: "name",
-     *         generation: {
-     *             instructions: {
-     *                 prompt: "prompt"
-     *             }
-     *         }
+     *         inheritFromId: "inheritFromId"
      *     })
      */
     create(request, requestOptions) {

package/dist/esm/api/resources/index.d.mts

@@ -22,3 +22,4 @@ export * as templates from "./templates/index.mjs";
 export * as transcribe from "./transcribe/index.mjs";
 export * from "./transcripts/client/requests/index.mjs";
 export * as transcripts from "./transcripts/index.mjs";
+export * from "./transcripts/types/index.mjs";

package/dist/esm/api/resources/index.mjs

@@ -22,3 +22,4 @@ export * as templates from "./templates/index.mjs";
 export * as transcribe from "./transcribe/index.mjs";
 export * from "./transcripts/client/requests/index.mjs";
 export * as transcripts from "./transcripts/index.mjs";
+export * from "./transcripts/types/index.mjs";

package/dist/esm/api/resources/recordings/client/Client.d.mts

@@ -27,7 +27,7 @@ export declare class RecordingsClient {
     list(id: Corti.Uuid, requestOptions?: RecordingsClient.RequestOptions): core.HttpResponsePromise<Corti.RecordingsListResponse>;
     private __list;
     /**
-     * Upload a recording for a given interaction. There is a maximum limit of 60 minutes in length and 150MB in size for recordings.
+     * Upload a recording for a given interaction. There is a maximum limit of 120 minutes in audio duration and 150 MB in file size.
      *
      * @param {core.file.Uploadable} uploadable
      * @param {Corti.Uuid} id

package/dist/esm/api/resources/recordings/client/Client.mjs

@@ -98,7 +98,7 @@ export class RecordingsClient {
         });
     }
     /**
-     * Upload a recording for a given interaction. There is a maximum limit of 60 minutes in length and 150MB in size for recordings.
+     * Upload a recording for a given interaction. There is a maximum limit of 120 minutes in audio duration and 150 MB in file size.
      *
      * @param {core.file.Uploadable} uploadable
      * @param {Corti.Uuid} id

package/dist/esm/api/resources/transcripts/client/Client.d.mts

@@ -29,7 +29,7 @@ export declare class TranscriptsClient {
     list(id: Corti.Uuid, request?: Corti.TranscriptsListRequest, requestOptions?: TranscriptsClient.RequestOptions): core.HttpResponsePromise<Corti.TranscriptsListResponse>;
     private __list;
     /**
-     * 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>
+     * 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 120 minutes in total audio duration and  150 MB in 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>
      *
      * @param {Corti.Uuid} id - The unique identifier of the interaction. Must be a valid UUID.
      * @param {Corti.TranscriptsCreateRequest} request

package/dist/esm/api/resources/transcripts/client/Client.mjs

@@ -106,7 +106,7 @@ export class TranscriptsClient {
         });
     }
     /**
-     * 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>
+     * 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 120 minutes in total audio duration and  150 MB in 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>
      *
      * @param {Corti.Uuid} id - The unique identifier of the interaction. Must be a valid UUID.
      * @param {Corti.TranscriptsCreateRequest} request

package/dist/esm/api/resources/transcripts/client/requests/TranscriptsCreateRequest.d.mts

@@ -11,7 +11,11 @@ export interface TranscriptsCreateRequest {
     recordingId: Corti.Uuid;
     /** The primary spoken language of the recording. Check https://docs.corti.ai/stt/languages for more. */
     primaryLanguage: string;
-    /** If true, spoken punctuation will be converted to symbols (e.g., 'comma' → ','). */
+    /** When true, converts spoken punctuation such as 'period' or 'slash' into symbols (e.g., '.', '/'). When enabled, automatic punctuation is turned off. Takes precedence over `automaticPunctuation` when both are enabled. */
+    spokenPunctuation?: boolean;
+    /** When true, automatically punctuates and capitalizes the transcript. Defaults to true. Overridden by `spokenPunctuation` when both are enabled. */
+    automaticPunctuation?: boolean;
+    /** **Deprecated** — replaced by `spokenPunctuation` and `automaticPunctuation`. Ignored when either of those fields is provided. When `true` and neither new field is provided, it is treated as `spokenPunctuation: true` (automatic punctuation off). No removal date is currently planned. */
     isDictation?: boolean;
     /** If true, each audio channel is transcribed separately. */
     isMultichannel?: boolean;
@@ -21,4 +25,8 @@ export interface TranscriptsCreateRequest {
     participants?: Corti.TranscriptsParticipant[];
     /** 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`. */
     async?: boolean;
+    /** Define replacements to have terms (single words or multi-word phrases) replaced in final text output with your preferred style. For example, replace "BID" with "twice daily". Configuration is case insensitive and limited to 1,000 replacements per stream. */
+    replacements?: Corti.TranscriptsCreateRequestReplacementsItem[];
+    /** Define words, terms, and phrases to be recognized by Corti speech-to-text. Especially useful for proper nouns (e.g., surnames), but also supportive of words not being recognized consistently. */
+    keyterms?: Corti.TranscriptsCreateRequestKeyterms;
 }

package/dist/esm/api/resources/transcripts/index.d.mts

@@ -1 +1,2 @@
 export * from "./client/index.mjs";
+export * from "./types/index.mjs";

package/dist/esm/api/resources/transcripts/index.mjs

@@ -1 +1,2 @@
 export * from "./client/index.mjs";
+export * from "./types/index.mjs";

package/dist/esm/api/resources/transcripts/types/TranscriptsCreateRequestKeyterms.d.mts

@@ -0,0 +1,8 @@
+import type * as Corti from "../../../index.mjs";
+/**
+ * Define words, terms, and phrases to be recognized by Corti speech-to-text. Especially useful for proper nouns (e.g., surnames), but also supportive of words not being recognized consistently.
+ */
+export interface TranscriptsCreateRequestKeyterms {
+    /** Ordered list of words to be recognized. Configuration is case sensitive and limited to 1,000 key terms per stream. */
+    terms?: Corti.TranscriptsCreateRequestKeytermsTermsItem[];
+}

package/dist/esm/api/resources/transcripts/types/TranscriptsCreateRequestKeyterms.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/transcripts/types/TranscriptsCreateRequestKeytermsTermsItem.d.mts

@@ -0,0 +1,4 @@
+export interface TranscriptsCreateRequestKeytermsTermsItem {
+    /** The word to be recognized, defined in its expected written form. A defined `term` is limited to a length of 50 characters. */
+    term: string;
+}

package/dist/esm/api/resources/transcripts/types/TranscriptsCreateRequestKeytermsTermsItem.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/transcripts/types/TranscriptsCreateRequestReplacementsItem.d.mts

@@ -0,0 +1,6 @@
+export interface TranscriptsCreateRequestReplacementsItem {
+    /** The term to be replaced, such as "BID". */
+    find: string;
+    /** The preferred replacement for the term, such as "twice daily". */
+    replace: string;
+}

package/dist/esm/api/resources/transcripts/types/TranscriptsCreateRequestReplacementsItem.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/transcripts/types/index.d.mts

@@ -0,0 +1,3 @@
+export * from "./TranscriptsCreateRequestKeyterms.mjs";
+export * from "./TranscriptsCreateRequestKeytermsTermsItem.mjs";
+export * from "./TranscriptsCreateRequestReplacementsItem.mjs";

package/dist/esm/api/resources/transcripts/types/index.mjs

@@ -0,0 +1,3 @@
+export * from "./TranscriptsCreateRequestKeyterms.mjs";
+export * from "./TranscriptsCreateRequestKeytermsTermsItem.mjs";
+export * from "./TranscriptsCreateRequestReplacementsItem.mjs";

package/dist/esm/api/types/GuidedSection.d.mts

@@ -1,31 +1,10 @@
 import type * as Corti from "../index.mjs";
-export interface GuidedSection {
-    /** The UUID of the section. */
-    id: string;
-    /** Reference to the section to inherit generation configuration from. Inherits from published version by default. */
-    inheritedFromId?: string | null;
-    /** True if the section was auto-generated as part of an inline section-composed POST /documents request. */
-    autoGenerated?: boolean;
-    /** Whether this section was created by the user or from the Corti standard resources. */
-    source?: Corti.GuidedSectionSource;
-    /** The name of the section. */
-    name: string;
-    /** BCP 47 languages this section has been tweaked for. Empty means no language-specific tweaks. */
-    languages: string[];
-    /** ISO 3166-1 alpha-3 country codes this section has been tweaked for. Empty means no region-specific tweaks. */
-    regions: string[];
-    /** Clinical specialties this section has been tweaked for. Empty means no specialty-specific tweaks. */
-    specialties: string[];
-    /** The description for the section. */
-    description?: string;
-    /** The labels available to use as query param filter in the LIST /sections endpoint. */
-    labels: Corti.GuidedLabel[];
+/**
+ * Section as returned by single-resource endpoints (GET, POST, PATCH on
+ * `/documents/sections/{sectionID}`) and when embedded inside a resolved template
+ * version. Extends `GuidedSectionListItem` with the resolved `publishedVersion`.
+ */
+export interface GuidedSection extends Corti.GuidedSectionListItem {
     /** The currently published version with section inheritance fully resolved. Present when a version has been published. */
     publishedVersion?: Corti.GuidedSectionVersion;
-    /** The original timestamp when the section was created. */
-    createdAt: Date;
-    /** The original timestamp when the section was last updated. */
-    updatedAt: Date;
-    /** Present when the section has been deleted. GET by ID still returns the full resource with this field populated. */
-    deletedAt?: Date | null;
 }

package/dist/esm/api/types/GuidedSectionListItem.d.mts

@@ -0,0 +1,36 @@
+import type * as Corti from "../index.mjs";
+/**
+ * Section metadata as returned by the LIST /documents/sections endpoint. Does not
+ * include the resolved `publishedVersion` — use GET /documents/sections/{sectionID}
+ * to fetch a single section with its published version resolved.
+ */
+export interface GuidedSectionListItem {
+    /** The UUID of the section. */
+    id: string;
+    /** Reference to the section to inherit generation configuration from. Inherits from published version by default. */
+    inheritedFromId?: string | null;
+    /** True if the section was auto-generated as part of an inline section-composed POST /documents request. */
+    autoGenerated?: boolean;
+    /** Whether this section was created by the user, a project-related API Client or is a Corti standard resource. */
+    source?: Corti.GuidedSectionListItemSource;
+    /** The name of the section. */
+    name: string;
+    /** BCP 47 languages this section has been tweaked for. Empty means no language-specific tweaks. */
+    languages: string[];
+    /** ISO 3166-1 alpha-3 country codes this section has been tweaked for. Empty means no region-specific tweaks. */
+    regions: string[];
+    /** Clinical specialties this section has been tweaked for. Empty means no specialty-specific tweaks. */
+    specialties: string[];
+    /** The description for the section. */
+    description?: string;
+    /** The labels available to use as query param filter in the LIST /sections endpoint. */
+    labels: Corti.GuidedLabel[];
+    /** The UUID of the creator of this section. */
+    createdBy?: string;
+    /** The original timestamp when the section was created. */
+    createdAt: Date;
+    /** The original timestamp when the section was last updated. */
+    updatedAt: Date;
+    /** Present when the section has been deleted. GET by ID still returns the full resource with this field populated. */
+    deletedAt?: Date | null;
+}

package/dist/esm/api/types/GuidedSectionListItem.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/GuidedSectionListItemSource.d.mts

@@ -0,0 +1,7 @@
+/** Whether this section was created by the user, a project-related API Client or is a Corti standard resource. */
+export declare const GuidedSectionListItemSource: {
+    readonly User: "user";
+    readonly Corti: "corti";
+    readonly Project: "project";
+};
+export type GuidedSectionListItemSource = (typeof GuidedSectionListItemSource)[keyof typeof GuidedSectionListItemSource];

package/dist/esm/api/types/GuidedSectionListItemSource.mjs

@@ -0,0 +1,7 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Whether this section was created by the user, a project-related API Client or is a Corti standard resource. */
+export const GuidedSectionListItemSource = {
+    User: "user",
+    Corti: "corti",
+    Project: "project",
+};

package/dist/esm/api/types/GuidedSectionsCreateRequest.d.mts

@@ -1,2 +1,2 @@
 import type * as Corti from "../index.mjs";
-export type GuidedSectionsCreateRequest = Corti.GuidedSectionsCreateFromScratchRequest | Corti.GuidedSectionsCreateFromInheritanceRequest;
+export type GuidedSectionsCreateRequest = Corti.GuidedSectionsCreateFromInheritanceRequest | Corti.GuidedSectionsCreateFromScratchRequest;

package/dist/esm/api/types/GuidedTemplate.d.mts

@@ -1,31 +1,10 @@
 import type * as Corti from "../index.mjs";
-export interface GuidedTemplate {
-    /** The UUID of the template. */
-    id: string;
-    /** Reference to the template to inherit template instructions and sections from. Inherits from published version by default. */
-    inheritedFromId?: string | null;
-    /** True if the template was auto-generated based on the section-composed POST /documents request. */
-    autoGenerated?: boolean;
-    /** Whether this template was created by the user or is a Corti standard resource. */
-    source?: Corti.GuidedTemplateSource;
-    /** The name of this template. Not passed to the LLM. */
-    name: string;
-    /** A description for this template. Not passed to the LLM. */
-    description?: string;
-    /** BCP 47 language tags this template has been tweaked for (e.g. `["fr", "de", "en-GB"]`). Empty means no language-specific tweaks. */
-    languages: string[];
-    /** ISO 3166-1 alpha-3 country codes this template has been tweaked for (e.g. `["BEL"]`). Empty means no region-specific tweaks. */
-    regions: string[];
-    /** Clinical specialties this template has been tweaked for. Empty means no specialty-specific tweaks. */
-    specialties: string[];
-    /** The available labels to use as query param filter in the LIST /templates endpoint. */
-    labels: Corti.GuidedLabel[];
+/**
+ * Template as returned by single-resource endpoints (GET, POST, PATCH on
+ * `/documents/templates/{templateID}`). Extends `GuidedTemplateListItem` with the resolved
+ * `publishedVersion`.
+ */
+export interface GuidedTemplate extends Corti.GuidedTemplateListItem {
     /** The currently published version with inheritance fully resolved. Present when a version has been published. */
     publishedVersion?: Corti.GuidedTemplateVersion;
-    /** The original timestamp when the template was created. */
-    createdAt: Date;
-    /** The original timestamp when the template was last updated. */
-    updatedAt: Date;
-    /** Present when the template has been deleted. GET by ID still returns the full resource with this field populated. */
-    deletedAt?: Date | null;
 }

package/dist/esm/api/types/GuidedTemplateListItem.d.mts

@@ -0,0 +1,36 @@
+import type * as Corti from "../index.mjs";
+/**
+ * Template metadata as returned by the LIST /documents/templates endpoint. Does not
+ * include the resolved `publishedVersion` — use GET /documents/templates/{templateID}
+ * to fetch a single template with its published version resolved.
+ */
+export interface GuidedTemplateListItem {
+    /** The UUID of the template. */
+    id: string;
+    /** Reference to the template to inherit template instructions and sections from. Inherits from published version by default. */
+    inheritedFromId?: string | null;
+    /** True if the template was auto-generated based on the section-composed POST /documents request. */
+    autoGenerated?: boolean;
+    /** Whether this template was created by the user, a project-related API Client or is a Corti standard resource. */
+    source?: Corti.GuidedTemplateListItemSource;
+    /** The name of this template. Not passed to the LLM. */
+    name: string;
+    /** A description for this template. Not passed to the LLM. */
+    description?: string;
+    /** BCP 47 language tags this template has been tweaked for (e.g. `["fr", "de", "en-GB"]`). Empty means no language-specific tweaks. */
+    languages: string[];
+    /** ISO 3166-1 alpha-3 country codes this template has been tweaked for (e.g. `["BEL"]`). Empty means no region-specific tweaks. */
+    regions: string[];
+    /** Clinical specialties this template has been tweaked for. Empty means no specialty-specific tweaks. */
+    specialties: string[];
+    /** The available labels to use as query param filter in the LIST /templates endpoint. */
+    labels: Corti.GuidedLabel[];
+    /** The UUID of the creator of this template. */
+    createdBy?: string;
+    /** The original timestamp when the template was created. */
+    createdAt: Date;
+    /** The original timestamp when the template was last updated. */
+    updatedAt: Date;
+    /** Present when the template has been deleted. GET by ID still returns the full resource with this field populated. */
+    deletedAt?: Date | null;
+}

package/dist/esm/api/types/GuidedTemplateListItem.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/GuidedTemplateListItemSource.d.mts

@@ -0,0 +1,7 @@
+/** Whether this template was created by the user, a project-related API Client or is a Corti standard resource. */
+export declare const GuidedTemplateListItemSource: {
+    readonly User: "user";
+    readonly Corti: "corti";
+    readonly Project: "project";
+};
+export type GuidedTemplateListItemSource = (typeof GuidedTemplateListItemSource)[keyof typeof GuidedTemplateListItemSource];

package/dist/esm/api/types/GuidedTemplateListItemSource.mjs

@@ -0,0 +1,7 @@
+// This file was auto-generated by Fern from our API Definition.
+/** Whether this template was created by the user, a project-related API Client or is a Corti standard resource. */
+export const GuidedTemplateListItemSource = {
+    User: "user",
+    Corti: "corti",
+    Project: "project",
+};

package/dist/esm/api/types/GuidedTemplatesCreateFromScratchRequest.d.mts

@@ -1,6 +1,6 @@
 import type * as Corti from "../index.mjs";
 /**
- * Creates a template from scratch. `generation.instructions` is required and the template fully specifies its own instructions and sections.
+ * Creates a template from scratch. The template fully specifies its own sections and optional template-level instructions.
  */
 export interface GuidedTemplatesCreateFromScratchRequest extends Corti.GuidedTemplatesCreateBase {
     generation: Corti.GuidedTemplatesCreateFromScratchRequestGeneration;

package/dist/esm/api/types/GuidedTemplatesCreateFromScratchRequestGeneration.d.mts

@@ -1,5 +1,5 @@
 import type * as Corti from "../index.mjs";
 export interface GuidedTemplatesCreateFromScratchRequestGeneration {
-    instructions: Corti.GuidedTemplateInstructions;
+    instructions?: Corti.GuidedTemplateInstructions;
     sections?: Corti.GuidedTemplatesVersionSectionRequest[];
 }

package/dist/esm/api/types/GuidedTemplatesCreateRequest.d.mts

@@ -1,2 +1,2 @@
 import type * as Corti from "../index.mjs";
-export type GuidedTemplatesCreateRequest = Corti.GuidedTemplatesCreateFromScratchRequest | Corti.GuidedTemplatesCreateFromInheritanceRequest;
+export type GuidedTemplatesCreateRequest = Corti.GuidedTemplatesCreateFromInheritanceRequest | Corti.GuidedTemplatesCreateFromScratchRequest;

package/dist/esm/api/types/StreamConfig.d.mts

@@ -7,4 +7,8 @@ export interface StreamConfig {
     audioEvents?: Corti.StreamAudioEventsConfig;
     /** Define the audio format of the incoming audio stream - optional but recommended. When omitted, the server auto-detects the format from the first audio chunk using ffprobe. Supported audio will be processed. Unsupported return an error but might in some cases error silently. If provided (recommended), the provided MIME type must be supported and the audio must match the MIME type. An unsupported MIME type results in `CONFIG_REJECTED`. Audio that differs from the MIME type will return audio validation errors on the socket. See full list of supported MIME types [here](/stt/audio). */
     audioFormat?: string;
+    /** Define replacements to have terms (single words or multi-word phrases) replaced in final text output with your preferred style. For example, replace "BID" with "twice daily". Configuration is case insensitive and limited to 1,000 replacements per stream. */
+    replacements?: Corti.StreamConfigReplacementsItem[];
+    /** Define words, terms, and phrases to be recognized by Corti speech-to-text. Especially useful for proper nouns (e.g., surnames), but also supportive of words not being recognized consistently. */
+    keyterms?: Corti.StreamConfigKeyterms;
 }

package/dist/esm/api/types/StreamConfigKeyterms.d.mts

@@ -0,0 +1,8 @@
+import type * as Corti from "../index.mjs";
+/**
+ * Define words, terms, and phrases to be recognized by Corti speech-to-text. Especially useful for proper nouns (e.g., surnames), but also supportive of words not being recognized consistently.
+ */
+export interface StreamConfigKeyterms {
+    /** Ordered list of words to be recognized. Configuration is case sensitive and limited to 1,000 key terms per stream. */
+    terms?: Corti.StreamConfigKeytermsTermsItem[];
+}

package/dist/esm/api/types/StreamConfigKeyterms.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/StreamConfigKeytermsTermsItem.d.mts

@@ -0,0 +1,4 @@
+export interface StreamConfigKeytermsTermsItem {
+    /** The word to be recognized, defined in its expected written form. A defined `term` is limited to a length of 50 characters. */
+    term: string;
+}

package/dist/esm/api/types/StreamConfigKeytermsTermsItem.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/StreamConfigReplacementsItem.d.mts

@@ -0,0 +1,6 @@
+export interface StreamConfigReplacementsItem {
+    /** The term to be replaced, such as "BID". */
+    find: string;
+    /** The preferred replacement for the term, such as "twice daily". */
+    replace: string;
+}

package/dist/esm/api/types/StreamConfigReplacementsItem.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};