@corti/sdk 2.1.0 → 2.2.0-rc.2

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

@@ -0,0 +1,19 @@
+import type * as Corti from "../index.js";
+export interface CreateSectionBase {
+    /** A human-readable identifier for this section. Not passed to the LLM. */
+    name: string;
+    /** A description for this section. Not passed to the LLM. */
+    description?: string;
+    /** BCP 47 language tags this section has been tweaked for. */
+    languages?: string[];
+    /** ISO 3166-1 alpha-3 country codes this section has been tweaked for. */
+    regions?: string[];
+    /** Clinical specialties this section has been tweaked for. */
+    specialties?: string[];
+    /** Labels work as query param filter in the LIST /sections endpoint. */
+    labels?: Corti.Label[];
+    /** Defaults to true when omitted. Set this to false if you do not want the section to automatically show up in LIST /sections. */
+    publish?: boolean;
+    /** Access policies to apply to the section on creation. */
+    policies?: Corti.CreateSectionPolicyRequest[];
+}

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

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

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

@@ -0,0 +1,9 @@
+import type * as Corti from "../index.js";
+/**
+ * Creates a section that inherits from another section. Any fields omitted in `generation` are inherited from the referenced section's published version; any fields provided override the inherited values.
+ */
+export interface CreateSectionFromInheritanceRequest extends Corti.CreateSectionBase {
+    /** Reference to the section to inherit generation configuration from. Inherits from the published version of the referenced section. */
+    inheritFromId: string;
+    generation?: Corti.SectionGenerationPartial;
+}

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

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

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

@@ -0,0 +1,7 @@
+import type * as Corti from "../index.js";
+/**
+ * Creates a section from scratch with an explicit generation configuration. All required fields on `generation` apply.
+ */
+export interface CreateSectionFromScratchRequest extends Corti.CreateSectionBase {
+    generation: Corti.SectionGeneration;
+}

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

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

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

@@ -0,0 +1,6 @@
+import type * as Corti from "../index.js";
+export interface CreateSectionPolicyRequest {
+    kind: Corti.TemplatePolicyKind;
+    /** Required when `kind` is `customers`. List of customer tenant identifiers that should have access. */
+    customerIds?: string[] | null;
+}

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

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

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

@@ -0,0 +1,2 @@
+import type * as Corti from "../index.js";
+export type CreateSectionRequest = Corti.CreateSectionFromScratchRequest | Corti.CreateSectionFromInheritanceRequest;

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

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

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

@@ -0,0 +1,19 @@
+import type * as Corti from "../index.js";
+export interface CreateTemplateBase {
+    /** 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"]`). */
+    languages?: string[];
+    /** ISO 3166-1 alpha-3 country codes this template has been tweaked for (e.g. `["BEL"]`). */
+    regions?: string[];
+    /** Clinical specialties this template has been tweaked for. */
+    specialties?: string[];
+    /** Labels work as query param filter in the LIST /templates endpoint. */
+    labels?: Corti.Label[];
+    /** Defaults to true when omitted. Set this to false if you do not want the template to automatically show up in LIST templates. */
+    publish?: boolean;
+    /** Access policies to apply to the template on creation. */
+    policies?: Corti.CreateTemplatePolicyRequest[];
+}

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

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

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

@@ -0,0 +1,10 @@
+import type * as Corti from "../index.js";
+/**
+ * Creates a template that inherits from another template. Any fields omitted in `generation` are inherited from the referenced template's published version; any fields provided override the inherited values.
+ */
+export interface CreateTemplateFromInheritanceRequest extends Corti.CreateTemplateBase {
+    /** Reference to the template to inherit instructions and sections from. Inherits from the published version of the referenced template. */
+    inheritFromId: string;
+    /** Partial overrides applied on top of the inherited template. All inner fields are optional. Any field omitted is inherited from the referenced template. */
+    generation?: Corti.CreateTemplateFromInheritanceRequestGeneration;
+}

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

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

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

@@ -0,0 +1,8 @@
+import type * as Corti from "../index.js";
+/**
+ * Partial overrides applied on top of the inherited template. All inner fields are optional. Any field omitted is inherited from the referenced template.
+ */
+export interface CreateTemplateFromInheritanceRequestGeneration {
+    instructions?: Corti.TemplateInstructionsPartial;
+    sections?: Corti.TemplateVersionSectionRequest[];
+}

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

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

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

@@ -0,0 +1,7 @@
+import type * as Corti from "../index.js";
+/**
+ * Creates a template from scratch. `generation.instructions` is required and the template fully specifies its own instructions and sections.
+ */
+export interface CreateTemplateFromScratchRequest extends Corti.CreateTemplateBase {
+    generation: Corti.CreateTemplateFromScratchRequestGeneration;
+}

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

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

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

@@ -0,0 +1,5 @@
+import type * as Corti from "../index.js";
+export interface CreateTemplateFromScratchRequestGeneration {
+    instructions: Corti.TemplateInstructions;
+    sections?: Corti.TemplateVersionSectionRequest[];
+}

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

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

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

@@ -0,0 +1,6 @@
+import type * as Corti from "../index.js";
+export interface CreateTemplatePolicyRequest {
+    kind: Corti.TemplatePolicyKind;
+    /** Required when `kind` is `customers`. List of customer tenant identifiers that should have access. */
+    customerIds?: string[] | null;
+}

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

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

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

@@ -0,0 +1,2 @@
+import type * as Corti from "../index.js";
+export type CreateTemplateRequest = Corti.CreateTemplateFromScratchRequest | Corti.CreateTemplateFromInheritanceRequest;

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

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

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

@@ -0,0 +1,6 @@
+import type * as Corti from "../index.js";
+export interface DocumentationEvidence {
+    evidenceId?: Corti.Uuid;
+    type?: string;
+    quote?: string;
+}

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

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

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

@@ -0,0 +1,12 @@
+/**
+ * A generated document that was not saved to the database.
+ */
+export interface EphemeralDocument {
+    name: string;
+    templateId: string;
+    templateVersionId: string;
+    /** The BCP 47 language tag of the generated output. */
+    language: string;
+    stringDocument: Record<string, string>;
+    structuredDocument?: Record<string, unknown> | null;
+}

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

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

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

@@ -0,0 +1,8 @@
+import type * as Corti from "../index.js";
+export interface FieldDefinition {
+    /** Use to set a key to reference. */
+    key: string;
+    /** Can be used to prompt the LLM with more guidance in addition to the section.instructions */
+    description: string;
+    value: Corti.OutputSchema;
+}

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

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

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

@@ -0,0 +1,11 @@
+import type * as Corti from "../index.js";
+/**
+ * Compose a template by referencing existing stored sections in declaration order.
+ */
+export interface GuidedAssemblyRequest {
+    /** Name for the auto-generated template aggregate that will be persisted. */
+    name: string;
+    /** Template-level instructions for the assembled template. */
+    instructions?: Corti.TemplateInstructions;
+    sectionRefs: Corti.GuidedAssemblySectionRef[];
+}

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

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

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

@@ -0,0 +1,10 @@
+import type * as Corti from "../index.js";
+/**
+ * Per-section reference for the assembly path.
+ */
+export interface GuidedAssemblySectionRef {
+    sectionId: string;
+    /** Optional explicit section version. Defaults to the section's published version when omitted. */
+    sectionVersionId?: string | null;
+    overrides?: Corti.SectionOverrides;
+}

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

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

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

@@ -0,0 +1,12 @@
+import type * as Corti from "../index.js";
+/**
+ * Fields shared across all guided-document request variants. `outputLanguage` is always required. Exactly one input mode must be supplied: provide context items inline, or reference an existing interaction whose attached facts and transcripts will be used.
+ */
+export interface GuidedDocumentBase {
+    /** The language in which the document will be generated as a BCP 47 tag. */
+    outputLanguage: string;
+    /** Ordered list of context items the model reasons over. Each item is one of text, a transcript (with optional metadata and segments), or a single fact. Items are interleaved by timestamps where present on transcript segments; otherwise array order is preserved. */
+    context?: Corti.GuidedDocumentContext[];
+    /** When supplied, all facts and transcripts already attached to the referenced interaction are passed implicitly as input context. Facts with `isDiscarded: true` are not passed on. */
+    interactionId?: string;
+}

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

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

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

@@ -0,0 +1,8 @@
+import type * as Corti from "../index.js";
+/**
+ * Generate a document by assembling a template from existing stored sections. The resulting template aggregate is auto-saved and can be referenced in future calls. At least one of `context` or `interactionId` must be supplied as input context for the model.
+ */
+export interface GuidedDocumentByAssembly extends Corti.GuidedDocumentBase {
+    /** Assemble a template from existing stored sections. */
+    assemblyTemplate: Corti.GuidedAssemblyRequest;
+}

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

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

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

@@ -0,0 +1,8 @@
+import type * as Corti from "../index.js";
+/**
+ * Generate a document from a fully inline template definition supplied in the request body. Sections and the wrapping template are created and immediately published as auto-generated resources. At least one of `context` or `interactionId` must be supplied as input context for the model.
+ */
+export interface GuidedDocumentByDynamic extends Corti.GuidedDocumentBase {
+    /** Fully inline template defined in the request body. */
+    dynamicTemplate: Corti.GuidedDynamicRequest;
+}

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

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

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

@@ -0,0 +1,8 @@
+import type * as Corti from "../index.js";
+/**
+ * Generate a document using a stored template. Optionally supply runtime overrides to patch instructions or sections without mutating the base template. At least one of `context` or `interactionId` must be supplied as input context for the model.
+ */
+export interface GuidedDocumentByTemplateRef extends Corti.GuidedDocumentBase {
+    /** Reference an existing stored template, optionally with overrides. */
+    templateRef: Corti.GuidedTemplateRef;
+}

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

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

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

@@ -0,0 +1,2 @@
+import type * as Corti from "../index.js";
+export type GuidedDocumentContext = Corti.ContextText | Corti.ContextTranscript | Corti.ContextFacts;

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

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

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

@@ -0,0 +1,9 @@
+/**
+ * Minimal fact shape. Only `text` is required.
+ */
+export interface GuidedDocumentFactMinimal {
+    /** The text of the fact. */
+    text: string;
+    /** The group to which the fact belongs. */
+    group?: string;
+}

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

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

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

@@ -0,0 +1,2 @@
+import type * as Corti from "../index.js";
+export type GuidedDocumentRequest = Corti.GuidedDocumentByTemplateRef | Corti.GuidedDocumentByAssembly | Corti.GuidedDocumentByDynamic;

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

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

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

@@ -0,0 +1,7 @@
+import type * as Corti from "../index.js";
+/**
+ * Optional transcript-level metadata. All fields optional.
+ */
+export interface GuidedDocumentTranscriptMetadataMinimal {
+    participantsRoles?: Corti.TranscriptsParticipant[] | null;
+}

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

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

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

@@ -0,0 +1,8 @@
+import type * as Corti from "../index.js";
+/**
+ * Minimal transcript shape accepted as guided-document input context. Decoupled from the transcript resource: only `transcripts` is required, and within each segment only `text` is required.
+ */
+export interface GuidedDocumentTranscriptMinimal {
+    metadata?: Corti.GuidedDocumentTranscriptMetadataMinimal;
+    transcripts: Corti.GuidedDocumentTranscriptSegmentMinimal[];
+}

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

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

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

@@ -0,0 +1,17 @@
+/**
+ * Minimal transcript segment. Only `text` is required.
+ */
+export interface GuidedDocumentTranscriptSegmentMinimal {
+    /** The channel associated with this phrase/utterance. */
+    channel?: number;
+    /** The identifier of the participant. */
+    participant?: number;
+    /** Id to tag an identified speaker. */
+    speakerId?: number;
+    /** The spoken phrase or utterance. */
+    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/GuidedDocumentTranscriptSegmentMinimal.js

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

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

@@ -0,0 +1,5 @@
+import type * as Corti from "../index.js";
+export interface GuidedDynamicInline {
+    instructions: Corti.TemplateInstructions;
+    sections: Corti.SectionGeneration[];
+}

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

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

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

@@ -0,0 +1,8 @@
+import type * as Corti from "../index.js";
+/**
+ * Fully inline template definition. Sections and the wrapping template are created and immediately published as auto-generated resources.
+ */
+export interface GuidedDynamicRequest {
+    name: string;
+    generation: Corti.GuidedDynamicInline;
+}

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

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

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

@@ -0,0 +1,9 @@
+import type * as Corti from "../index.js";
+/**
+ * Override patch applied to a section linked to the base template version. Override semantics are per-field for `instructions` (any field you omit is inherited from the parent's published version) and wholesale for `outputSchema` (whatever you submit fully replaces the parent schema — partial schemas are not merged). The same rule applies when a section is forked via `inheritFromId`.
+ */
+export interface GuidedSectionOverride {
+    /** The UUID of a section linked to the base template version. */
+    sectionId: string;
+    generation?: Corti.SectionOverrides;
+}

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

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

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

@@ -0,0 +1,7 @@
+import type * as Corti from "../index.js";
+export interface GuidedTemplateOverrides {
+    /** Replaces the template-level instructions for this call. */
+    instructions?: Corti.TemplateInstructions;
+    /** Per-section override patches. Each entry must reference a section already linked to the base template version. */
+    sections?: Corti.GuidedSectionOverride[];
+}

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

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

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

@@ -0,0 +1,9 @@
+import type * as Corti from "../index.js";
+export interface GuidedTemplateRef {
+    /** The UUID of a stored template. */
+    templateId: string;
+    /** Optional explicit template version. Defaults to the template's published version when omitted. */
+    templateVersionId?: string | null;
+    /** Runtime overrides applied on top of the resolved template. When present, a new auto-generated template is persisted with `inheritedFromId` pointing at the base template. */
+    overrides?: Corti.GuidedTemplateOverrides;
+}

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

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

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

@@ -0,0 +1,4 @@
+export interface Label {
+    key: string;
+    value: string;
+}

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

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

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

@@ -0,0 +1,13 @@
+export interface NumberNode {
+    type: "number";
+    /** Can be used to prompt the LLM with more guidance in addition to the section.instructions */
+    description?: string;
+    /** The default to output if nothing to output. */
+    default?: number | null;
+    /** Can be used to prompt the LLM for specifically allowed numeric values to output. */
+    enum?: number[];
+    /** Use if a minimum value applies. */
+    minimum?: number | null;
+    /** Use if a maximum value applies. */
+    maximum?: number | null;
+}

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

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

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

@@ -0,0 +1,18 @@
+import type * as Corti from "../index.js";
+export interface ObjectNode {
+    type: "object";
+    /** Can be used to prompt the LLM with more guidance in addition to the section.instructions */
+    description?: string;
+    /**
+     * Free-form format string that controls how an object's fields are rendered into the final text output. Operates in one of two modes determined by which placeholders appear:
+     *
+     * **Subheading mode** (default: `"{key}: {value}\n"`): triggered when the format contains both `{key}` and `{value}`. Applied per field — each field becomes a key/value line. Fields that render to null are skipped.
+     *
+     * **Object mode** (e.g. `"{name} ({age})"`): triggered when `{key}` and `{value}` are absent. Placeholders must be actual field keys defined in `fields`. Applied once for the whole object, composing all fields into a single string. Fields rendering to null become empty string.
+     *
+     * Validation rules: format must not be empty; if either `{key}` or `{value}` appears, both must be present; in subheading mode no extra placeholders are allowed; in object mode every placeholder must match a defined field key.
+     */
+    fieldFormat?: string;
+    /** Define what fields are possible to return in the object. */
+    fields?: Corti.FieldDefinition[];
+}

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

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

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

@@ -0,0 +1,2 @@
+import type * as Corti from "../index.js";
+export type OutputSchema = Corti.StringNode | Corti.NumberNode | Corti.BoolNode | Corti.ObjectNode | Corti.ArrayNode;

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

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

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

@@ -0,0 +1,33 @@
+import type * as Corti from "../index.js";
+export interface Section {
+    /** 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.SectionSource;
+    /** 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.Label[];
+    /** The currently published version with section inheritance fully resolved. Present when a version has been published. */
+    publishedVersion?: Corti.SectionVersion;
+    /** 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;
+    /** Access policies for this section. */
+    policies?: Corti.SectionPolicy[];
+}

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

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

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

@@ -0,0 +1,8 @@
+import type * as Corti from "../index.js";
+export interface SectionGeneration {
+    /** The heading of this section. Passed to the LLM. */
+    heading: string;
+    /** The prompt instructions for this section. */
+    instructions: Corti.SectionInstructions;
+    outputSchema: Corti.OutputSchema;
+}