@corti/sdk 0.1.5-alpha → 0.2.0

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

@@ -20,6 +20,8 @@ export class Facts {
         this._options = _options;
     }
     /**
+     * Returns a list of available fact groups, used to categorize facts associated with an interaction.
+     *
      * @param {Facts.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Corti.InternalServerError}
@@ -86,7 +88,7 @@ export class Facts {
         });
     }
     /**
-     *  Retrieves a list of facts for a given interaction.
+     * Retrieves a list of facts for a given interaction.
      *
      * @param {Corti.Uuid} id - The unique identifier of the interaction. Must be a valid UUID.
      * @param {Facts.RequestOptions} requestOptions - Request-specific configuration.
@@ -161,7 +163,7 @@ export class Facts {
         });
     }
     /**
-     *  Adds new facts to an interaction.
+     * Adds new facts to an interaction.
      *
      * @param {Corti.Uuid} id - The unique identifier of the interaction. Must be a valid UUID.
      * @param {Corti.FactsCreateRequest} request
@@ -248,7 +250,7 @@ export class Facts {
         });
     }
     /**
-     *  Updates multiple facts associated with an interaction. If the interaction `status = "in progress"`, the updated facts will be sent to the client over WebSocket.
+     * Updates multiple facts associated with an interaction.
      *
      * @param {Corti.Uuid} id - The unique identifier of the interaction. Must be a valid UUID.
      * @param {Corti.FactsBatchUpdateRequest} request
@@ -334,7 +336,7 @@ export class Facts {
         });
     }
     /**
-     *  Updates an existing fact within a specific interaction. If the interaction `status = "in progress"`, the updated fact will be sent to the client via WebSocket. To discard a fact, simply set `discarded = true`.
+     * Updates an existing fact associated with a specific interaction.
      *
      * @param {Corti.Uuid} id - The unique identifier of the interaction. Must be a valid UUID.
      * @param {Corti.Uuid} factId - The unique identifier of the fact to update. Must be a valid UUID.

package/dist/esm/api/resources/facts/client/requests/FactsUpdateRequest.d.mts

@@ -11,8 +11,8 @@ export interface FactsUpdateRequest {
     text?: string;
     /** The updated group key for the fact. */
     group?: string;
-    /** The updated origin of the fact. */
+    /** The updated origin of the fact. Set to 'USER' to indicate a change by an end-user. */
     source?: Corti.CommonSourceEnum;
-    /** Indicates whether the fact should be marked as discarded. */
+    /** Set this to true if discarded by an end-user, then filter out from the document generation request. */
     isDiscarded?: boolean;
 }

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

@@ -1,12 +1,11 @@
 export * as interactions from "./interactions/index.mjs";
 export * from "./interactions/types/index.mjs";
-export * as transcripts from "./transcripts/index.mjs";
-export * from "./transcripts/types/index.mjs";
 export * as auth from "./auth/index.mjs";
 export * from "./auth/types/index.mjs";
 export * as stream from "./stream/index.mjs";
 export * as transcribe from "./transcribe/index.mjs";
 export * as recordings from "./recordings/index.mjs";
+export * as transcripts from "./transcripts/index.mjs";
 export * as facts from "./facts/index.mjs";
 export * as documents from "./documents/index.mjs";
 export * as templates from "./templates/index.mjs";

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

@@ -1,12 +1,11 @@
 export * as interactions from "./interactions/index.mjs";
 export * from "./interactions/types/index.mjs";
-export * as transcripts from "./transcripts/index.mjs";
-export * from "./transcripts/types/index.mjs";
 export * as auth from "./auth/index.mjs";
 export * from "./auth/types/index.mjs";
 export * as stream from "./stream/index.mjs";
 export * as transcribe from "./transcribe/index.mjs";
 export * as recordings from "./recordings/index.mjs";
+export * as transcripts from "./transcripts/index.mjs";
 export * as facts from "./facts/index.mjs";
 export * as documents from "./documents/index.mjs";
 export * as templates from "./templates/index.mjs";

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

@@ -32,7 +32,7 @@ export declare class Interactions {
     protected readonly _options: Interactions.Options;
     constructor(_options: Interactions.Options);
     /**
-     *  Lists all existing interactions. Results can be filtered by encounter status and patient identifier.
+     * Lists all existing interactions. Results can be filtered by encounter status and patient identifier.
      *
      * @param {Corti.InteractionsListRequest} request
      * @param {Interactions.RequestOptions} requestOptions - Request-specific configuration.
@@ -45,7 +45,7 @@ export declare class Interactions {
      */
     list(request?: Corti.InteractionsListRequest, requestOptions?: Interactions.RequestOptions): Promise<core.Page<Corti.InteractionsGetResponse>>;
     /**
-     *  Creates a new interaction.
+     * Creates a new interaction.
      *
      * @param {Corti.InteractionsCreateRequest} request
      * @param {Interactions.RequestOptions} requestOptions - Request-specific configuration.
@@ -67,7 +67,7 @@ export declare class Interactions {
     create(request: Corti.InteractionsCreateRequest, requestOptions?: Interactions.RequestOptions): core.HttpResponsePromise<Corti.InteractionsCreateResponse>;
     private __create;
     /**
-     *  Retrieves a previously recorded interaction by its unique identifier (interaction ID).
+     * Retrieves a previously recorded interaction by its unique identifier (interaction ID).
      *
      * @param {Corti.Uuid} id - The unique identifier of the interaction. Must be a valid UUID.
      * @param {Interactions.RequestOptions} requestOptions - Request-specific configuration.
@@ -81,7 +81,7 @@ export declare class Interactions {
     get(id: Corti.Uuid, requestOptions?: Interactions.RequestOptions): core.HttpResponsePromise<Corti.InteractionsGetResponse>;
     private __get;
     /**
-     *  Deletes an existing interaction.
+     * Deletes an existing interaction.
      *
      * @param {Corti.Uuid} id - The unique identifier of the interaction. Must be a valid UUID.
      * @param {Interactions.RequestOptions} requestOptions - Request-specific configuration.
@@ -95,7 +95,7 @@ export declare class Interactions {
     delete(id: Corti.Uuid, requestOptions?: Interactions.RequestOptions): core.HttpResponsePromise<void>;
     private __delete;
     /**
-     *  Modifies an existing interaction by updating specific fields without overwriting the entire record.
+     * Modifies an existing interaction by updating specific fields without overwriting the entire record.
      *
      * @param {Corti.Uuid} id - The unique identifier of the interaction. Must be a valid UUID.
      * @param {Corti.InteractionsUpdateRequest} request

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

@@ -20,7 +20,7 @@ export class Interactions {
         this._options = _options;
     }
     /**
-     *  Lists all existing interactions. Results can be filtered by encounter status and patient identifier.
+     * Lists all existing interactions. Results can be filtered by encounter status and patient identifier.
      *
      * @param {Corti.InteractionsListRequest} request
      * @param {Interactions.RequestOptions} requestOptions - Request-specific configuration.
@@ -150,7 +150,7 @@ export class Interactions {
         });
     }
     /**
-     *  Creates a new interaction.
+     * Creates a new interaction.
      *
      * @param {Corti.InteractionsCreateRequest} request
      * @param {Interactions.RequestOptions} requestOptions - Request-specific configuration.
@@ -252,7 +252,7 @@ export class Interactions {
         });
     }
     /**
-     *  Retrieves a previously recorded interaction by its unique identifier (interaction ID).
+     * Retrieves a previously recorded interaction by its unique identifier (interaction ID).
      *
      * @param {Corti.Uuid} id - The unique identifier of the interaction. Must be a valid UUID.
      * @param {Interactions.RequestOptions} requestOptions - Request-specific configuration.
@@ -336,7 +336,7 @@ export class Interactions {
         });
     }
     /**
-     *  Deletes an existing interaction.
+     * Deletes an existing interaction.
      *
      * @param {Corti.Uuid} id - The unique identifier of the interaction. Must be a valid UUID.
      * @param {Interactions.RequestOptions} requestOptions - Request-specific configuration.
@@ -411,7 +411,7 @@ export class Interactions {
         });
     }
     /**
-     *  Modifies an existing interaction by updating specific fields without overwriting the entire record.
+     * Modifies an existing interaction by updating specific fields without overwriting the entire record.
      *
      * @param {Corti.Uuid} id - The unique identifier of the interaction. Must be a valid UUID.
      * @param {Corti.InteractionsUpdateRequest} request

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

@@ -32,7 +32,7 @@ export declare class Recordings {
     protected readonly _options: Recordings.Options;
     constructor(_options: Recordings.Options);
     /**
-     *  Retrieve a list of recordings for a given interaction.
+     * Retrieve a list of recordings for a given interaction.
      *
      * @param {Corti.Uuid} id - The unique identifier of the interaction. Must be a valid UUID.
      * @param {Recordings.RequestOptions} requestOptions - Request-specific configuration.
@@ -48,7 +48,7 @@ export declare class Recordings {
     list(id: Corti.Uuid, requestOptions?: Recordings.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 60 minutes in length and 150MB in size for recordings.
      *
      * @param {core.file.Uploadable} uploadable
      * @param {Corti.Uuid} id
@@ -62,7 +62,7 @@ export declare class Recordings {
     upload(uploadable: core.file.Uploadable, id: Corti.Uuid, requestOptions?: Recordings.RequestOptions): core.HttpResponsePromise<Corti.RecordingsCreateResponse>;
     private __upload;
     /**
-     *  Retrieve a specific recording for a given interaction.
+     * Retrieve a specific recording for a given interaction.
      * @throws {@link Corti.BadRequestError}
      * @throws {@link Corti.ForbiddenError}
      * @throws {@link Corti.NotFoundError}
@@ -72,7 +72,7 @@ export declare class Recordings {
     get(id: Corti.Uuid, recordingId: Corti.Uuid, requestOptions?: Recordings.RequestOptions): core.HttpResponsePromise<core.BinaryResponse>;
     private __get;
     /**
-     *  Delete a specific recording for a given interaction.
+     * Delete a specific recording for a given interaction.
      *
      * @param {Corti.Uuid} id - The unique identifier of the interaction. Must be a valid UUID.
      * @param {Corti.Uuid} recordingId - The unique identifier of the recording. Must be a valid UUID.

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

@@ -20,7 +20,7 @@ export class Recordings {
         this._options = _options;
     }
     /**
-     *  Retrieve a list of recordings for a given interaction.
+     * Retrieve a list of recordings for a given interaction.
      *
      * @param {Corti.Uuid} id - The unique identifier of the interaction. Must be a valid UUID.
      * @param {Recordings.RequestOptions} requestOptions - Request-specific configuration.
@@ -110,7 +110,7 @@ export class Recordings {
         });
     }
     /**
-     *  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 60 minutes in length and 150MB in size for recordings.
      *
      * @param {core.file.Uploadable} uploadable
      * @param {Corti.Uuid} id
@@ -203,7 +203,7 @@ export class Recordings {
         });
     }
     /**
-     *  Retrieve a specific recording for a given interaction.
+     * Retrieve a specific recording for a given interaction.
      * @throws {@link Corti.BadRequestError}
      * @throws {@link Corti.ForbiddenError}
      * @throws {@link Corti.NotFoundError}
@@ -244,13 +244,7 @@ export class Recordings {
                             breadcrumbsPrefix: ["response"],
                         }), _response.rawResponse);
                     case 404:
-                        throw new Corti.NotFoundError(serializers.ErrorResponse.parseOrThrow(_response.error.body, {
-                            unrecognizedObjectKeys: "passthrough",
-                            allowUnrecognizedUnionMembers: true,
-                            allowUnrecognizedEnumValues: true,
-                            skipValidation: true,
-                            breadcrumbsPrefix: ["response"],
-                        }), _response.rawResponse);
+                        throw new Corti.NotFoundError(_response.error.body, _response.rawResponse);
                     case 500:
                         throw new Corti.InternalServerError(_response.error.body, _response.rawResponse);
                     case 504:
@@ -287,7 +281,7 @@ export class Recordings {
         });
     }
     /**
-     *  Delete a specific recording for a given interaction.
+     * Delete a specific recording for a given interaction.
      *
      * @param {Corti.Uuid} id - The unique identifier of the interaction. Must be a valid UUID.
      * @param {Corti.Uuid} recordingId - The unique identifier of the recording. Must be a valid UUID.
@@ -332,13 +326,7 @@ export class Recordings {
                             breadcrumbsPrefix: ["response"],
                         }), _response.rawResponse);
                     case 404:
-                        throw new Corti.NotFoundError(serializers.ErrorResponse.parseOrThrow(_response.error.body, {
-                            unrecognizedObjectKeys: "passthrough",
-                            allowUnrecognizedUnionMembers: true,
-                            allowUnrecognizedEnumValues: true,
-                            skipValidation: true,
-                            breadcrumbsPrefix: ["response"],
-                        }), _response.rawResponse);
+                        throw new Corti.NotFoundError(_response.error.body, _response.rawResponse);
                     case 500:
                         throw new Corti.InternalServerError(_response.error.body, _response.rawResponse);
                     case 504:

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

@@ -32,7 +32,7 @@ export declare class Templates {
     protected readonly _options: Templates.Options;
     constructor(_options: Templates.Options);
     /**
-     *  Retrieves a list of template sections with optional filters for organization and language.
+     * Retrieves a list of template sections with optional filters for organization and language.
      *
      * @param {Corti.TemplatesSectionListRequest} request
      * @param {Templates.RequestOptions} requestOptions - Request-specific configuration.
@@ -46,7 +46,7 @@ export declare class Templates {
     sectionList(request?: Corti.TemplatesSectionListRequest, requestOptions?: Templates.RequestOptions): core.HttpResponsePromise<Corti.TemplatesSectionListResponse>;
     private __sectionList;
     /**
-     *  Retrieves a list of templates with optional filters for organization, language, and status.
+     * Retrieves a list of templates with optional filters for organization, language, and status.
      *
      * @param {Corti.TemplatesListRequest} request
      * @param {Templates.RequestOptions} requestOptions - Request-specific configuration.

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

@@ -20,7 +20,7 @@ export class Templates {
         this._options = _options;
     }
     /**
-     *  Retrieves a list of template sections with optional filters for organization and language.
+     * Retrieves a list of template sections with optional filters for organization and language.
      *
      * @param {Corti.TemplatesSectionListRequest} request
      * @param {Templates.RequestOptions} requestOptions - Request-specific configuration.
@@ -111,7 +111,7 @@ export class Templates {
         });
     }
     /**
-     *  Retrieves a list of templates with optional filters for organization, language, and status.
+     * Retrieves a list of templates with optional filters for organization, language, and status.
      *
      * @param {Corti.TemplatesListRequest} request
      * @param {Templates.RequestOptions} requestOptions - Request-specific configuration.

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

@@ -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/esm/api/resources/transcripts/client/Client.mjs

@@ -20,7 +20,7 @@ export 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
@@ -120,7 +120,7 @@ export 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
@@ -135,8 +135,7 @@ export 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) {
@@ -224,7 +223,7 @@ export 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.
@@ -318,7 +317,7 @@ export 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/esm/api/resources/transcripts/client/requests/TranscriptsCreateRequest.d.mts

@@ -6,8 +6,7 @@ import * as Corti from "../../../../index.mjs";
  * @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/esm/api/resources/transcripts/index.d.mts

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

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

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

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

@@ -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/esm/api/types/{CommonTranscript.d.mts → CommonTranscriptResponse.d.mts}

@@ -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/esm/api/types/DocumentsContext.d.mts

@@ -2,9 +2,15 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Corti from "../index.mjs";
-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/esm/api/types/DocumentsContextWithFacts.d.mts

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

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

@@ -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/esm/api/types/DocumentsContextWithString.mjs

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

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

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

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

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

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

@@ -2,4 +2,10 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Corti from "../index.mjs";
-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/esm/api/types/DocumentsCreateRequestWithTemplate.d.mts

@@ -3,14 +3,12 @@
  */
 import * as Corti from "../index.mjs";
 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/esm/api/types/DocumentsCreateRequestWithTemplateKey.d.mts

@@ -3,14 +3,12 @@
  */
 import * as Corti from "../index.mjs";
 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/esm/api/types/DocumentsTemplate.d.mts

@@ -2,13 +2,4 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as Corti from "../index.mjs";
-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/esm/api/types/DocumentsTemplateWithSectionKeys.d.mts

@@ -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/esm/api/types/DocumentsTemplateWithSectionKeys.mjs

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

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

@@ -5,7 +5,7 @@ import * as Corti from "../index.mjs";
 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/esm/api/types/FactsCreateItem.d.mts

@@ -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/esm/api/types/FactsListItem.d.mts

@@ -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;