Formatting api spec update sr 2867

.fern/metadata.json

@@ -1,5 +1,5 @@
 {
-    "cliVersion": "5.75.1",
+    "cliVersion": "5.80.2",
     "generatorName": "fernapi/fern-typescript-node-sdk",
     "generatorVersion": "3.54.0",
     "generatorConfig": {
@@ -34,6 +34,6 @@
             }
         }
     },
-    "originGitCommit": "94a714862b705ee097af1b7ef3c5d9affa7fc382",
+    "originGitCommit": "418437d033993691064c6a7e6da108081b2a419f",
     "sdkVersion": "0.0.0-dev"
 }

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

@@ -516,7 +516,7 @@
      * This endpoint sends a message to the specified agent to start or continue a task. The agent processes the message and returns a response. If the message contains a task ID that matches an ongoing task, the agent will continue that task; otherwise, it will start a new task.
      *
      * @param {string} id - The identifier of the agent associated with the context.
-     * @param {Corti.AgentsMessageSendParams} request
+     * @param {Corti.AgentsMessageSendBody} request
      * @param {AgentsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Corti.BadRequestError}
@@ -540,15 +540,15 @@
      */
     public messageSend(
         id: string,
-        request: Corti.AgentsMessageSendParams,
+        request: Corti.AgentsMessageSendBody,
         requestOptions?: AgentsClient.RequestOptions,
     ): core.HttpResponsePromise<Corti.AgentsMessageSendResponse> {
         return core.HttpResponsePromise.fromPromise(this.__messageSend(id, request, requestOptions));
     }
 
     private async __messageSend(
         id: string,
-        request: Corti.AgentsMessageSendParams,
+        request: Corti.AgentsMessageSendBody,
         requestOptions?: AgentsClient.RequestOptions,
     ): Promise<core.WithRawResponse<Corti.AgentsMessageSendResponse>> {
         const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest();
@@ -569,7 +569,7 @@
             contentType: "application/json",
             queryParameters: requestOptions?.queryParams,
             requestType: "json",
-            body: serializers.AgentsMessageSendParams.jsonOrThrow(request, {
+            body: serializers.AgentsMessageSendBody.jsonOrThrow(request, {
                 unrecognizedObjectKeys: "strip",
                 omitUndefined: true,
             }),
@@ -792,7 +792,7 @@
                 case 404:
                     throw new Corti.NotFoundError(_response.error.body, _response.rawResponse);
                 default:
                     throw new errors.CortiError({
                         statusCode: _response.error.statusCode,
                         body: _response.error.body,
                         rawResponse: _response.rawResponse,
@@ -870,7 +870,7 @@
                 case 404:
                     throw new Corti.NotFoundError(_response.error.body, _response.rawResponse);
                 default:
                     throw new errors.CortiError({
                         statusCode: _response.error.statusCode,
                         body: _response.error.body,
                         rawResponse: _response.rawResponse,

src/api/resources/agents/client/requests/AgentsMessageSendParams.ts → src/api/resources/agents/client/requests/AgentsMessageSendBody.ts

@@ -16,7 +16,7 @@ import type * as Corti from "../../../../index.js";
  *         }
  *     }
  */
-export interface AgentsMessageSendParams {
+export interface AgentsMessageSendBody {
     message: Corti.AgentsMessage;
     configuration?: Corti.AgentsMessageSendConfiguration;
     /** Optional metadata that will be associated with the message. */

src/api/resources/agents/client/requests/index.ts

@@ -3,5 +3,5 @@ export type { AgentsGetContextRequest } from "./AgentsGetContextRequest.js";
 export type { AgentsGetRegistryExpertsRequest } from "./AgentsGetRegistryExpertsRequest.js";
 export type { AgentsGetTaskRequest } from "./AgentsGetTaskRequest.js";
 export type { AgentsListRequest } from "./AgentsListRequest.js";
-export type { AgentsMessageSendParams } from "./AgentsMessageSendParams.js";
+export type { AgentsMessageSendBody } from "./AgentsMessageSendBody.js";
 export type { AgentsUpdateAgent } from "./AgentsUpdateAgent.js";

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

@@ -23,7 +23,7 @@ export class CodesClient {
     }
 
     /**
-     * Predict medical codes from provided context.<br/><Note>This is a stateless endpoint, designed to predict ICD-10-CM, ICD-10-PCS, ICD-10 (international), ICD-10-UK, CIM-10-FR, ICD-10-GM, OPCS-4, OPS, CCAM and CPT codes based on input text string or documentId.<br/><br/>More than one code system may be defined in a single request.<br/><br/>Code prediction requests have two possible values for context:<br/>- `text`: One set of code prediction results will be returned based on all input text defined.<br/>- `documentId`: Code prediction will be based on that defined document only.<br/><br/>The response includes two sets of results:<br/>- `Codes`: Codes predicted by the model.<br/>- `Candidates`: Lower-confidence codes the model considered potentially relevant but excluded from the predicted set.<br/><br/>All predicted code results are based on input context defined in the request only (not other external data or assets associated with an interaction).</Note>
+     * Predict medical codes from provided context.<br/><Note>This is a stateless endpoint, designed to predict ICD-10-CM, ICD-10-PCS, ICD-10 (international), ICD-10-UK, CIM-10-FR, ICD-10-GM, OPCS-4, OPS, CCAM, CPT and SNOMED CT codes based on input text string or documentId.<br/><br/>More than one code system may be defined in a single request.<br/><br/>Code prediction requests have two possible values for context:<br/>- `text`: One set of code prediction results will be returned based on all input text defined.<br/>- `documentId`: Code prediction will be based on that defined document only.<br/><br/>The response includes two sets of results:<br/>- `Codes`: Codes predicted by the model.<br/>- `Candidates`: Lower-confidence codes the model considered potentially relevant but excluded from the predicted set.<br/><br/>All predicted code results are based on input context defined in the request only (not other external data or assets associated with an interaction).</Note>
      *
      * @param {Corti.CodesGeneralPredictRequest} request
      * @param {CodesClient.RequestOptions} requestOptions - Request-specific configuration.

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

@@ -18,6 +18,7 @@ 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. */

src/api/types/CommonCodingSystemEnum.ts

@@ -17,5 +17,12 @@ export const CommonCodingSystemEnum = {
     Ops: "ops",
     Ccam: "ccam",
     Snomedctint: "snomedctint",
+    Snomedctde: "snomedctde",
+    Snomedctfr: "snomedctfr",
+    Snomedctuk: "snomedctuk",
+    Snomedctes: "snomedctes",
+    Snomedctdk: "snomedctdk",
+    Snomedctse: "snomedctse",
+    Snomedctus: "snomedctus",
 } as const;
 export type CommonCodingSystemEnum = (typeof CommonCodingSystemEnum)[keyof typeof CommonCodingSystemEnum];

src/api/types/GuidedEphemeralDocument.ts

@@ -10,7 +10,7 @@ export interface GuidedEphemeralDocument {
     templateId: string;
     templateVersionId: string;
     /** The BCP 47 language tag of the generated output. */
-    language: string;
+    outputLanguage: string;
     /** The interaction whose context was used to generate this document, if supplied. */
     interactionId?: string | null;
     stringDocument: Record<string, string>;

src/api/types/StreamConfig.ts

@@ -8,6 +8,7 @@ export interface StreamConfig {
     /** Optional parameter to specify data retention policy for the generated transcripts and facts. Use value 'none' to indicate data should not be stored in the database. Use value 'retain' to indicate that the data should be retained according to standard retention policies. If configuration is not provided, then the default retention policy will apply. */
     retentionPolicy?: Corti.StreamConfigRetentionPolicy;
     audioEvents?: Corti.StreamAudioEventsConfig;
+    formatting?: Corti.StreamFormatting;
     /** Define the audio format of the incoming audio stream - optional but recommended. When omitted, the server auto-detects the format from the first audio chunk using ffprobe. Supported audio will be processed. Unsupported return an error but might in some cases error silently. If provided (recommended), the provided MIME type must be supported and the audio must match the MIME type. An unsupported MIME type results in `CONFIG_REJECTED`. Audio that differs from the MIME type will return audio validation errors on the socket. See full list of supported MIME types [here](/stt/audio). */
     audioFormat?: string;
     /** 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. */

src/api/types/StreamFormatting.ts

@@ -0,0 +1,18 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as Corti from "../index.js";
+
+export interface StreamFormatting {
+    /** Formatting for dates. */
+    dates?: Corti.StreamFormattingDates;
+    /** Formatting for times. */
+    times?: Corti.StreamFormattingTimes;
+    /** Formatting for numbers. */
+    numbers?: Corti.StreamFormattingNumbers;
+    /** Formatting for measurements. */
+    measurements?: Corti.StreamFormattingMeasurements;
+    /** Formatting for numeric ranges. */
+    numericRanges?: Corti.StreamFormattingNumericRanges;
+    /** Formatting for ordinals. */
+    ordinals?: Corti.StreamFormattingOrdinals;
+}

src/api/types/StreamFormattingDates.ts

@@ -0,0 +1,11 @@
+// This file was auto-generated by Fern from our API Definition.
+
+/** Formatting for dates. */
+export const StreamFormattingDates = {
+    LocaleLong: "locale:long",
+    LocaleMedium: "locale:medium",
+    LocaleShort: "locale:short",
+    AsDictated: "as_dictated",
+    Iso: "iso",
+} as const;
+export type StreamFormattingDates = (typeof StreamFormattingDates)[keyof typeof StreamFormattingDates];

src/api/types/StreamFormattingMeasurements.ts

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+
+/** Formatting for measurements. */
+export const StreamFormattingMeasurements = {
+    Abbreviated: "abbreviated",
+    AsDictated: "as_dictated",
+} as const;
+export type StreamFormattingMeasurements =
+    (typeof StreamFormattingMeasurements)[keyof typeof StreamFormattingMeasurements];

src/api/types/StreamFormattingNumbers.ts

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+
+/** Formatting for numbers. */
+export const StreamFormattingNumbers = {
+    NumeralsAboveNine: "numerals_above_nine",
+    Numerals: "numerals",
+    AsDictated: "as_dictated",
+} as const;
+export type StreamFormattingNumbers = (typeof StreamFormattingNumbers)[keyof typeof StreamFormattingNumbers];

src/api/types/StreamFormattingNumericRanges.ts

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+
+/** Formatting for numeric ranges. */
+export const StreamFormattingNumericRanges = {
+    Numerals: "numerals",
+    AsDictated: "as_dictated",
+} as const;
+export type StreamFormattingNumericRanges =
+    (typeof StreamFormattingNumericRanges)[keyof typeof StreamFormattingNumericRanges];

src/api/types/StreamFormattingOrdinals.ts

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+
+/** Formatting for ordinals. */
+export const StreamFormattingOrdinals = {
+    NumeralsAboveNine: "numerals_above_nine",
+    AsDictated: "as_dictated",
+    Numerals: "numerals",
+} as const;
+export type StreamFormattingOrdinals = (typeof StreamFormattingOrdinals)[keyof typeof StreamFormattingOrdinals];

src/api/types/StreamFormattingTimes.ts

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+
+/** Formatting for times. */
+export const StreamFormattingTimes = {
+    Locale: "locale",
+    H24: "h24",
+    H12: "h12",
+    AsDictated: "as_dictated",
+} as const;
+export type StreamFormattingTimes = (typeof StreamFormattingTimes)[keyof typeof StreamFormattingTimes];

src/api/types/TranscriptsFormatting.ts

@@ -0,0 +1,18 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type * as Corti from "../index.js";
+
+export interface TranscriptsFormatting {
+    /** Formatting for dates. */
+    dates?: Corti.TranscriptsFormattingDates;
+    /** Formatting for times. */
+    times?: Corti.TranscriptsFormattingTimes;
+    /** Formatting for numbers. */
+    numbers?: Corti.TranscriptsFormattingNumbers;
+    /** Formatting for measurements. */
+    measurements?: Corti.TranscriptsFormattingMeasurements;
+    /** Formatting for numeric ranges. */
+    numericRanges?: Corti.TranscriptsFormattingNumericRanges;
+    /** Formatting for ordinals. */
+    ordinals?: Corti.TranscriptsFormattingOrdinals;
+}

src/api/types/TranscriptsFormattingDates.ts

@@ -0,0 +1,11 @@
+// This file was auto-generated by Fern from our API Definition.
+
+/** Formatting for dates. */
+export const TranscriptsFormattingDates = {
+    LocaleLong: "locale:long",
+    LocaleMedium: "locale:medium",
+    LocaleShort: "locale:short",
+    AsDictated: "as_dictated",
+    Iso: "iso",
+} as const;
+export type TranscriptsFormattingDates = (typeof TranscriptsFormattingDates)[keyof typeof TranscriptsFormattingDates];

src/api/types/TranscriptsFormattingMeasurements.ts

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+
+/** Formatting for measurements. */
+export const TranscriptsFormattingMeasurements = {
+    Abbreviated: "abbreviated",
+    AsDictated: "as_dictated",
+} as const;
+export type TranscriptsFormattingMeasurements =
+    (typeof TranscriptsFormattingMeasurements)[keyof typeof TranscriptsFormattingMeasurements];

src/api/types/TranscriptsFormattingNumbers.ts

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+
+/** Formatting for numbers. */
+export const TranscriptsFormattingNumbers = {
+    NumeralsAboveNine: "numerals_above_nine",
+    Numerals: "numerals",
+    AsDictated: "as_dictated",
+} as const;
+export type TranscriptsFormattingNumbers =
+    (typeof TranscriptsFormattingNumbers)[keyof typeof TranscriptsFormattingNumbers];

src/api/types/TranscriptsFormattingNumericRanges.ts

@@ -0,0 +1,9 @@
+// This file was auto-generated by Fern from our API Definition.
+
+/** Formatting for numeric ranges. */
+export const TranscriptsFormattingNumericRanges = {
+    Numerals: "numerals",
+    AsDictated: "as_dictated",
+} as const;
+export type TranscriptsFormattingNumericRanges =
+    (typeof TranscriptsFormattingNumericRanges)[keyof typeof TranscriptsFormattingNumericRanges];

src/api/types/TranscriptsFormattingOrdinals.ts

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+
+/** Formatting for ordinals. */
+export const TranscriptsFormattingOrdinals = {
+    NumeralsAboveNine: "numerals_above_nine",
+    AsDictated: "as_dictated",
+    Numerals: "numerals",
+} as const;
+export type TranscriptsFormattingOrdinals =
+    (typeof TranscriptsFormattingOrdinals)[keyof typeof TranscriptsFormattingOrdinals];

src/api/types/TranscriptsFormattingTimes.ts

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+
+/** Formatting for times. */
+export const TranscriptsFormattingTimes = {
+    Locale: "locale",
+    H24: "h24",
+    H12: "h12",
+    AsDictated: "as_dictated",
+} as const;
+export type TranscriptsFormattingTimes = (typeof TranscriptsFormattingTimes)[keyof typeof TranscriptsFormattingTimes];

src/api/types/index.ts

@@ -214,6 +214,13 @@ export * from "./StreamFact.js";
 export * from "./StreamFactsMessage.js";
 export * from "./StreamFlushedMessage.js";
 export * from "./StreamFlushMessage.js";
+export * from "./StreamFormatting.js";
+export * from "./StreamFormattingDates.js";
+export * from "./StreamFormattingMeasurements.js";
+export * from "./StreamFormattingNumbers.js";
+export * from "./StreamFormattingNumericRanges.js";
+export * from "./StreamFormattingOrdinals.js";
+export * from "./StreamFormattingTimes.js";
 export * from "./StreamParticipant.js";
 export * from "./StreamSupportedLanguage.js";
 export * from "./StreamTranscript.js";
@@ -265,6 +272,13 @@ export * from "./TranscribeTranscriptData.js";
 export * from "./TranscribeTranscriptMessage.js";
 export * from "./TranscribeUsageMessage.js";
 export * from "./TranscriptsData.js";
+export * from "./TranscriptsFormatting.js";
+export * from "./TranscriptsFormattingDates.js";
+export * from "./TranscriptsFormattingMeasurements.js";
+export * from "./TranscriptsFormattingNumbers.js";
+export * from "./TranscriptsFormattingNumericRanges.js";
+export * from "./TranscriptsFormattingOrdinals.js";
+export * from "./TranscriptsFormattingTimes.js";
 export * from "./TranscriptsListItem.js";
 export * from "./TranscriptsListResponse.js";
 export * from "./TranscriptsMetadata.js";

src/serialization/resources/agents/client/requests/AgentsMessageSendParams.ts → src/serialization/resources/agents/client/requests/AgentsMessageSendBody.ts

@@ -6,16 +6,16 @@ import type * as serializers from "../../../../index.js";
 import { AgentsMessage } from "../../../../types/AgentsMessage.js";
 import { AgentsMessageSendConfiguration } from "../../../../types/AgentsMessageSendConfiguration.js";
 
-export const AgentsMessageSendParams: core.serialization.Schema<
-    serializers.AgentsMessageSendParams.Raw,
-    Corti.AgentsMessageSendParams
+export const AgentsMessageSendBody: core.serialization.Schema<
+    serializers.AgentsMessageSendBody.Raw,
+    Corti.AgentsMessageSendBody
 > = core.serialization.object({
     message: AgentsMessage,
     configuration: AgentsMessageSendConfiguration.optional(),
     metadata: core.serialization.record(core.serialization.string(), core.serialization.unknown()).optional(),
 });
 
-export declare namespace AgentsMessageSendParams {
+export declare namespace AgentsMessageSendBody {
     export interface Raw {
         message: AgentsMessage.Raw;
         configuration?: AgentsMessageSendConfiguration.Raw | null;

src/serialization/resources/agents/client/requests/index.ts

@@ -1,3 +1,3 @@
 export { AgentsCreateAgent } from "./AgentsCreateAgent.js";
-export { AgentsMessageSendParams } from "./AgentsMessageSendParams.js";
+export { AgentsMessageSendBody } from "./AgentsMessageSendBody.js";
 export { AgentsUpdateAgent } from "./AgentsUpdateAgent.js";

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

@@ -3,6 +3,7 @@
 import type * as Corti from "../../../../../api/index.js";
 import * as core from "../../../../../core/index.js";
 import type * as serializers from "../../../../index.js";
+import { TranscriptsFormatting } from "../../../../types/TranscriptsFormatting.js";
 import { TranscriptsParticipant } from "../../../../types/TranscriptsParticipant.js";
 import { Uuid } from "../../../../types/Uuid.js";
 import { TranscriptsCreateRequestKeyterms } from "../../types/TranscriptsCreateRequestKeyterms.js";
@@ -16,6 +17,7 @@ export const TranscriptsCreateRequest: core.serialization.Schema<
     primaryLanguage: core.serialization.string(),
     spokenPunctuation: core.serialization.boolean().optional(),
     automaticPunctuation: core.serialization.boolean().optional(),
+    formatting: TranscriptsFormatting.optional(),
     isDictation: core.serialization.boolean().optional(),
     isMultichannel: core.serialization.boolean().optional(),
     diarize: core.serialization.boolean().optional(),
@@ -31,6 +33,7 @@ export declare namespace TranscriptsCreateRequest {
         primaryLanguage: string;
         spokenPunctuation?: boolean | null;
         automaticPunctuation?: boolean | null;
+        formatting?: TranscriptsFormatting.Raw | null;
         isDictation?: boolean | null;
         isMultichannel?: boolean | null;
         diarize?: boolean | null;

src/serialization/types/CommonCodingSystemEnum.ts

@@ -24,6 +24,13 @@ export const CommonCodingSystemEnum: core.serialization.Schema<
     "ops",
     "ccam",
     "snomedctint",
+    "snomedctde",
+    "snomedctfr",
+    "snomedctuk",
+    "snomedctes",
+    "snomedctdk",
+    "snomedctse",
+    "snomedctus",
 ]);
 
 export declare namespace CommonCodingSystemEnum {
@@ -43,5 +50,12 @@ export declare namespace CommonCodingSystemEnum {
         | "opcs4"
         | "ops"
         | "ccam"
-        | "snomedctint";
+        | "snomedctint"
+        | "snomedctde"
+        | "snomedctfr"
+        | "snomedctuk"
+        | "snomedctes"
+        | "snomedctdk"
+        | "snomedctse"
+        | "snomedctus";
 }