Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .fern/metadata.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"cliVersion": "5.93.0",
"cliVersion": "5.110.0",
"generatorName": "fernapi/fern-typescript-node-sdk",
"generatorVersion": "3.54.0",
"generatorConfig": {
Expand Down Expand Up @@ -34,6 +34,6 @@
}
}
},
"originGitCommit": "c993f464ca70e6cae3f0b9700d2b6e2109527ba4",
"originGitCommit": "b955ac54dd45b5a72c6ebd051fb6ba0f1c6ff499",
"sdkVersion": "0.0.0-dev"
}
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,8 @@ export interface AgenticAgentsCreateRequest {
systemPrompt?: string;
/** Tenant default if omitted. */
model?: string;
/** Caps the orchestrator's ReAct loop iterations per run. Server default 10 if omitted. */
maxLoops?: number;
visibility?: Corti.AgentsVisibility;
lifecycle?: Corti.AgentsLifecycle;
/** Connectors to attach at creation. Defaults to an empty array. */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ export interface AgenticAgentsPatchRequest {
systemPrompt?: string | null;
/** New model identifier; `null` falls back to the tenant default. */
model?: string | null;
/** New cap on the orchestrator's ReAct loop iterations per run. Omitted leaves the current value unchanged; there is no `null`-reset — send 10 to restore the default. */
maxLoops?: number;
visibility?: Corti.AgentsVisibility;
lifecycle?: Corti.AgentsLifecycle;
/** Replacement connector list; `null` clears connectors. */
Expand Down
7 changes: 5 additions & 2 deletions src/api/resources/codes/client/Client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,11 @@ export class CodesClient {
* text: "Patient presents with uncontrolled type 2 diabetes."
* }],
* filter: {
* include: ["E11"],
* exclude: ["exclude"]
* include: [{
* property: "code",
* op: "is-a",
* value: ["E11"]
* }]
* }
* })
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,11 @@ import type * as Corti from "../../../../index.js";
* text: "Patient presents with uncontrolled type 2 diabetes."
* }],
* filter: {
* include: ["E11"],
* exclude: ["exclude"]
* include: [{
* property: "code",
* op: "is-a",
* value: ["E11"]
* }]
* }
* }
*/
Expand Down
20 changes: 20 additions & 0 deletions src/api/resources/documents/resources/classic/client/Client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@ export class ClassicClient {
*
* List Documents
*
* <Note>
* This endpoint is deprecated in favour of the corresponding GUIDED endpoint. See the [deprecation notice](/release-notes/changelog-upcoming#2026-08-21) for more details and migration guidance.
* </Note>
*
* @param {Corti.Uuid} id - The unique identifier of the interaction. Must be a valid UUID.
* @param {ClassicClient.RequestOptions} requestOptions - Request-specific configuration.
*
Expand Down Expand Up @@ -129,6 +133,10 @@ export class ClassicClient {
*
* This endpoint offers different ways to generate a document. Find guides to document generation [here](/textgen/documents-standard).
*
* <Note>
* This endpoint is deprecated in favour of the corresponding GUIDED endpoint. See the [deprecation notice](/release-notes/changelog-upcoming#2026-08-21) for more details and migration guidance.
* </Note>
*
* @param {Corti.Uuid} id - The unique identifier of the interaction. Must be a valid UUID.
* @param {Corti.DocumentsCreateRequest} request
* @param {ClassicClient.RequestOptions} requestOptions - Request-specific configuration.
Expand Down Expand Up @@ -254,6 +262,10 @@ export class ClassicClient {
*
* Get Document.
*
* <Note>
* This endpoint is deprecated in favour of the corresponding GUIDED endpoint. See the [deprecation notice](/release-notes/changelog-upcoming#2026-08-21) for more details and migration guidance.
* </Note>
*
* @param {Corti.Uuid} id - The unique identifier of the interaction. Must be a valid UUID.
* @param {Corti.Uuid} documentId - The document ID representing the context for the request. Must be a valid UUID.
* @param {ClassicClient.RequestOptions} requestOptions - Request-specific configuration.
Expand Down Expand Up @@ -362,6 +374,10 @@ export class ClassicClient {
/**
* @deprecated
*
* <Note>
* This endpoint is deprecated in favour of the corresponding GUIDED endpoint. See the [deprecation notice](/release-notes/changelog-upcoming#2026-08-21) for more details and migration guidance.
* </Note>
*
* @param {Corti.Uuid} id - The unique identifier of the interaction. Must be a valid UUID.
* @param {Corti.Uuid} documentId - The document ID representing the context for the request. Must be a valid UUID.
* @param {ClassicClient.RequestOptions} requestOptions - Request-specific configuration.
Expand Down Expand Up @@ -461,6 +477,10 @@ export class ClassicClient {
/**
* @deprecated
*
* <Note>
* This endpoint is deprecated in favour of the corresponding GUIDED endpoint. See the [deprecation notice](/release-notes/changelog-upcoming#2026-08-21) for more details and migration guidance.
* </Note>
*
* @param {Corti.Uuid} id - The unique identifier of the interaction. Must be a valid UUID.
* @param {Corti.Uuid} documentId - The document ID representing the context for the request. Must be a valid UUID.
* @param {Corti.documents.DocumentsUpdateRequest} request
Expand Down
18 changes: 18 additions & 0 deletions src/api/resources/templates/client/Client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,14 @@ export class TemplatesClient {
}

/**
* @deprecated
*
* Retrieves a list of template sections with optional filters for organization and language.
*
* <Note>
* This endpoint is deprecated in favour of the corresponding GUIDED endpoint. See the [deprecation notice](/release-notes/changelog-upcoming#2026-08-21) for more details and migration guidance.
* </Note>
*
* @param {Corti.TemplatesSectionListRequest} request
* @param {TemplatesClient.RequestOptions} requestOptions - Request-specific configuration.
*
Expand Down Expand Up @@ -113,8 +119,14 @@ export class TemplatesClient {
}

/**
* @deprecated
*
* Retrieves a list of templates with optional filters for organization, language, and status.
*
* <Note>
* This endpoint is deprecated in favour of the corresponding GUIDED endpoint. See the [deprecation notice](/release-notes/changelog-upcoming#2026-08-21) for more details and migration guidance.
* </Note>
*
* @param {Corti.TemplatesListRequest} request
* @param {TemplatesClient.RequestOptions} requestOptions - Request-specific configuration.
*
Expand Down Expand Up @@ -204,8 +216,14 @@ export class TemplatesClient {
}

/**
* @deprecated
*
* Retrieves template by key.
*
* <Note>
* This endpoint is deprecated in favour of the corresponding GUIDED endpoint. See the [deprecation notice](/release-notes/changelog-upcoming#2026-08-21) for more details and migration guidance.
* </Note>
*
* @param {string} key - The key of the template
* @param {TemplatesClient.RequestOptions} requestOptions - Request-specific configuration.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,21 @@ export interface TranscriptsCreateRequest {
spokenPunctuation?: boolean;
/** When true, automatically punctuates and capitalizes the transcript. Defaults to true. Overridden by `spokenPunctuation` when both are enabled. */
automaticPunctuation?: boolean;
formatting?: Corti.TranscriptsFormatting;
/** **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;
/** If true, separates speakers within an audio channel returning incrementing ids for transcript segments. */
diarize?: boolean;
/** An array of participants, each specifying a role and an assigned audio channel in the recording. Leave empty when shouldDiarize: true */
/** An array of participants, each specifying a free-form role and an assigned audio channel in the recording. For raw PCM, the channel count must be defined; otherwise, the number of audio channels is resolved from the audio itself, not from the declared participants. Leave empty when diarize: true. See [audio formatting](https://docs.corti.ai/stt/audio) for full details. */
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;
/** When enabled, the transcript is stored and returned at word level instead of phrase/utterance level. Fixed for the lifetime of the transcript once created. */
wordLevel?: Corti.TranscriptsCreateRequestWordLevel;
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
// This file was auto-generated by Fern from our API Definition.

/**
* When enabled, the transcript is stored and returned at word level instead of phrase/utterance level. Fixed for the lifetime of the transcript once created.
*/
export interface TranscriptsCreateRequestWordLevel {
enabled?: boolean;
}
1 change: 1 addition & 0 deletions src/api/resources/transcripts/types/index.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
export * from "./TranscriptsCreateRequestKeyterms.js";
export * from "./TranscriptsCreateRequestKeytermsTermsItem.js";
export * from "./TranscriptsCreateRequestReplacementsItem.js";
export * from "./TranscriptsCreateRequestWordLevel.js";
4 changes: 4 additions & 0 deletions src/api/types/AgenticAgentsResponse.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ export interface AgenticAgentsResponse {
* **Open question** — in the current implementation a model is configured per *expert*, not per *agent* (`Expert.modelName`), and an `Agent` has no model field at all. The desired end state is that there is **no distinction between an expert and an agent**, so `model` lives uniformly on this resource. Until that convergence lands, the precedence of an agent-level `model` over a connector/expert-level override is undecided and MUST be resolved before this field ships.
*/
model?: string | null;
/** Effective cap on the orchestrator's ReAct loop iterations per run. Always present: agents created without `maxLoops` report the server default (10). */
maxLoops: number;
visibility: Corti.AgentsVisibility;
lifecycle: Corti.AgentsLifecycle;
/** Connectors attached to the agent, discriminated by `type`. */
Expand All @@ -29,4 +31,6 @@ export interface AgenticAgentsResponse {
updatedAt?: Date;
/** Principal (user or service principal) that created the agent. */
createdBy?: Corti.AgentsUserIdValue;
/** When the agent expires; `null` means it does not expire. Ephemeral agents get a 24h expiry at creation time; persistent agents never expire. */
expiresAt?: Date | null;
}
12 changes: 6 additions & 6 deletions src/api/types/CodesFilter.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
// This file was auto-generated by Fern from our API Definition.

import type * as Corti from "../index.js";

/**
* Optional filter to restrict the set of codes the model can predict.
*/
export interface CodesFilter {
/** Codes or categories to include. When empty, the full set of codes for the requested systems is used. */
include?: string[];
/** Codes or categories to subtract from the include set. */
exclude?: string[];
/** When true (default), category codes are expanded to their leaf codes. */
expand?: boolean;
/** Condition objects to include. When empty, the full set of codes for the requested systems is used. */
include?: Corti.CodesFilterCondition[];
/** Condition objects to subtract from the include set. */
exclude?: Corti.CodesFilterCondition[];
}
15 changes: 15 additions & 0 deletions src/api/types/CodesFilterCondition.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
// This file was auto-generated by Fern from our API Definition.

import type * as Corti from "../index.js";

/**
* Single property/op/value filter clause for attribute-based code filtering.
*/
export interface CodesFilterCondition {
/** The attribute to filter on. */
property: string;
/** Comparison operator: `=` (equal), `is-a` (code plus descendants), `descendent-of` (strict descendants), `exists` (`value: true`/`false` for set/unset), `in` (membership). */
op?: Corti.CodesFilterConditionOp;
/** Comparison value; type depends on `op`. */
value: Corti.CodesFilterConditionValue;
}
11 changes: 11 additions & 0 deletions src/api/types/CodesFilterConditionOp.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
// This file was auto-generated by Fern from our API Definition.

/** Comparison operator: `=` (equal), `is-a` (code plus descendants), `descendent-of` (strict descendants), `exists` (`value: true`/`false` for set/unset), `in` (membership). */
export const CodesFilterConditionOp = {
EqualTo: "=",
IsA: "is-a",
DescendentOf: "descendent-of",
Exists: "exists",
In: "in",
} as const;
export type CodesFilterConditionOp = (typeof CodesFilterConditionOp)[keyof typeof CodesFilterConditionOp];
6 changes: 6 additions & 0 deletions src/api/types/CodesFilterConditionValue.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
// This file was auto-generated by Fern from our API Definition.

/**
* Comparison value; type depends on `op`.
*/
export type CodesFilterConditionValue = string | boolean | number | string[];
2 changes: 1 addition & 1 deletion src/api/types/CommonTranscriptResponse.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ export interface CommonTranscriptResponse {
participant: number;
/** Id to tag an identified speaker. Auto-increments. */
speakerId: number;
/** The spoken phrase or utterance extracted from the audio. */
/** The spoken phrase or utterance extracted from the audio. Will be a single word or entity if `wordLevel.enabled` was set to `true` when the transcript was created. */
text: string;
/** Start time in milliseconds for phrase/utterance. */
start: number;
Expand Down
2 changes: 2 additions & 0 deletions src/api/types/GuidedArrayNode.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,6 @@ export interface GuidedArrayNode {
minItems?: number | null;
/** Maximum number of array items to generate. */
maxItems?: number | null;
/** Text rendered in place of the array when no items have relevant input/output. */
fallbackString?: string | null;
}
3 changes: 2 additions & 1 deletion src/api/types/GuidedAssemblySectionRef.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,6 @@ export interface GuidedAssemblySectionRef {
sectionId: string;
/** Optional explicit section version. Defaults to the section's published version when omitted. */
sectionVersionId?: string | null;
overrides?: Corti.GuidedSectionOverrides;
/** Runtime override patch for this section. `generation` is the canonical shape. The flat fields are deprecated. */
overrides?: Corti.GuidedSectionOverridePatch;
}
2 changes: 2 additions & 0 deletions src/api/types/GuidedObjectNode.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,6 @@ export interface GuidedObjectNode {
fieldFormat?: string;
/** Define what fields are possible to return in the object. */
fields?: Corti.GuidedFieldDefinition[];
/** Text rendered in place of the object when no field has relevant input/output and no field-level `default` is set. */
fallbackString?: string | null;
}
3 changes: 1 addition & 2 deletions src/api/types/GuidedSectionOverride.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@ 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 {
export interface GuidedSectionOverride extends Corti.GuidedSectionOverridePatch {
/** The UUID of a section linked to the base template version. */
sectionId: string;
generation?: Corti.GuidedSectionOverrides;
}
17 changes: 17 additions & 0 deletions src/api/types/GuidedSectionOverridePatch.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
// This file was auto-generated by Fern from our API Definition.

import type * as Corti from "../index.js";

/**
* Per-section override patch. `generation` is the canonical shape. The flat `heading`, `instructions`, and `outputSchema` fields are deprecated and remain for backward compatibility. Use `generation` instead. If a request sets both `generation` and a flat field for one section, the server rejects it with a 400. Override semantics are per-field for `instructions` and wholesale for `outputSchema`.
*/
export interface GuidedSectionOverridePatch {
/** The canonical override patch for this section. */
generation?: Corti.GuidedSectionOverrides;
/** **Deprecated** — use `generation.heading`. Replaces the section's heading for this call. */
heading?: string | null;
/** **Deprecated** — use `generation.instructions`. */
instructions?: Corti.GuidedSectionInstructionsOverride;
/** **Deprecated** — use `generation.outputSchema`. */
outputSchema?: Corti.GuidedOutputSchema;
}
9 changes: 7 additions & 2 deletions src/api/types/GuidedTemplateOverrides.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,14 @@

import type * as Corti from "../index.js";

/**
* Template-level override patch. `generation` is the canonical shape. The flat `instructions` and `sections` fields are deprecated and remain for backward compatibility. Use `generation` instead. If a request sets both `generation` and a flat field, the server rejects it with a 400.
*/
export interface GuidedTemplateOverrides {
/** Replaces the template-level instructions for this call. */
/** The canonical override wrapper for this template. */
generation?: Corti.GuidedTemplateOverridesGeneration;
/** **Deprecated** — use `generation.instructions`. Replaces the template-level instructions for this call. */
instructions?: Corti.GuidedTemplateInstructions;
/** Per-section override patches. Each entry must reference a section already linked to the base template version. */
/** **Deprecated** — use `generation.sections`. Per-section override patches. Each entry must reference a section already linked to the base template version. */
sections?: Corti.GuidedSectionOverride[];
}
13 changes: 13 additions & 0 deletions src/api/types/GuidedTemplateOverridesGeneration.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
// This file was auto-generated by Fern from our API Definition.

import type * as Corti from "../index.js";

/**
* The canonical template-level override wrapper. Holds the template instructions and the per-section override patches.
*/
export interface GuidedTemplateOverridesGeneration {
/** Replaces the template-level instructions for this call. */
instructions?: Corti.GuidedTemplateInstructions;
/** Per-section override patches. Each entry must reference a section already linked to the base template version. */
sections?: Corti.GuidedSectionOverride[];
}
Loading
Loading