@corti/sdk 0.1.3-alpha → 0.1.3-rc

package/dist/cjs/api/resources/transcripts/client/Client.d.ts

@@ -32,7 +32,7 @@ export declare class Transcripts {
     protected readonly _options: Transcripts.Options;
     constructor(_options: Transcripts.Options);
     /**
-     *  Retrieves a list of transcripts for a given interaction.
+     * Retrieves a list of transcripts for a given interaction.
      *
      * @param {Corti.Uuid} id - The unique identifier of the interaction. Must be a valid UUID.
      * @param {Corti.TranscriptsListRequest} request
@@ -50,7 +50,7 @@ export declare class Transcripts {
     list(id: Corti.Uuid, request?: Corti.TranscriptsListRequest, requestOptions?: Transcripts.RequestOptions): core.HttpResponsePromise<Corti.TranscriptsListResponse>;
     private __list;
     /**
-     *  Creates a new transcript for an interaction.
+     * Creates a new transcript for an interaction.
      *
      * @param {Corti.Uuid} id - The unique identifier of the interaction. Must be a valid UUID.
      * @param {Corti.TranscriptsCreateRequest} request
@@ -65,14 +65,13 @@ export declare class Transcripts {
      * @example
      *     await client.transcripts.create("f47ac10b-58cc-4372-a567-0e02b2c3d479", {
      *         recordingId: "f47ac10b-58cc-4372-a567-0e02b2c3d479",
-     *         primaryLanguage: "en",
-     *         modelName: "base"
+     *         primaryLanguage: "en"
      *     })
      */
     create(id: Corti.Uuid, request: Corti.TranscriptsCreateRequest, requestOptions?: Transcripts.RequestOptions): core.HttpResponsePromise<Corti.TranscriptsResponse>;
     private __create;
     /**
-     *  Retrieves the transcript for a specific interaction.
+     * Retrieves the transcript for a specific interaction.
      *
      * @param {Corti.Uuid} id - The unique identifier of the interaction. Must be a valid UUID.
      * @param {Corti.Uuid} transcriptId - The unique identifier of the transcript. Must be a valid UUID.
@@ -90,7 +89,7 @@ export declare class Transcripts {
     get(id: Corti.Uuid, transcriptId: Corti.Uuid, requestOptions?: Transcripts.RequestOptions): core.HttpResponsePromise<Corti.TranscriptsResponse>;
     private __get;
     /**
-     *  Deletes a specific transcript associated with an interaction.
+     * Deletes a specific transcript associated with an interaction.
      *
      * @param {Corti.Uuid} id - The unique identifier of the interaction. Must be a valid UUID.
      * @param {Corti.Uuid} transcriptId - The unique identifier of the transcript. Must be a valid UUID.

package/dist/cjs/api/resources/transcripts/client/Client.js

@@ -56,7 +56,7 @@ class Transcripts {
         this._options = _options;
     }
     /**
-     *  Retrieves a list of transcripts for a given interaction.
+     * Retrieves a list of transcripts for a given interaction.
      *
      * @param {Corti.Uuid} id - The unique identifier of the interaction. Must be a valid UUID.
      * @param {Corti.TranscriptsListRequest} request
@@ -156,7 +156,7 @@ class Transcripts {
         });
     }
     /**
-     *  Creates a new transcript for an interaction.
+     * Creates a new transcript for an interaction.
      *
      * @param {Corti.Uuid} id - The unique identifier of the interaction. Must be a valid UUID.
      * @param {Corti.TranscriptsCreateRequest} request
@@ -171,8 +171,7 @@ class Transcripts {
      * @example
      *     await client.transcripts.create("f47ac10b-58cc-4372-a567-0e02b2c3d479", {
      *         recordingId: "f47ac10b-58cc-4372-a567-0e02b2c3d479",
-     *         primaryLanguage: "en",
-     *         modelName: "base"
+     *         primaryLanguage: "en"
      *     })
      */
     create(id, request, requestOptions) {
@@ -260,7 +259,7 @@ class Transcripts {
         });
     }
     /**
-     *  Retrieves the transcript for a specific interaction.
+     * Retrieves the transcript for a specific interaction.
      *
      * @param {Corti.Uuid} id - The unique identifier of the interaction. Must be a valid UUID.
      * @param {Corti.Uuid} transcriptId - The unique identifier of the transcript. Must be a valid UUID.
@@ -354,7 +353,7 @@ class Transcripts {
         });
     }
     /**
-     *  Deletes a specific transcript associated with an interaction.
+     * Deletes a specific transcript associated with an interaction.
      *
      * @param {Corti.Uuid} id - The unique identifier of the interaction. Must be a valid UUID.
      * @param {Corti.Uuid} transcriptId - The unique identifier of the transcript. Must be a valid UUID.

package/dist/cjs/api/resources/transcripts/client/requests/TranscriptsCreateRequest.d.ts

@@ -6,8 +6,7 @@ import * as Corti from "../../../../index.js";
  * @example
  *     {
  *         recordingId: "f47ac10b-58cc-4372-a567-0e02b2c3d479",
- *         primaryLanguage: "en",
- *         modelName: "base"
+ *         primaryLanguage: "en"
  *     }
  */
 export interface TranscriptsCreateRequest {
@@ -23,6 +22,4 @@ export interface TranscriptsCreateRequest {
     diarize?: boolean;
     /** An array of participants, each specifying a role and an assigned audio channel in the recording. Leave empty when shouldDiarize: true */
     participants?: Corti.TranscriptsParticipant[];
-    /** The model name for transcription. By default, only the highest tier is accessible. Check https://docs.corti.ai/about/languages for more. */
-    modelName: Corti.TranscriptsCreateRequestModelName;
 }

package/dist/cjs/api/resources/transcripts/index.d.ts

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

package/dist/cjs/api/resources/transcripts/index.js

@@ -14,5 +14,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./types/index.js"), exports);
 __exportStar(require("./client/index.js"), exports);

package/dist/cjs/api/types/CommonTranscriptRequest.d.ts

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface CommonTranscriptRequest {
+    /** The channel associated with this phrase/utterance. */
+    channel?: number;
+    /** The identifier of the participant. */
+    participant?: number;
+    /** Id to tag an identified speaker. Auto-increments. */
+    speakerId?: number;
+    /** The spoken phrase or utterance extracted from the audio. */
+    text: string;
+    /** Start time in milliseconds for phrase/utterance. */
+    start?: number;
+    /** End time in milliseconds for phrase/utterance. */
+    end?: number;
+}

package/dist/cjs/api/types/{CommonTranscript.d.ts → CommonTranscriptResponse.d.ts}

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export interface CommonTranscript {
+export interface CommonTranscriptResponse {
     /** The channel associated with this phrase/utterance. */
     channel: number;
     /** The identifier of the participant. */

package/dist/cjs/api/types/DocumentsContext.d.ts

@@ -2,9 +2,15 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Corti from "../index.js";
-export interface DocumentsContext {
-    /** The type of context data. */
-    type: Corti.DocumentsContextTypeEnum;
-    /** The actual data, which can be an array of facts, a transcript, or a string. */
-    data: Corti.DocumentsContextData;
+export type DocumentsContext = Corti.DocumentsContext.Facts | Corti.DocumentsContext.Transcript | Corti.DocumentsContext.String;
+export declare namespace DocumentsContext {
+    interface Facts extends Corti.DocumentsContextWithFacts {
+        type: "facts";
+    }
+    interface Transcript extends Corti.DocumentsContextWithTranscript {
+        type: "transcript";
+    }
+    interface String extends Corti.DocumentsContextWithString {
+        type: "string";
+    }
 }

package/dist/cjs/api/types/DocumentsContextWithFacts.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Corti from "../index.js";
+export interface DocumentsContextWithFacts {
+    /** An array of facts. */
+    data: Corti.FactsContext[];
+}

package/dist/cjs/api/types/DocumentsContextWithString.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface DocumentsContextWithString {
+    /** String data can include any text to be reasoned over for document generation: Transcript text, facts, or other narrative information. */
+    data: string;
+}

package/dist/cjs/api/types/DocumentsContextWithString.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/DocumentsContextWithTranscript.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Corti from "../index.js";
+export interface DocumentsContextWithTranscript {
+    /** Transcript object can accept the full transcript in one string, or individual transcript segments. */
+    data: Corti.CommonTranscriptRequest;
+}

package/dist/cjs/api/types/DocumentsContextWithTranscript.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/DocumentsCreateRequest.d.ts

@@ -2,4 +2,10 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Corti from "../index.js";
-export type DocumentsCreateRequest = Corti.DocumentsCreateRequestWithTemplateKey | Corti.DocumentsCreateRequestWithTemplateId | Corti.DocumentsCreateRequestWithTemplate;
+export type DocumentsCreateRequest = 
+/**
+ * Standard method for document generation: Use template key to generate document based on pre-defined template. */
+Corti.DocumentsCreateRequestWithTemplateKey
+/**
+ * Advanced method for document generation: Define sectionKeys in the request to build a template dynamically. See a detailed example [here](/templates/documents-advanced#assemble-a-template-with-extra-instructions). */
+ | Corti.DocumentsCreateRequestWithTemplate;

package/dist/cjs/api/types/DocumentsCreateRequestWithTemplate.d.ts

@@ -3,14 +3,12 @@
  */
 import * as Corti from "../index.js";
 export interface DocumentsCreateRequestWithTemplate {
-    /** An array of context objects. */
+    /** An array of context objects. Currently accepts exactly one context object to be used as input for document generation. */
     context: Corti.DocumentsContext[];
     /** Template details if the template should be generated during the request. */
     template: Corti.DocumentsTemplate;
     /** An optional name for the document. */
     name?: string;
-    /** The model or documentation mode to use for summarization. */
-    modelName?: string;
-    /** The language in which the document will be generated. Check https://docs.corti.ai/about/languages for more. */
+    /** The language in which the document will be generated. Check [languages page](/about/languages) for more. */
     outputLanguage: string;
 }

package/dist/cjs/api/types/DocumentsCreateRequestWithTemplateKey.d.ts

@@ -3,14 +3,12 @@
  */
 import * as Corti from "../index.js";
 export interface DocumentsCreateRequestWithTemplateKey {
-    /** An array of context objects. */
+    /** An array of context objects. Currently accepts exactly one context object to be used as input for document generation. */
     context: Corti.DocumentsContext[];
     /** The key of the template that informs on what kind of document is to be generated. */
     templateKey: string;
     /** An optional name for the document. */
     name?: string;
-    /** The model or documentation mode to use for summarization. */
-    modelName?: string;
-    /** The language in which the document will be generated. Check https://docs.corti.ai/about/languages for more. */
+    /** The language in which the document will be generated. Check [languages page](/about/languages) for more. */
     outputLanguage: string;
 }

package/dist/cjs/api/types/DocumentsTemplate.d.ts

@@ -2,13 +2,4 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Corti from "../index.js";
-export interface DocumentsTemplate {
-    /** An array of section IDs. */
-    sectionIds?: Corti.Uuid[];
-    /** An array of section keys. */
-    sectionKeys?: string[];
-    /** The name of the document. */
-    documentName?: string;
-    /** Any additional instructions to be considered during document generation. */
-    additionalInstructions?: string;
-}
+export type DocumentsTemplate = Corti.DocumentsTemplateWithSectionKeys;

package/dist/cjs/api/types/DocumentsTemplateWithSectionKeys.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface DocumentsTemplateWithSectionKeys {
+    /** An array of section keys. */
+    sectionKeys: string[];
+    /** The name of the document. */
+    documentName?: string;
+    /** Any additional instructions to be considered during document generation. */
+    additionalInstructions?: string;
+}

package/dist/cjs/api/types/DocumentsTemplateWithSectionKeys.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/FactsBatchUpdateInput.d.ts

@@ -5,7 +5,7 @@ import * as Corti from "../index.js";
 export interface FactsBatchUpdateInput {
     /** The unique identifier of the fact to be updated. */
     factId: Corti.Uuid;
-    /** Indicates whether the fact should be discarded. */
+    /** Set this to true for facts discarded by an end-user, then filter those out from the document generation request. */
     isDiscarded?: boolean;
     /** The updated text content of the fact. */
     text?: string;

package/dist/cjs/api/types/FactsCreateItem.d.ts

@@ -13,7 +13,7 @@ export interface FactsCreateItem {
     groupId?: Corti.Uuid;
     /** The origin of the fact, such as 'USER' or 'SYSTEM'. */
     source?: Corti.CommonSourceEnum;
-    /** Indicates whether the fact has been marked as discarded. */
+    /** Indicates whether the fact has been marked as discarded by an end-user. */
     isDiscarded?: boolean;
     /** The timestamp when the fact was last updated. */
     updatedAt?: Date;

package/dist/cjs/api/types/FactsListItem.d.ts

@@ -11,7 +11,7 @@ export interface FactsListItem {
     group?: string;
     /** The unique identifier of the group to which the fact belongs. */
     groupId?: Corti.Uuid;
-    /** Indicates whether the fact has been marked as discarded. */
+    /** Indicates whether the fact has been marked as discarded by an end-user. */
     isDiscarded?: boolean;
     /** The origin of the fact. */
     source?: Corti.CommonSourceEnum;

package/dist/cjs/api/types/TemplatesSection.d.ts

@@ -18,5 +18,5 @@ export interface TemplatesSection {
     /** Type of section */
     sectionType: string;
     /** Available translations for the section */
-    translations: Corti.TemplatesTranslation[];
+    translations: Corti.TemplatesSectionTranslation[];
 }

package/dist/cjs/api/types/TemplatesSectionTranslation.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface TemplatesSectionTranslation {
+    /** Language identifier */
+    languagesId: string;
+    /** Localized name */
+    name?: string | null;
+    /** Localized description */
+    description?: string | null;
+}

package/dist/cjs/api/types/TemplatesSectionTranslation.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/TemplatesTranslation.d.ts

@@ -5,7 +5,7 @@ export interface TemplatesTranslation {
     /** Language identifier */
     languagesId: string;
     /** Localized name */
-    name?: string | null;
+    name?: string;
     /** Localized description */
-    description?: string | null;
+    description?: string;
 }

package/dist/cjs/api/types/TranscriptsData.d.ts

@@ -6,5 +6,5 @@ export interface TranscriptsData {
     /** Additional information about the participants involved in the transcript. */
     metadata: Corti.TranscriptsMetadata;
     /** An array of transcripts. */
-    transcripts: Corti.CommonTranscript[];
+    transcripts: Corti.CommonTranscriptResponse[];
 }

package/dist/cjs/api/types/TranscriptsResponse.d.ts

@@ -8,6 +8,6 @@ export interface TranscriptsResponse {
     /** Additional information about the participants involved in the transcript. */
     metadata: Corti.TranscriptsMetadata;
     /** An array of transcripts. */
-    transcripts: Corti.CommonTranscript[];
+    transcripts?: Corti.CommonTranscriptResponse[] | null;
     usageInfo: Corti.CommonUsageInfo;
 }

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

@@ -1,7 +1,10 @@
 export * from "./DocumentsContext.js";
-export * from "./DocumentsContextData.js";
+export * from "./DocumentsContextWithFacts.js";
+export * from "./DocumentsContextWithTranscript.js";
+export * from "./DocumentsContextWithString.js";
 export * from "./DocumentsSection.js";
 export * from "./DocumentsTemplate.js";
+export * from "./DocumentsTemplateWithSectionKeys.js";
 export * from "./InteractionsEncounterCreateRequest.js";
 export * from "./InteractionsEncounterUpdateRequest.js";
 export * from "./InteractionsEncounterResponse.js";
@@ -12,7 +15,6 @@ export * from "./FactsFactGroupsItemTranslationsItem.js";
 export * from "./FactsFactGroupsItem.js";
 export * from "./InteractionsPatient.js";
 export * from "./DocumentsCreateRequest.js";
-export * from "./DocumentsCreateRequestWithTemplateId.js";
 export * from "./DocumentsCreateRequestWithTemplateKey.js";
 export * from "./DocumentsCreateRequestWithTemplate.js";
 export * from "./DocumentsSectionInput.js";
@@ -46,16 +48,17 @@ export * from "./TemplatesSection.js";
 export * from "./CommonSortingDirectionEnum.js";
 export * from "./TemplatesItem.js";
 export * from "./TemplatesSectionSorted.js";
-export * from "./CommonTranscript.js";
+export * from "./CommonTranscriptRequest.js";
+export * from "./CommonTranscriptResponse.js";
 export * from "./Uuid.js";
 export * from "./CommonUsageInfo.js";
-export * from "./DocumentsContextTypeEnum.js";
 export * from "./InteractionsEncounterStatusEnum.js";
 export * from "./InteractionsEncounterTypeEnum.js";
 export * from "./InteractionsGenderEnum.js";
 export * from "./CommonSourceEnum.js";
 export * from "./TranscriptsParticipantRoleEnum.js";
 export * from "./TemplatesWritingStyle.js";
+export * from "./TemplatesSectionTranslation.js";
 export * from "./TemplatesTranslation.js";
 export * from "./StreamConfigMessage.js";
 export * from "./StreamConfig.js";

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

@@ -15,9 +15,12 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./DocumentsContext.js"), exports);
-__exportStar(require("./DocumentsContextData.js"), exports);
+__exportStar(require("./DocumentsContextWithFacts.js"), exports);
+__exportStar(require("./DocumentsContextWithTranscript.js"), exports);
+__exportStar(require("./DocumentsContextWithString.js"), exports);
 __exportStar(require("./DocumentsSection.js"), exports);
 __exportStar(require("./DocumentsTemplate.js"), exports);
+__exportStar(require("./DocumentsTemplateWithSectionKeys.js"), exports);
 __exportStar(require("./InteractionsEncounterCreateRequest.js"), exports);
 __exportStar(require("./InteractionsEncounterUpdateRequest.js"), exports);
 __exportStar(require("./InteractionsEncounterResponse.js"), exports);
@@ -28,7 +31,6 @@ __exportStar(require("./FactsFactGroupsItemTranslationsItem.js"), exports);
 __exportStar(require("./FactsFactGroupsItem.js"), exports);
 __exportStar(require("./InteractionsPatient.js"), exports);
 __exportStar(require("./DocumentsCreateRequest.js"), exports);
-__exportStar(require("./DocumentsCreateRequestWithTemplateId.js"), exports);
 __exportStar(require("./DocumentsCreateRequestWithTemplateKey.js"), exports);
 __exportStar(require("./DocumentsCreateRequestWithTemplate.js"), exports);
 __exportStar(require("./DocumentsSectionInput.js"), exports);
@@ -62,16 +64,17 @@ __exportStar(require("./TemplatesSection.js"), exports);
 __exportStar(require("./CommonSortingDirectionEnum.js"), exports);
 __exportStar(require("./TemplatesItem.js"), exports);
 __exportStar(require("./TemplatesSectionSorted.js"), exports);
-__exportStar(require("./CommonTranscript.js"), exports);
+__exportStar(require("./CommonTranscriptRequest.js"), exports);
+__exportStar(require("./CommonTranscriptResponse.js"), exports);
 __exportStar(require("./Uuid.js"), exports);
 __exportStar(require("./CommonUsageInfo.js"), exports);
-__exportStar(require("./DocumentsContextTypeEnum.js"), exports);
 __exportStar(require("./InteractionsEncounterStatusEnum.js"), exports);
 __exportStar(require("./InteractionsEncounterTypeEnum.js"), exports);
 __exportStar(require("./InteractionsGenderEnum.js"), exports);
 __exportStar(require("./CommonSourceEnum.js"), exports);
 __exportStar(require("./TranscriptsParticipantRoleEnum.js"), exports);
 __exportStar(require("./TemplatesWritingStyle.js"), exports);
+__exportStar(require("./TemplatesSectionTranslation.js"), exports);
 __exportStar(require("./TemplatesTranslation.js"), exports);
 __exportStar(require("./StreamConfigMessage.js"), exports);
 __exportStar(require("./StreamConfig.js"), exports);

package/dist/cjs/core/exports.d.ts

@@ -0,0 +1 @@
+export * from "./file/exports.js";

package/dist/cjs/{api/resources/transcripts/types/index.js → core/exports.js}

@@ -14,4 +14,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./TranscriptsCreateRequestModelName.js"), exports);
+__exportStar(require("./file/exports.js"), exports);

package/dist/cjs/core/file/exports.d.ts

@@ -0,0 +1 @@
+export { Uploadable } from "./types.js";

package/dist/cjs/core/file/exports.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/core/file/file.d.ts

@@ -0,0 +1,5 @@
+import { Uploadable } from "./types.js";
+export declare function toBinaryUploadRequest(file: Uploadable): Promise<{
+    body: Uploadable.FileLike;
+    headers?: Record<string, string>;
+}>;