@corti/sdk 1.0.0-alpha → 1.0.0-alpha.2

package/README.md

@@ -1,14 +1,14 @@
-# Corti TypeScript Library
+# Corti JavaScript Library
 
 [![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fcorticph%2Fcorti-sdk-javascript)
 [![npm shield](https://img.shields.io/npm/v/@corti/sdk)](https://www.npmjs.com/package/@corti/sdk)
 
-The Corti TypeScript library provides convenient access to the Corti APIs from TypeScript.
+The Corti JavaScript library provides convenient access to the Corti APIs from JavaScript and TypeScript.
 
 ## Table of Contents
 
+- [Documentation](#documentation)
 - [Installation](#installation)
-- [Reference](#reference)
 - [Usage](#usage)
 - [Authentication](#authentication)
 - [Request and Response Types](#request-and-response-types)
@@ -17,7 +17,6 @@ The Corti TypeScript library provides convenient access to the Corti APIs from T
 - [Binary Response](#binary-response)
 - [Pagination](#pagination)
 - [Advanced](#advanced)
-  - [Subpackage Exports](#subpackage-exports)
   - [Additional Headers](#additional-headers)
   - [Additional Query String Parameters](#additional-query-string-parameters)
   - [Retries](#retries)
@@ -28,58 +27,133 @@ The Corti TypeScript library provides convenient access to the Corti APIs from T
   - [Runtime Compatibility](#runtime-compatibility)
 - [Contributing](#contributing)
 
+## Documentation
+
+- [Documentation](https://docs.corti.ai/)
+- [API Reference](https://docs.corti.ai/api-reference)
+- [Console](https://console.corti.app/) — get your credentials here
+- [Examples](https://github.com/corticph/corti-examples)
+
 ## Installation
 
 ```sh
 npm i -s @corti/sdk
 ```
 
-## Reference
-
-A full reference for this library is available [here](https://github.com/corticph/corti-sdk-javascript/blob/HEAD/./reference.md).
-
 ## Usage
 
 Instantiate and use the client with the following:
 
 ```typescript
-import { CortiClient, CortiEnvironment } from "@corti/sdk";
+import { CortiClient } from "@corti/sdk";
 
-const client = new CortiClient({ environment: CortiEnvironment.Eu, clientId: "YOUR_CLIENT_ID", clientSecret: "YOUR_CLIENT_SECRET", tenantName: "YOUR_TENANT_NAME" });
-await client.auth.getToken({
-    clientId: "client_id",
-    clientSecret: "client_secret"
+const client = new CortiClient({
+    tenantName: "YOUR_TENANT_NAME",
+    environment: "YOUR_ENVIRONMENT_ID",
+    auth: { clientId: "YOUR_CLIENT_ID", clientSecret: "YOUR_CLIENT_SECRET" },
+});
+await client.interactions.create({
+    encounter: {
+        identifier: "identifier",
+        status: "planned",
+        type: "first_consultation"
+    }
 });
 ```
 
 ## Authentication
 
-The SDK supports OAuth authentication with two options:
+The SDK supports several OAuth 2.0 flows. In all cases the SDK manages tokens in memory — before each request it checks whether the stored access token is still valid, and if not, calls the appropriate token endpoint transparently. No manual token management is needed.
 
-**Option 1: OAuth Client Credentials Flow**
+### Client Credentials (recommended for server-side apps)
 
-Use this when you want the SDK to automatically handle OAuth token retrieval and refreshing:
+The SDK fetches and refreshes tokens automatically using your client credentials.
 
 ```typescript
 import { CortiClient } from "@corti/sdk";
 
 const client = new CortiClient({
-    clientId: "YOUR_CLIENT_ID",
-    clientSecret: "YOUR_CLIENT_SECRET",
-    ...
+    tenantName: "YOUR_TENANT_NAME",
+    environment: "YOUR_ENVIRONMENT_ID",
+    auth: { clientId: "YOUR_CLIENT_ID", clientSecret: "YOUR_CLIENT_SECRET" },
 });
 ```
 
-**Option 2: Token Override**
+### Bearer token (pre-obtained)
 
-Use this when you already have a valid bearer token and want to skip the OAuth flow:
+Use when you already have a valid access token. Pass `refreshToken` + `clientId` to enable automatic renewal when the token expires.
 
 ```typescript
-import { CortiClient } from "@corti/sdk";
+// Static token — no automatic renewal
+const client = new CortiClient({
+    auth: { accessToken: "YOUR_ACCESS_TOKEN" },
+});
 
+// Token with automatic refresh via stored refresh token
 const client = new CortiClient({
-    token: "my-pre-generated-bearer-token",
-    ...
+    auth: {
+        accessToken: "YOUR_ACCESS_TOKEN",
+        clientId: "YOUR_CLIENT_ID",
+        refreshToken: "YOUR_REFRESH_TOKEN",
+        expiresIn: 300,         // seconds until access token expires
+        refreshExpiresIn: 1800, // seconds until refresh token expires
+    },
+});
+```
+
+### Bearer token with custom refresh
+
+Use when your application manages token renewal (e.g. via a proxy or an external identity provider). The SDK calls `refreshAccessToken` whenever the stored token expires.
+
+```typescript
+const client = new CortiClient({
+    auth: {
+        accessToken: "YOUR_ACCESS_TOKEN",
+        refreshAccessToken: async (refreshToken) => {
+            // call your own token endpoint and return the new token
+            return { accessToken: "NEW_TOKEN", expiresIn: 300 };
+        },
+    },
+});
+```
+
+### Resource Owner Password Credentials (ROPC)
+
+```typescript
+const client = new CortiClient({
+    tenantName: "YOUR_TENANT_NAME",
+    environment: "YOUR_ENVIRONMENT_ID",
+    auth: { clientId: "YOUR_CLIENT_ID", username: "USERNAME", password: "PASSWORD" },
+});
+```
+
+### Authorization Code
+
+```typescript
+const client = new CortiClient({
+    tenantName: "YOUR_TENANT_NAME",
+    environment: "YOUR_ENVIRONMENT_ID",
+    auth: {
+        clientId: "YOUR_CLIENT_ID",
+        clientSecret: "YOUR_CLIENT_SECRET",
+        code: "AUTH_CODE",
+        redirectUri: "YOUR_REDIRECT_URI",
+    },
+});
+```
+
+### PKCE
+
+```typescript
+const client = new CortiClient({
+    tenantName: "YOUR_TENANT_NAME",
+    environment: "YOUR_ENVIRONMENT_ID",
+    auth: {
+        clientId: "YOUR_CLIENT_ID",
+        code: "AUTH_CODE",
+        redirectUri: "YOUR_REDIRECT_URI",
+        codeVerifier: "YOUR_CODE_VERIFIER",
+    },
 });
 ```
 
@@ -102,16 +176,30 @@ When the API returns a non-success status code (4xx or 5xx response), a subclass
 will be thrown.
 
 ```typescript
-import { CortiError } from "@corti/sdk";
+import { CortiError, CortiSDKError, CortiSDKErrorCodes, ParseError, JsonError } from "@corti/sdk";
 
 try {
-    await client.auth.getToken(...);
+    await client.interactions.create(...);
 } catch (err) {
     if (err instanceof CortiError) {
+        // HTTP API error (4xx / 5xx)
         console.log(err.statusCode);
         console.log(err.message);
         console.log(err.body);
         console.log(err.rawResponse);
+    } else if (err instanceof CortiSDKError) {
+        // SDK infrastructure error (e.g. localStorage unavailable)
+        console.log(err.code);    // e.g. CortiSDKErrorCodes.LOCAL_STORAGE_ERROR
+        console.log(err.message);
+        console.log(err.cause);   // original Error, if any
+    } else if (err instanceof ParseError) {
+        // Input validation failed (e.g. missing PKCE verifier, invalid JWT)
+        console.log(err.errors);  // ValidationError[]
+        console.log(err.message);
+    } else if (err instanceof JsonError) {
+        // Response body could not be parsed as JSON
+        console.log(err.errors);  // ValidationError[]
+        console.log(err.message);
     }
 }
 ```
@@ -555,9 +643,13 @@ const text = new TextDecoder().decode(bytes);
 List endpoints are paginated. The SDK provides an iterator so that you can simply loop over the items:
 
 ```typescript
-import { CortiClient, CortiEnvironment } from "@corti/sdk";
+import { CortiClient } from "@corti/sdk";
 
-const client = new CortiClient({ environment: CortiEnvironment.Eu, clientId: "YOUR_CLIENT_ID", clientSecret: "YOUR_CLIENT_SECRET", tenantName: "YOUR_TENANT_NAME" });
+const client = new CortiClient({
+    tenantName: "YOUR_TENANT_NAME",
+    environment: "YOUR_ENVIRONMENT_ID",
+    auth: { clientId: "YOUR_CLIENT_ID", clientSecret: "YOUR_CLIENT_SECRET" },
+});
 const pageableResponse = await client.interactions.list();
 for await (const item of pageableResponse) {
     console.log(item);
@@ -575,16 +667,6 @@ const response = page.response;
 
 ## Advanced
 
-### Subpackage Exports
-
-This SDK supports direct imports of subpackage clients, which allows JavaScript bundlers to tree-shake and include only the imported subpackage code. This results in much smaller bundle sizes.
-
-```typescript
-import { AuthClient } from '@corti/sdk/auth';
-
-const client = new AuthClient({...});
-```
-
 ### Additional Headers
 
 If you would like to send additional headers as part of the request, use the `headers` request option.
@@ -599,7 +681,7 @@ const client = new CortiClient({
     }
 });
 
-const response = await client.auth.getToken(..., {
+const response = await client.interactions.create(..., {
     headers: {
         'X-Custom-Header': 'custom value'
     }
@@ -611,7 +693,7 @@ const response = await client.auth.getToken(..., {
 If you would like to send additional query string parameters as part of the request, use the `queryParams` request option.
 
 ```typescript
-const response = await client.auth.getToken(..., {
+const response = await client.interactions.create(..., {
     queryParams: {
         'customQueryParamKey': 'custom query param value'
     }
@@ -633,7 +715,7 @@ A request is deemed retryable when any of the following HTTP status codes is ret
 Use the `maxRetries` request option to configure this behavior.
 
 ```typescript
-const response = await client.auth.getToken(..., {
+const response = await client.interactions.create(..., {
     maxRetries: 0 // override maxRetries at the request level
 });
 ```
@@ -643,7 +725,7 @@ const response = await client.auth.getToken(..., {
 The SDK defaults to a 60 second timeout. Use the `timeoutInSeconds` option to configure this behavior.
 
 ```typescript
-const response = await client.auth.getToken(..., {
+const response = await client.interactions.create(..., {
     timeoutInSeconds: 30 // override timeout to 30s
 });
 ```
@@ -654,7 +736,7 @@ The SDK allows users to abort requests at any point by passing in an abort signa
 
 ```typescript
 const controller = new AbortController();
-const response = await client.auth.getToken(..., {
+const response = await client.interactions.create(..., {
     abortSignal: controller.signal
 });
 controller.abort(); // aborts the request
@@ -666,7 +748,7 @@ The SDK provides access to raw response data, including headers, through the `.w
 The `.withRawResponse()` method returns a promise that results to an object with a `data` and a `rawResponse` property.
 
 ```typescript
-const { data, rawResponse } = await client.auth.getToken(...).withRawResponse();
+const { data, rawResponse } = await client.interactions.create(...).withRawResponse();
 
 console.log(data);
 console.log(rawResponse.headers['X-My-Header']);

package/dist/cjs/BaseClient.js

@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
     const headers = (0, headers_js_1.mergeHeaders)({
         "X-Fern-Language": "JavaScript",
         "X-Fern-SDK-Name": "@corti/sdk",
-        "X-Fern-SDK-Version": "1.0.0-alpha",
-        "User-Agent": "@corti/sdk/1.0.0-alpha",
+        "X-Fern-SDK-Version": "0.10.2",
+        "User-Agent": "@corti/sdk/0.10.2",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
         "Tenant-Name": options === null || options === void 0 ? void 0 : options.tenantName,

package/dist/cjs/api/errors/ForbiddenError.d.ts

@@ -1,6 +1,5 @@
 import type * as core from "../../core/index.js";
 import * as errors from "../../errors/index.js";
-import type * as Corti from "../index.js";
 export declare class ForbiddenError extends errors.CortiError {
-    constructor(body: Corti.ErrorResponse, rawResponse?: core.RawResponse);
+    constructor(body?: unknown, rawResponse?: core.RawResponse);
 }

package/dist/cjs/api/errors/UnprocessableEntityError.d.ts

@@ -0,0 +1,6 @@
+import type * as core from "../../core/index.js";
+import * as errors from "../../errors/index.js";
+import type * as Corti from "../index.js";
+export declare class UnprocessableEntityError extends errors.CortiError {
+    constructor(body: Corti.AgentsValidationErrorResponse, rawResponse?: core.RawResponse);
+}

package/dist/cjs/{serialization/types/AuthTokenRequest.js → api/errors/UnprocessableEntityError.js}

@@ -34,12 +34,21 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AuthTokenRequest = void 0;
-const core = __importStar(require("../../core/index.js"));
-const AuthTokenRequestGrantType_js_1 = require("./AuthTokenRequestGrantType.js");
-exports.AuthTokenRequest = core.serialization.object({
-    clientId: core.serialization.property("client_id", core.serialization.string()),
-    clientSecret: core.serialization.property("client_secret", core.serialization.string()),
-    grantType: core.serialization.property("grant_type", AuthTokenRequestGrantType_js_1.AuthTokenRequestGrantType),
-    scope: core.serialization.string().optional(),
-});
+exports.UnprocessableEntityError = void 0;
+const errors = __importStar(require("../../errors/index.js"));
+class UnprocessableEntityError extends errors.CortiError {
+    constructor(body, rawResponse) {
+        super({
+            message: "UnprocessableEntityError",
+            statusCode: 422,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+        this.name = this.constructor.name;
+    }
+}
+exports.UnprocessableEntityError = UnprocessableEntityError;

package/dist/cjs/api/errors/index.d.ts

@@ -5,3 +5,4 @@ export * from "./GatewayTimeoutError.js";
 export * from "./InternalServerError.js";
 export * from "./NotFoundError.js";
 export * from "./UnauthorizedError.js";
+export * from "./UnprocessableEntityError.js";

package/dist/cjs/api/errors/index.js

@@ -21,3 +21,4 @@ __exportStar(require("./GatewayTimeoutError.js"), exports);
 __exportStar(require("./InternalServerError.js"), exports);
 __exportStar(require("./NotFoundError.js"), exports);
 __exportStar(require("./UnauthorizedError.js"), exports);
+__exportStar(require("./UnprocessableEntityError.js"), exports);

package/dist/cjs/api/resources/agents/client/Client.d.ts

@@ -32,6 +32,7 @@ export declare class AgentsClient {
      *
      * @throws {@link Corti.BadRequestError}
      * @throws {@link Corti.UnauthorizedError}
+     * @throws {@link Corti.UnprocessableEntityError}
      *
      * @example
      *     await client.agents.create({
@@ -81,6 +82,7 @@ export declare class AgentsClient {
      * @throws {@link Corti.BadRequestError}
      * @throws {@link Corti.UnauthorizedError}
      * @throws {@link Corti.NotFoundError}
+     * @throws {@link Corti.UnprocessableEntityError}
      *
      * @example
      *     await client.agents.update("12345678-90ab-cdef-gh12-34567890abc")
@@ -111,7 +113,9 @@ export declare class AgentsClient {
      *
      * @throws {@link Corti.BadRequestError}
      * @throws {@link Corti.UnauthorizedError}
+     * @throws {@link Corti.ForbiddenError}
      * @throws {@link Corti.NotFoundError}
+     * @throws {@link Corti.UnprocessableEntityError}
      *
      * @example
      *     await client.agents.messageSend("12345678-90ab-cdef-gh12-34567890abc", {
@@ -138,6 +142,7 @@ export declare class AgentsClient {
      *
      * @throws {@link Corti.BadRequestError}
      * @throws {@link Corti.UnauthorizedError}
+     * @throws {@link Corti.ForbiddenError}
      * @throws {@link Corti.NotFoundError}
      *
      * @example
@@ -170,6 +175,7 @@ export declare class AgentsClient {
      *
      * @throws {@link Corti.BadRequestError}
      * @throws {@link Corti.UnauthorizedError}
+     * @throws {@link Corti.UnprocessableEntityError}
      *
      * @example
      *     await client.agents.getRegistryExperts({

package/dist/cjs/api/resources/agents/client/Client.js

@@ -140,6 +140,7 @@ class AgentsClient {
      *
      * @throws {@link Corti.BadRequestError}
      * @throws {@link Corti.UnauthorizedError}
+     * @throws {@link Corti.UnprocessableEntityError}
      *
      * @example
      *     await client.agents.create({
@@ -194,6 +195,14 @@ class AgentsClient {
                         throw new Corti.BadRequestError(_response.error.body, _response.rawResponse);
                     case 401:
                         throw new Corti.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 422:
+                        throw new Corti.UnprocessableEntityError(serializers.AgentsValidationErrorResponse.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }), _response.rawResponse);
                     default:
                         throw new errors.CortiError({
                             statusCode: _response.error.statusCode,
@@ -332,6 +341,7 @@ class AgentsClient {
      * @throws {@link Corti.BadRequestError}
      * @throws {@link Corti.UnauthorizedError}
      * @throws {@link Corti.NotFoundError}
+     * @throws {@link Corti.UnprocessableEntityError}
      *
      * @example
      *     await client.agents.update("12345678-90ab-cdef-gh12-34567890abc")
@@ -381,6 +391,14 @@ class AgentsClient {
                         throw new Corti.UnauthorizedError(_response.error.body, _response.rawResponse);
                     case 404:
                         throw new Corti.NotFoundError(_response.error.body, _response.rawResponse);
+                    case 422:
+                        throw new Corti.UnprocessableEntityError(serializers.AgentsValidationErrorResponse.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }), _response.rawResponse);
                     default:
                         throw new errors.CortiError({
                             statusCode: _response.error.statusCode,
@@ -464,7 +482,9 @@ class AgentsClient {
      *
      * @throws {@link Corti.BadRequestError}
      * @throws {@link Corti.UnauthorizedError}
+     * @throws {@link Corti.ForbiddenError}
      * @throws {@link Corti.NotFoundError}
+     * @throws {@link Corti.UnprocessableEntityError}
      *
      * @example
      *     await client.agents.messageSend("12345678-90ab-cdef-gh12-34567890abc", {
@@ -522,8 +542,18 @@ class AgentsClient {
                         throw new Corti.BadRequestError(_response.error.body, _response.rawResponse);
                     case 401:
                         throw new Corti.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new Corti.ForbiddenError(_response.error.body, _response.rawResponse);
                     case 404:
                         throw new Corti.NotFoundError(_response.error.body, _response.rawResponse);
+                    case 422:
+                        throw new Corti.UnprocessableEntityError(serializers.AgentsValidationErrorResponse.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }), _response.rawResponse);
                     default:
                         throw new errors.CortiError({
                             statusCode: _response.error.statusCode,
@@ -545,6 +575,7 @@ class AgentsClient {
      *
      * @throws {@link Corti.BadRequestError}
      * @throws {@link Corti.UnauthorizedError}
+     * @throws {@link Corti.ForbiddenError}
      * @throws {@link Corti.NotFoundError}
      *
      * @example
@@ -591,6 +622,8 @@ class AgentsClient {
                         throw new Corti.BadRequestError(_response.error.body, _response.rawResponse);
                     case 401:
                         throw new Corti.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new Corti.ForbiddenError(_response.error.body, _response.rawResponse);
                     case 404:
                         throw new Corti.NotFoundError(_response.error.body, _response.rawResponse);
                     default:
@@ -682,6 +715,7 @@ class AgentsClient {
      *
      * @throws {@link Corti.BadRequestError}
      * @throws {@link Corti.UnauthorizedError}
+     * @throws {@link Corti.UnprocessableEntityError}
      *
      * @example
      *     await client.agents.getRegistryExperts({
@@ -731,6 +765,14 @@ class AgentsClient {
                         throw new Corti.BadRequestError(_response.error.body, _response.rawResponse);
                     case 401:
                         throw new Corti.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 422:
+                        throw new Corti.UnprocessableEntityError(serializers.AgentsValidationErrorResponse.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }), _response.rawResponse);
                     default:
                         throw new errors.CortiError({
                             statusCode: _response.error.statusCode,

package/dist/cjs/api/resources/codes/client/Client.d.ts

@@ -11,7 +11,7 @@ export declare class CodesClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<CodesClient.Options>;
     constructor(options: CodesClient.Options);
     /**
-     * Predict medical codes from provided context.<br/><Note>This is a stateless endpoint, designed to predict ICD-10-CM, ICD-10-PCS, and CPT codes based on input text string or documentId.<br/><br/>More than one code system may be defined in a single request, and the maximum number of codes to return per system can also be defined.<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`: Highest confidence bundle of codes, as selected by the code prediction model<br/>- `Candidates`: Full list of candidate codes as predicted by the model, rank sorted by model confidence with maximum possible value of 50.<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, 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>
      *
      * @param {Corti.CodesGeneralPredictRequest} request
      * @param {CodesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -24,12 +24,24 @@ export declare class CodesClient {
      *
      * @example
      *     await client.codes.predict({
-     *         system: ["icd10cm", "cpt"],
+     *         system: ["icd10cm-outpatient", "cpt"],
      *         context: [{
      *                 type: "text",
      *                 text: "Short arm splint applied in ED for pain control."
+     *             }]
+     *     })
+     *
+     * @example
+     *     await client.codes.predict({
+     *         system: ["icd10cm-outpatient"],
+     *         context: [{
+     *                 type: "text",
+     *                 text: "Patient presents with uncontrolled type 2 diabetes."
      *             }],
-     *         maxCandidates: 5
+     *         filter: {
+     *             include: ["E11"],
+     *             exclude: ["exclude"]
+     *         }
      *     })
      */
     predict(request: Corti.CodesGeneralPredictRequest, requestOptions?: CodesClient.RequestOptions): core.HttpResponsePromise<Corti.CodesGeneralResponse>;

package/dist/cjs/api/resources/codes/client/Client.js

@@ -56,7 +56,7 @@ class CodesClient {
         this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
     }
     /**
-     * Predict medical codes from provided context.<br/><Note>This is a stateless endpoint, designed to predict ICD-10-CM, ICD-10-PCS, and CPT codes based on input text string or documentId.<br/><br/>More than one code system may be defined in a single request, and the maximum number of codes to return per system can also be defined.<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`: Highest confidence bundle of codes, as selected by the code prediction model<br/>- `Candidates`: Full list of candidate codes as predicted by the model, rank sorted by model confidence with maximum possible value of 50.<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, 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>
      *
      * @param {Corti.CodesGeneralPredictRequest} request
      * @param {CodesClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -69,12 +69,24 @@ class CodesClient {
      *
      * @example
      *     await client.codes.predict({
-     *         system: ["icd10cm", "cpt"],
+     *         system: ["icd10cm-outpatient", "cpt"],
      *         context: [{
      *                 type: "text",
      *                 text: "Short arm splint applied in ED for pain control."
+     *             }]
+     *     })
+     *
+     * @example
+     *     await client.codes.predict({
+     *         system: ["icd10cm-outpatient"],
+     *         context: [{
+     *                 type: "text",
+     *                 text: "Patient presents with uncontrolled type 2 diabetes."
      *             }],
-     *         maxCandidates: 5
+     *         filter: {
+     *             include: ["E11"],
+     *             exclude: ["exclude"]
+     *         }
      *     })
      */
     predict(request, requestOptions) {
@@ -119,13 +131,7 @@ class CodesClient {
                     case 400:
                         throw new Corti.BadRequestError(_response.error.body, _response.rawResponse);
                     case 403:
-                        throw new Corti.ForbiddenError(serializers.ErrorResponse.parseOrThrow(_response.error.body, {
-                            unrecognizedObjectKeys: "passthrough",
-                            allowUnrecognizedUnionMembers: true,
-                            allowUnrecognizedEnumValues: true,
-                            skipValidation: true,
-                            breadcrumbsPrefix: ["response"],
-                        }), _response.rawResponse);
+                        throw new Corti.ForbiddenError(_response.error.body, _response.rawResponse);
                     case 500:
                         throw new Corti.InternalServerError(serializers.ErrorResponse.parseOrThrow(_response.error.body, {
                             unrecognizedObjectKeys: "passthrough",

package/dist/cjs/api/resources/codes/client/requests/CodesGeneralPredictRequest.d.ts

@@ -2,12 +2,24 @@ import type * as Corti from "../../../../index.js";
 /**
  * @example
  *     {
- *         system: ["icd10cm", "cpt"],
+ *         system: ["icd10cm-outpatient", "cpt"],
  *         context: [{
  *                 type: "text",
  *                 text: "Short arm splint applied in ED for pain control."
+ *             }]
+ *     }
+ *
+ * @example
+ *     {
+ *         system: ["icd10cm-outpatient"],
+ *         context: [{
+ *                 type: "text",
+ *                 text: "Patient presents with uncontrolled type 2 diabetes."
  *             }],
- *         maxCandidates: 5
+ *         filter: {
+ *             include: ["E11"],
+ *             exclude: ["exclude"]
+ *         }
  *     }
  */
 export interface CodesGeneralPredictRequest {
@@ -15,6 +27,6 @@ export interface CodesGeneralPredictRequest {
     system: Corti.CommonCodingSystemEnum[];
     /** Select either `text` or `documentId` as input context to the model for code prediction. Evidence indices in the response map to this array. */
     context: Corti.CommonAiContext[];
-    /** Maximum number of code candidates to include in the response (per system). */
-    maxCandidates?: number;
+    /** Optional filter to restrict predicted codes. */
+    filter?: Corti.CodesFilter;
 }