Skip to content

Commit ef0face

Browse files
committed
SDK regeneration
1 parent 40a3272 commit ef0face

59 files changed

Lines changed: 210 additions & 477 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.fern/metadata.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"cliVersion": "5.37.0",
2+
"cliVersion": "5.44.12",
33
"generatorName": "fernapi/fern-typescript-node-sdk",
44
"generatorVersion": "3.54.0",
55
"generatorConfig": {
@@ -34,6 +34,6 @@
3434
}
3535
}
3636
},
37-
"originGitCommit": "8e989c9a6a80dc531465701ae566693052ae7ba0",
37+
"originGitCommit": "c3d6dde8096274347b7b05287068ac54592ee41e",
3838
"sdkVersion": "0.0.0-dev"
3939
}

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
node_modules
22
.DS_Store
3-
/dist
3+
/dist

src/api/resources/documents/resources/sections/client/Client.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,9 @@ export class SectionsClient {
2929
}
3030

3131
/**
32+
* Returns a list of sections and their metadata. Fetch a sectionId to get the full generation content.
33+
* Use query parameters to filter by language, region, specialty, label, publish status, or source.
34+
*
3235
* @param {Corti.documents.GuidedSectionsListRequest} request
3336
* @param {SectionsClient.RequestOptions} requestOptions - Request-specific configuration.
3437
*
@@ -358,6 +361,9 @@ export class SectionsClient {
358361
}
359362

360363
/**
364+
* Updates the section's metadata fields (name, description, languages, regions, specialties, labels).
365+
* Generation content (instructions, output schema) is managed through versions and cannot be updated here.
366+
*
361367
* @param {string} sectionID
362368
* @param {Corti.documents.GuidedSectionsUpdateRequest} request
363369
* @param {SectionsClient.RequestOptions} requestOptions - Request-specific configuration.

src/api/resources/documents/resources/templates/client/Client.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,9 @@ export class TemplatesClient {
2929
}
3030

3131
/**
32+
* Returns a list of templates and their metadata. Fetch a specific templateId to get the expanded sections.
33+
* Use query parameters to filter by language, region, specialty, label, publish status, or source.
34+
*
3235
* @param {Corti.documents.GuidedTemplatesListRequest} request
3336
* @param {TemplatesClient.RequestOptions} requestOptions - Request-specific configuration.
3437
*
@@ -354,6 +357,10 @@ export class TemplatesClient {
354357
}
355358

356359
/**
360+
* Updates the template's metadata fields (name, description, languages, regions, specialties, labels).
361+
* Generation content (template instructions, section composition) is managed through versions
362+
* and cannot be updated here.
363+
*
357364
* @param {string} templateID
358365
* @param {Corti.documents.GuidedTemplatesUpdateRequest} request
359366
* @param {TemplatesClient.RequestOptions} requestOptions - Request-specific configuration.

src/api/resources/documents/resources/templates/resources/versions/client/Client.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@ export class VersionsClient {
2626
}
2727

2828
/**
29+
* Returns raw authored template versions without inheritance resolution or section expansion.
30+
* To see resolved content, use GET /documents/templates/{templateID} instead.
31+
*
2932
* @param {string} templateID
3033
* @param {VersionsClient.RequestOptions} requestOptions - Request-specific configuration.
3134
*
@@ -194,6 +197,9 @@ export class VersionsClient {
194197
}
195198

196199
/**
200+
* Returns the raw authored template version without inheritance resolution or section expansion.
201+
* To see resolved content, use GET /documents/templates/{templateID} instead.
202+
*
197203
* @param {string} templateID
198204
* @param {string} versionID
199205
* @param {VersionsClient.RequestOptions} requestOptions - Request-specific configuration.

src/api/resources/transcripts/client/Client.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ export class TranscriptsClient {
138138
}
139139

140140
/**
141-
* Create a transcript from an audio file uploaded to the interaction via `/recordings` endpoint.<br/><Note>Each interaction may have more than one audio file and transcript associated with it. Audio files up to 60 min in total duration, or 150 MB in total size, may be used.<br/><br/>Requests will process synchronously for 25 seconds before timeout, upon which processing will continue asynchronously. In the latter scenario, a partial or empty transcript with `status=processing` will be returned with a location header that can be used to retrieve the completed transcript.<br/><br/>The client can poll the `/transcripts` endpoint (`GET /interactions/{id}/transcripts/{transcriptId}/status`) for transcript status monitoring:<br/>- `200 OK` with status `processing`, `completed`, or `failed`<br/>- `404 Not Found` if the `interactionId` or `transcriptId` are invalid<br/><br/>The completed transcript can be retrieved via the Get Transcript request (`GET /interactions/{id}/transcripts/{transcriptId}/`).</Note>
141+
* Create a transcript from an audio file uploaded to the interaction via `/recordings` endpoint.<br/><Note>Each interaction may have more than one audio file and transcript associated with it. Audio files up to 60 min in total duration, or 150 MB in total size, may be used.<br/><br/>By default, requests will process synchronously for 25 seconds before timeout, upon which processing will continue asynchronously. Set the `async` parameter to true to receive the location header immediately and process the request asynchronously. Read more [here](https://docs.corti.ai/stt/transcripts).</Note>
142142
*
143143
* @param {Corti.Uuid} id - The unique identifier of the interaction. Must be a valid UUID.
144144
* @param {Corti.TranscriptsCreateRequest} request

src/api/resources/transcripts/client/requests/TranscriptsCreateRequest.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,14 @@ export interface TranscriptsCreateRequest {
1414
recordingId: Corti.Uuid;
1515
/** The primary spoken language of the recording. Check https://docs.corti.ai/stt/languages for more. */
1616
primaryLanguage: string;
17-
/** Indicates whether spoken dictation commands should be converted to punctuation (e.g., 'comma' → ','). */
17+
/** If true, spoken punctuation will be converted to symbols (e.g., 'comma' → ','). */
1818
isDictation?: boolean;
1919
/** If true, each audio channel is transcribed separately. */
2020
isMultichannel?: boolean;
2121
/** If true, separates speakers within an audio channel returning incrementing ids for transcript segments. */
2222
diarize?: boolean;
2323
/** An array of participants, each specifying a role and an assigned audio channel in the recording. Leave empty when shouldDiarize: true */
2424
participants?: Corti.TranscriptsParticipant[];
25+
/** 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`. */
26+
async?: boolean;
2527
}

src/api/types/CommonFactsContext.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
import type * as Corti from "../index.js";
44

55
/**
6-
* A single fact provided as input context to the model.
6+
* A list of facts provided as input context to the model.
77
*/
88
export interface CommonFactsContext {
99
type: "facts";
10-
fact: Corti.GuidedDocumentFactMinimal;
10+
facts: Corti.GuidedDocumentFactMinimal[];
1111
}

src/api/types/GuidedArrayNode.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,11 @@ import type * as Corti from "../index.js";
44

55
export interface GuidedArrayNode {
66
type: "array";
7-
/** Can be used to prompt the LLM with more guidance in addition to the section.instructions */
7+
/** Guide the LLM in what to output for this node. Supplements the section-level instructions. */
88
description?: string;
9+
/** Must be another output schema node (string, number, boolean, array, or object). */
910
items: Corti.GuidedOutputSchema;
10-
/** Controls how each array item is rendered in the generated output. Use `bullet` (default), `numbered`, or `plain`, or provide a custom format string containing the `{item}` placeholder. */
11+
/** Format string used to render each array item in the generated output. Use the `{item}` placeholder for the item value. */
1112
itemFormat?: string;
1213
/** Minimum number of array items to generate. */
1314
minItems?: number | null;

src/api/types/GuidedBoolNode.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
export interface GuidedBoolNode {
44
type: "boolean";
5-
/** Can be used to prompt the LLM with more guidance in addition to the section.instructions */
5+
/** Guide the LLM in what to output for this node. Supplements the section-level instructions. */
66
description?: string;
7-
/** The default to output if nothing to output. */
7+
/** If nothing is outputted, this default is used. */
88
default?: boolean | null;
99
}

0 commit comments

Comments
 (0)