phenoml 2.0.0 → 3.1.0

package/dist/cjs/Client.js

@@ -52,8 +52,8 @@ class phenomlClient {
         this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_js_1.mergeHeaders)({
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "phenoml",
-                "X-Fern-SDK-Version": "2.0.0",
-                "User-Agent": "phenoml/2.0.0",
+                "X-Fern-SDK-Version": "3.1.0",
+                "User-Agent": "phenoml/3.1.0",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });

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

@@ -27,7 +27,8 @@ export declare class Agent {
      * @example
      *     await client.agent.create({
      *         name: "name",
-     *         prompts: ["prompt_123", "prompt_456"]
+     *         prompts: ["prompt_123", "prompt_456"],
+     *         provider: "provider"
      *     })
      */
     create(request: phenoml.agent.AgentCreateRequest, requestOptions?: Agent.RequestOptions): core.HttpResponsePromise<phenoml.agent.AgentResponse>;
@@ -81,7 +82,8 @@ export declare class Agent {
      * @example
      *     await client.agent.update("id", {
      *         name: "name",
-     *         prompts: ["prompt_123", "prompt_456"]
+     *         prompts: ["prompt_123", "prompt_456"],
+     *         provider: "provider"
      *     })
      */
     update(id: string, request: phenoml.agent.AgentCreateRequest, requestOptions?: Agent.RequestOptions): core.HttpResponsePromise<phenoml.agent.AgentResponse>;

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

@@ -83,7 +83,8 @@ class Agent {
      * @example
      *     await client.agent.create({
      *         name: "name",
-     *         prompts: ["prompt_123", "prompt_456"]
+     *         prompts: ["prompt_123", "prompt_456"],
+     *         provider: "provider"
      *     })
      */
     create(request, requestOptions) {
@@ -299,7 +300,8 @@ class Agent {
      * @example
      *     await client.agent.update("id", {
      *         name: "name",
-     *         prompts: ["prompt_123", "prompt_456"]
+     *         prompts: ["prompt_123", "prompt_456"],
+     *         provider: "provider"
      *     })
      */
     update(id, request, requestOptions) {

package/dist/cjs/api/resources/agent/types/AgentCreateRequest.d.ts

@@ -9,12 +9,16 @@ export interface AgentCreateRequest {
     tools?: string[];
     /** Tags for categorizing the agent */
     tags?: string[];
-    /** FHIR provider ID(s) - must be valid UUIDs from existing FHIR providers */
-    provider?: AgentCreateRequest.Provider;
+    /**
+     * FHIR provider ID(s) for this agent. Required.
+     * In shared/experiment environments, the default sandbox provider is used if a different provider is not explicitly specified.
+     */
+    provider: AgentCreateRequest.Provider;
 }
 export declare namespace AgentCreateRequest {
     /**
-     * FHIR provider ID(s) - must be valid UUIDs from existing FHIR providers
+     * FHIR provider ID(s) for this agent. Required.
+     * In shared/experiment environments, the default sandbox provider is used if a different provider is not explicitly specified.
      */
     type Provider = 
     /**

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

@@ -11,7 +11,7 @@ export declare class Construe {
     protected readonly _options: Construe.Options;
     constructor(_options: Construe.Options);
     /**
-     * Upload a custom medical code system with codes and descriptions for use in code extraction.
+     * Upload a custom medical code system with codes and descriptions for use in code extraction. Requires a paid plan.
      * Upon upload, construe generates embeddings for all of the codes in the code system and stores them in the vector database so you can
      * subsequently use the code system for construe/extract and lang2fhir/create (coming soon!)
      *
@@ -35,7 +35,9 @@ export declare class Construe {
     uploadCodeSystem(request: phenoml.construe.UploadRequest, requestOptions?: Construe.RequestOptions): core.HttpResponsePromise<phenoml.construe.ConstrueUploadCodeSystemResponse>;
     private __uploadCodeSystem;
     /**
-     * Converts natural language text into structured medical codes
+     * Converts natural language text into structured medical codes.
+     *
+     * Usage of CPT is subject to AMA requirements: see PhenoML Terms of Service.
      *
      * @param {phenoml.construe.ExtractRequest} request
      * @param {Construe.RequestOptions} requestOptions - Request-specific configuration.
@@ -53,7 +55,7 @@ export declare class Construe {
     extractCodes(request: phenoml.construe.ExtractRequest, requestOptions?: Construe.RequestOptions): core.HttpResponsePromise<phenoml.construe.ExtractCodesResult>;
     private __extractCodes;
     /**
-     * Returns metadata about all available code systems including built-in and custom systems.
+     * Returns the terminology server's catalog of available code systems, including both built-in standard terminologies and custom uploaded systems.
      *
      * @param {Construe.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -66,7 +68,9 @@ export declare class Construe {
     listAvailableCodeSystems(requestOptions?: Construe.RequestOptions): core.HttpResponsePromise<phenoml.construe.ListCodeSystemsResponse>;
     private __listAvailableCodeSystems;
     /**
-     * Returns a paginated list of all codes in the specified code system.
+     * Returns a paginated list of all codes in the specified code system from the terminology server.
+     *
+     * Usage of CPT is subject to AMA requirements: see PhenoML Terms of Service.
      *
      * @param {string} codesystem - Code system name (e.g., "ICD-10-CM", "SNOMED_CT_US_LITE")
      * @param {phenoml.construe.GetConstrueCodesCodesystemRequest} request
@@ -87,7 +91,9 @@ export declare class Construe {
     listCodesInACodeSystem(codesystem: string, request?: phenoml.construe.GetConstrueCodesCodesystemRequest, requestOptions?: Construe.RequestOptions): core.HttpResponsePromise<phenoml.construe.ListCodesResponse>;
     private __listCodesInACodeSystem;
     /**
-     * Returns details for a specific code within a code system.
+     * Looks up a specific code in the terminology server and returns its details.
+     *
+     * Usage of CPT is subject to AMA requirements: see PhenoML Terms of Service.
      *
      * @param {string} codesystem - Code system name
      * @param {string} codeId - The code identifier
@@ -123,6 +129,8 @@ export declare class Construe {
      *
      * See also: `/search/text` for faster keyword-based lookup with typo tolerance.
      *
+     * Usage of CPT is subject to AMA requirements: see PhenoML Terms of Service.
+     *
      * @param {string} codesystem - Code system name
      * @param {phenoml.construe.GetConstrueCodesCodesystemSearchSemanticRequest} request
      * @param {Construe.RequestOptions} requestOptions - Request-specific configuration.
@@ -161,6 +169,8 @@ export declare class Construe {
      *
      * See also: `/search/semantic` for finding conceptually similar codes.
      *
+     * Usage of CPT is subject to AMA requirements: see PhenoML Terms of Service.
+     *
      * @param {string} codesystem - Code system name
      * @param {phenoml.construe.GetConstrueCodesCodesystemSearchTextRequest} request
      * @param {Construe.RequestOptions} requestOptions - Request-specific configuration.
@@ -173,13 +183,13 @@ export declare class Construe {
      * @throws {@link phenoml.construe.ServiceUnavailableError}
      *
      * @example
-     *     await client.construe.textSearchKeywordBased("ICD-10-CM", {
+     *     await client.construe.terminologyServerTextSearch("ICD-10-CM", {
      *         q: "E11.65",
      *         version: "version",
      *         limit: 1
      *     })
      */
-    textSearchKeywordBased(codesystem: string, request: phenoml.construe.GetConstrueCodesCodesystemSearchTextRequest, requestOptions?: Construe.RequestOptions): core.HttpResponsePromise<phenoml.construe.TextSearchResponse>;
-    private __textSearchKeywordBased;
+    terminologyServerTextSearch(codesystem: string, request: phenoml.construe.GetConstrueCodesCodesystemSearchTextRequest, requestOptions?: Construe.RequestOptions): core.HttpResponsePromise<phenoml.construe.TextSearchResponse>;
+    private __terminologyServerTextSearch;
     protected _getAuthorizationHeader(): Promise<string>;
 }

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

@@ -54,7 +54,7 @@ class Construe {
         this._options = _options;
     }
     /**
-     * Upload a custom medical code system with codes and descriptions for use in code extraction.
+     * Upload a custom medical code system with codes and descriptions for use in code extraction. Requires a paid plan.
      * Upon upload, construe generates embeddings for all of the codes in the code system and stores them in the vector database so you can
      * subsequently use the code system for construe/extract and lang2fhir/create (coming soon!)
      *
@@ -138,7 +138,9 @@ class Construe {
         });
     }
     /**
-     * Converts natural language text into structured medical codes
+     * Converts natural language text into structured medical codes.
+     *
+     * Usage of CPT is subject to AMA requirements: see PhenoML Terms of Service.
      *
      * @param {phenoml.construe.ExtractRequest} request
      * @param {Construe.RequestOptions} requestOptions - Request-specific configuration.
@@ -211,7 +213,7 @@ class Construe {
         });
     }
     /**
-     * Returns metadata about all available code systems including built-in and custom systems.
+     * Returns the terminology server's catalog of available code systems, including both built-in standard terminologies and custom uploaded systems.
      *
      * @param {Construe.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -275,7 +277,9 @@ class Construe {
         });
     }
     /**
-     * Returns a paginated list of all codes in the specified code system.
+     * Returns a paginated list of all codes in the specified code system from the terminology server.
+     *
+     * Usage of CPT is subject to AMA requirements: see PhenoML Terms of Service.
      *
      * @param {string} codesystem - Code system name (e.g., "ICD-10-CM", "SNOMED_CT_US_LITE")
      * @param {phenoml.construe.GetConstrueCodesCodesystemRequest} request
@@ -359,7 +363,9 @@ class Construe {
         });
     }
     /**
-     * Returns details for a specific code within a code system.
+     * Looks up a specific code in the terminology server and returns its details.
+     *
+     * Usage of CPT is subject to AMA requirements: see PhenoML Terms of Service.
      *
      * @param {string} codesystem - Code system name
      * @param {string} codeId - The code identifier
@@ -452,6 +458,8 @@ class Construe {
      *
      * See also: `/search/text` for faster keyword-based lookup with typo tolerance.
      *
+     * Usage of CPT is subject to AMA requirements: see PhenoML Terms of Service.
+     *
      * @param {string} codesystem - Code system name
      * @param {phenoml.construe.GetConstrueCodesCodesystemSearchSemanticRequest} request
      * @param {Construe.RequestOptions} requestOptions - Request-specific configuration.
@@ -554,6 +562,8 @@ class Construe {
      *
      * See also: `/search/semantic` for finding conceptually similar codes.
      *
+     * Usage of CPT is subject to AMA requirements: see PhenoML Terms of Service.
+     *
      * @param {string} codesystem - Code system name
      * @param {phenoml.construe.GetConstrueCodesCodesystemSearchTextRequest} request
      * @param {Construe.RequestOptions} requestOptions - Request-specific configuration.
@@ -566,16 +576,16 @@ class Construe {
      * @throws {@link phenoml.construe.ServiceUnavailableError}
      *
      * @example
-     *     await client.construe.textSearchKeywordBased("ICD-10-CM", {
+     *     await client.construe.terminologyServerTextSearch("ICD-10-CM", {
      *         q: "E11.65",
      *         version: "version",
      *         limit: 1
      *     })
      */
-    textSearchKeywordBased(codesystem, request, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__textSearchKeywordBased(codesystem, request, requestOptions));
+    terminologyServerTextSearch(codesystem, request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__terminologyServerTextSearch(codesystem, request, requestOptions));
     }
-    __textSearchKeywordBased(codesystem, request, requestOptions) {
+    __terminologyServerTextSearch(codesystem, request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
             const { q, version, limit } = request;

package/dist/cjs/api/resources/construe/types/Citation.d.ts

@@ -0,0 +1,11 @@
+/**
+ * A reference to source text that led to a code extraction
+ */
+export interface Citation {
+    /** The exact text span containing evidence for the code */
+    text: string;
+    /** Starting byte offset in the original input text (0-indexed) */
+    begin_offset: number;
+    /** Ending byte offset (exclusive), such that input[begin_offset:end_offset] == text */
+    end_offset: number;
+}

package/dist/cjs/api/resources/construe/types/Citation.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/resources/construe/types/ExtractRequestConfig.d.ts

@@ -23,6 +23,14 @@ export interface ExtractRequestConfig {
     include_ancestors?: boolean;
     /** Whether to include codes that failed validation in the results */
     include_invalid?: boolean;
+    /**
+     * Whether to include source text citations for each extracted code.
+     * Citations show the exact text spans (with character offsets) that led to each code.
+     * Only available when using chunking_method: "sentences".
+     * The "none" method returns full text as one chunk (not useful for citations).
+     * LLM-based chunking (paragraphs, topics) does not support citations.
+     */
+    include_citations?: boolean;
 }
 export declare namespace ExtractRequestConfig {
     /** Method for splitting input text into chunks before code extraction */

package/dist/cjs/api/resources/construe/types/ExtractRequestSystem.d.ts

@@ -12,7 +12,9 @@ export interface ExtractRequestSystem {
      * * CPT - version 2025
      *
      * Custom systems:
-     * * Any valid system name configured in your environment. Must have self-hosted construe module.
+     * * Any valid system name uploaded via /construe/upload. Requires a paid plan.
+     *
+     * Usage of CPT is subject to AMA requirements: see PhenoML Terms of Service.
      */
     name?: string;
     /** Code system version. Must match the version available in your environment. */

package/dist/cjs/api/resources/construe/types/ExtractedCodeResult.d.ts

@@ -1,3 +1,4 @@
+import type * as phenoml from "../../../index.js";
 export interface ExtractedCodeResult {
     /** The extracted code */
     code: string;
@@ -9,4 +10,15 @@ export interface ExtractedCodeResult {
     longDescription?: string;
     /** Explanation for why this code was extracted (if include_rationale is true) */
     rationale?: string;
+    /**
+     * Whether this code is an ancestor (parent) of an extracted code rather than directly extracted.
+     * Only present when include_ancestors is true.
+     */
+    is_ancestor?: boolean;
+    /**
+     * Source text references showing where this code was found in the input.
+     * Only present when include_citations is true and chunking method supports it.
+     * Ancestor codes do not receive citations.
+     */
+    citations?: phenoml.construe.Citation[];
 }

package/dist/cjs/api/resources/construe/types/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./Citation.js";
 export * from "./CodeResponse.js";
 export * from "./CodeSystemDetails.js";
 export * from "./CodeSystemInfo.js";

package/dist/cjs/api/resources/construe/types/index.js

@@ -14,6 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./Citation.js"), exports);
 __exportStar(require("./CodeResponse.js"), exports);
 __exportStar(require("./CodeSystemDetails.js"), exports);
 __exportStar(require("./CodeSystemInfo.js"), exports);

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

@@ -30,6 +30,7 @@ export declare class Fhir {
      * @throws {@link phenoml.fhir.UnauthorizedError}
      * @throws {@link phenoml.fhir.NotFoundError}
      * @throws {@link phenoml.fhir.InternalServerError}
+     * @throws {@link phenoml.fhir.BadGatewayError}
      *
      * @example
      *     await client.fhir.search("550e8400-e29b-41d4-a716-446655440000", "Patient", {
@@ -58,6 +59,7 @@ export declare class Fhir {
      * @throws {@link phenoml.fhir.BadRequestError}
      * @throws {@link phenoml.fhir.UnauthorizedError}
      * @throws {@link phenoml.fhir.InternalServerError}
+     * @throws {@link phenoml.fhir.BadGatewayError}
      *
      * @example
      *     await client.fhir.create("550e8400-e29b-41d4-a716-446655440000", "Patient", {
@@ -99,6 +101,7 @@ export declare class Fhir {
      * @throws {@link phenoml.fhir.BadRequestError}
      * @throws {@link phenoml.fhir.UnauthorizedError}
      * @throws {@link phenoml.fhir.InternalServerError}
+     * @throws {@link phenoml.fhir.BadGatewayError}
      *
      * @example
      *     await client.fhir.upsert("550e8400-e29b-41d4-a716-446655440000", "Patient", {
@@ -143,6 +146,7 @@ export declare class Fhir {
      * @throws {@link phenoml.fhir.UnauthorizedError}
      * @throws {@link phenoml.fhir.NotFoundError}
      * @throws {@link phenoml.fhir.InternalServerError}
+     * @throws {@link phenoml.fhir.BadGatewayError}
      *
      * @example
      *     await client.fhir.delete("550e8400-e29b-41d4-a716-446655440000", "Patient", {
@@ -177,6 +181,7 @@ export declare class Fhir {
      * @throws {@link phenoml.fhir.UnauthorizedError}
      * @throws {@link phenoml.fhir.NotFoundError}
      * @throws {@link phenoml.fhir.InternalServerError}
+     * @throws {@link phenoml.fhir.BadGatewayError}
      *
      * @example
      *     await client.fhir.patch("550e8400-e29b-41d4-a716-446655440000", "Patient", {
@@ -258,6 +263,7 @@ export declare class Fhir {
      * @throws {@link phenoml.fhir.BadRequestError}
      * @throws {@link phenoml.fhir.UnauthorizedError}
      * @throws {@link phenoml.fhir.InternalServerError}
+     * @throws {@link phenoml.fhir.BadGatewayError}
      *
      * @example
      *     await client.fhir.executeBundle("550e8400-e29b-41d4-a716-446655440000", {

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

@@ -74,6 +74,7 @@ class Fhir {
      * @throws {@link phenoml.fhir.UnauthorizedError}
      * @throws {@link phenoml.fhir.NotFoundError}
      * @throws {@link phenoml.fhir.InternalServerError}
+     * @throws {@link phenoml.fhir.BadGatewayError}
      *
      * @example
      *     await client.fhir.search("550e8400-e29b-41d4-a716-446655440000", "Patient", {
@@ -119,6 +120,8 @@ class Fhir {
                         throw new phenoml.fhir.NotFoundError(_response.error.body, _response.rawResponse);
                     case 500:
                         throw new phenoml.fhir.InternalServerError(_response.error.body, _response.rawResponse);
+                    case 502:
+                        throw new phenoml.fhir.BadGatewayError(_response.error.body, _response.rawResponse);
                     default:
                         throw new errors.phenomlError({
                             statusCode: _response.error.statusCode,
@@ -163,6 +166,7 @@ class Fhir {
      * @throws {@link phenoml.fhir.BadRequestError}
      * @throws {@link phenoml.fhir.UnauthorizedError}
      * @throws {@link phenoml.fhir.InternalServerError}
+     * @throws {@link phenoml.fhir.BadGatewayError}
      *
      * @example
      *     await client.fhir.create("550e8400-e29b-41d4-a716-446655440000", "Patient", {
@@ -218,6 +222,8 @@ class Fhir {
                         throw new phenoml.fhir.UnauthorizedError(_response.error.body, _response.rawResponse);
                     case 500:
                         throw new phenoml.fhir.InternalServerError(_response.error.body, _response.rawResponse);
+                    case 502:
+                        throw new phenoml.fhir.BadGatewayError(_response.error.body, _response.rawResponse);
                     default:
                         throw new errors.phenomlError({
                             statusCode: _response.error.statusCode,
@@ -262,6 +268,7 @@ class Fhir {
      * @throws {@link phenoml.fhir.BadRequestError}
      * @throws {@link phenoml.fhir.UnauthorizedError}
      * @throws {@link phenoml.fhir.InternalServerError}
+     * @throws {@link phenoml.fhir.BadGatewayError}
      *
      * @example
      *     await client.fhir.upsert("550e8400-e29b-41d4-a716-446655440000", "Patient", {
@@ -319,6 +326,8 @@ class Fhir {
                         throw new phenoml.fhir.UnauthorizedError(_response.error.body, _response.rawResponse);
                     case 500:
                         throw new phenoml.fhir.InternalServerError(_response.error.body, _response.rawResponse);
+                    case 502:
+                        throw new phenoml.fhir.BadGatewayError(_response.error.body, _response.rawResponse);
                     default:
                         throw new errors.phenomlError({
                             statusCode: _response.error.statusCode,
@@ -364,6 +373,7 @@ class Fhir {
      * @throws {@link phenoml.fhir.UnauthorizedError}
      * @throws {@link phenoml.fhir.NotFoundError}
      * @throws {@link phenoml.fhir.InternalServerError}
+     * @throws {@link phenoml.fhir.BadGatewayError}
      *
      * @example
      *     await client.fhir.delete("550e8400-e29b-41d4-a716-446655440000", "Patient", {
@@ -405,6 +415,8 @@ class Fhir {
                         throw new phenoml.fhir.NotFoundError(_response.error.body, _response.rawResponse);
                     case 500:
                         throw new phenoml.fhir.InternalServerError(_response.error.body, _response.rawResponse);
+                    case 502:
+                        throw new phenoml.fhir.BadGatewayError(_response.error.body, _response.rawResponse);
                     default:
                         throw new errors.phenomlError({
                             statusCode: _response.error.statusCode,
@@ -455,6 +467,7 @@ class Fhir {
      * @throws {@link phenoml.fhir.UnauthorizedError}
      * @throws {@link phenoml.fhir.NotFoundError}
      * @throws {@link phenoml.fhir.InternalServerError}
+     * @throws {@link phenoml.fhir.BadGatewayError}
      *
      * @example
      *     await client.fhir.patch("550e8400-e29b-41d4-a716-446655440000", "Patient", {
@@ -555,6 +568,8 @@ class Fhir {
                         throw new phenoml.fhir.NotFoundError(_response.error.body, _response.rawResponse);
                     case 500:
                         throw new phenoml.fhir.InternalServerError(_response.error.body, _response.rawResponse);
+                    case 502:
+                        throw new phenoml.fhir.BadGatewayError(_response.error.body, _response.rawResponse);
                     default:
                         throw new errors.phenomlError({
                             statusCode: _response.error.statusCode,
@@ -596,6 +611,7 @@ class Fhir {
      * @throws {@link phenoml.fhir.BadRequestError}
      * @throws {@link phenoml.fhir.UnauthorizedError}
      * @throws {@link phenoml.fhir.InternalServerError}
+     * @throws {@link phenoml.fhir.BadGatewayError}
      *
      * @example
      *     await client.fhir.executeBundle("550e8400-e29b-41d4-a716-446655440000", {
@@ -670,6 +686,8 @@ class Fhir {
                         throw new phenoml.fhir.UnauthorizedError(_response.error.body, _response.rawResponse);
                     case 500:
                         throw new phenoml.fhir.InternalServerError(_response.error.body, _response.rawResponse);
+                    case 502:
+                        throw new phenoml.fhir.BadGatewayError(_response.error.body, _response.rawResponse);
                     default:
                         throw new errors.phenomlError({
                             statusCode: _response.error.statusCode,

package/dist/cjs/api/resources/fhir/errors/BadGatewayError.d.ts

@@ -0,0 +1,6 @@
+import type * as core from "../../../../core/index.js";
+import * as errors from "../../../../errors/index.js";
+import type * as phenoml from "../../../index.js";
+export declare class BadGatewayError extends errors.phenomlError {
+    constructor(body: phenoml.fhir.ErrorResponse, rawResponse?: core.RawResponse);
+}

package/dist/cjs/api/resources/fhir/errors/BadGatewayError.js

@@ -0,0 +1,50 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BadGatewayError = void 0;
+const errors = __importStar(require("../../../../errors/index.js"));
+class BadGatewayError extends errors.phenomlError {
+    constructor(body, rawResponse) {
+        super({
+            message: "BadGatewayError",
+            statusCode: 502,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, BadGatewayError.prototype);
+    }
+}
+exports.BadGatewayError = BadGatewayError;

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

@@ -1,3 +1,4 @@
+export * from "./BadGatewayError.js";
 export * from "./BadRequestError.js";
 export * from "./InternalServerError.js";
 export * from "./NotFoundError.js";

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

@@ -14,6 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./BadGatewayError.js"), exports);
 __exportStar(require("./BadRequestError.js"), exports);
 __exportStar(require("./InternalServerError.js"), exports);
 __exportStar(require("./NotFoundError.js"), exports);

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "2.0.0";
+export declare const SDK_VERSION = "3.1.0";

package/dist/cjs/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "2.0.0";
+exports.SDK_VERSION = "3.1.0";

package/dist/esm/Client.mjs

@@ -16,8 +16,8 @@ export class phenomlClient {
         this._options = Object.assign(Object.assign({}, _options), { headers: mergeHeaders({
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "phenoml",
-                "X-Fern-SDK-Version": "2.0.0",
-                "User-Agent": "phenoml/2.0.0",
+                "X-Fern-SDK-Version": "3.1.0",
+                "User-Agent": "phenoml/3.1.0",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });

package/dist/esm/api/resources/agent/client/Client.d.mts

@@ -27,7 +27,8 @@ export declare class Agent {
      * @example
      *     await client.agent.create({
      *         name: "name",
-     *         prompts: ["prompt_123", "prompt_456"]
+     *         prompts: ["prompt_123", "prompt_456"],
+     *         provider: "provider"
      *     })
      */
     create(request: phenoml.agent.AgentCreateRequest, requestOptions?: Agent.RequestOptions): core.HttpResponsePromise<phenoml.agent.AgentResponse>;
@@ -81,7 +82,8 @@ export declare class Agent {
      * @example
      *     await client.agent.update("id", {
      *         name: "name",
-     *         prompts: ["prompt_123", "prompt_456"]
+     *         prompts: ["prompt_123", "prompt_456"],
+     *         provider: "provider"
      *     })
      */
     update(id: string, request: phenoml.agent.AgentCreateRequest, requestOptions?: Agent.RequestOptions): core.HttpResponsePromise<phenoml.agent.AgentResponse>;

package/dist/esm/api/resources/agent/client/Client.mjs

@@ -47,7 +47,8 @@ export class Agent {
      * @example
      *     await client.agent.create({
      *         name: "name",
-     *         prompts: ["prompt_123", "prompt_456"]
+     *         prompts: ["prompt_123", "prompt_456"],
+     *         provider: "provider"
      *     })
      */
     create(request, requestOptions) {
@@ -263,7 +264,8 @@ export class Agent {
      * @example
      *     await client.agent.update("id", {
      *         name: "name",
-     *         prompts: ["prompt_123", "prompt_456"]
+     *         prompts: ["prompt_123", "prompt_456"],
+     *         provider: "provider"
      *     })
      */
     update(id, request, requestOptions) {

package/dist/esm/api/resources/agent/types/AgentCreateRequest.d.mts

@@ -9,12 +9,16 @@ export interface AgentCreateRequest {
     tools?: string[];
     /** Tags for categorizing the agent */
     tags?: string[];
-    /** FHIR provider ID(s) - must be valid UUIDs from existing FHIR providers */
-    provider?: AgentCreateRequest.Provider;
+    /**
+     * FHIR provider ID(s) for this agent. Required.
+     * In shared/experiment environments, the default sandbox provider is used if a different provider is not explicitly specified.
+     */
+    provider: AgentCreateRequest.Provider;
 }
 export declare namespace AgentCreateRequest {
     /**
-     * FHIR provider ID(s) - must be valid UUIDs from existing FHIR providers
+     * FHIR provider ID(s) for this agent. Required.
+     * In shared/experiment environments, the default sandbox provider is used if a different provider is not explicitly specified.
      */
     type Provider = 
     /**

package/dist/esm/api/resources/construe/client/Client.d.mts

@@ -11,7 +11,7 @@ export declare class Construe {
     protected readonly _options: Construe.Options;
     constructor(_options: Construe.Options);
     /**
-     * Upload a custom medical code system with codes and descriptions for use in code extraction.
+     * Upload a custom medical code system with codes and descriptions for use in code extraction. Requires a paid plan.
      * Upon upload, construe generates embeddings for all of the codes in the code system and stores them in the vector database so you can
      * subsequently use the code system for construe/extract and lang2fhir/create (coming soon!)
      *
@@ -35,7 +35,9 @@ export declare class Construe {
     uploadCodeSystem(request: phenoml.construe.UploadRequest, requestOptions?: Construe.RequestOptions): core.HttpResponsePromise<phenoml.construe.ConstrueUploadCodeSystemResponse>;
     private __uploadCodeSystem;
     /**
-     * Converts natural language text into structured medical codes
+     * Converts natural language text into structured medical codes.
+     *
+     * Usage of CPT is subject to AMA requirements: see PhenoML Terms of Service.
      *
      * @param {phenoml.construe.ExtractRequest} request
      * @param {Construe.RequestOptions} requestOptions - Request-specific configuration.
@@ -53,7 +55,7 @@ export declare class Construe {
     extractCodes(request: phenoml.construe.ExtractRequest, requestOptions?: Construe.RequestOptions): core.HttpResponsePromise<phenoml.construe.ExtractCodesResult>;
     private __extractCodes;
     /**
-     * Returns metadata about all available code systems including built-in and custom systems.
+     * Returns the terminology server's catalog of available code systems, including both built-in standard terminologies and custom uploaded systems.
      *
      * @param {Construe.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -66,7 +68,9 @@ export declare class Construe {
     listAvailableCodeSystems(requestOptions?: Construe.RequestOptions): core.HttpResponsePromise<phenoml.construe.ListCodeSystemsResponse>;
     private __listAvailableCodeSystems;
     /**
-     * Returns a paginated list of all codes in the specified code system.
+     * Returns a paginated list of all codes in the specified code system from the terminology server.
+     *
+     * Usage of CPT is subject to AMA requirements: see PhenoML Terms of Service.
      *
      * @param {string} codesystem - Code system name (e.g., "ICD-10-CM", "SNOMED_CT_US_LITE")
      * @param {phenoml.construe.GetConstrueCodesCodesystemRequest} request
@@ -87,7 +91,9 @@ export declare class Construe {
     listCodesInACodeSystem(codesystem: string, request?: phenoml.construe.GetConstrueCodesCodesystemRequest, requestOptions?: Construe.RequestOptions): core.HttpResponsePromise<phenoml.construe.ListCodesResponse>;
     private __listCodesInACodeSystem;
     /**
-     * Returns details for a specific code within a code system.
+     * Looks up a specific code in the terminology server and returns its details.
+     *
+     * Usage of CPT is subject to AMA requirements: see PhenoML Terms of Service.
      *
      * @param {string} codesystem - Code system name
      * @param {string} codeId - The code identifier
@@ -123,6 +129,8 @@ export declare class Construe {
      *
      * See also: `/search/text` for faster keyword-based lookup with typo tolerance.
      *
+     * Usage of CPT is subject to AMA requirements: see PhenoML Terms of Service.
+     *
      * @param {string} codesystem - Code system name
      * @param {phenoml.construe.GetConstrueCodesCodesystemSearchSemanticRequest} request
      * @param {Construe.RequestOptions} requestOptions - Request-specific configuration.
@@ -161,6 +169,8 @@ export declare class Construe {
      *
      * See also: `/search/semantic` for finding conceptually similar codes.
      *
+     * Usage of CPT is subject to AMA requirements: see PhenoML Terms of Service.
+     *
      * @param {string} codesystem - Code system name
      * @param {phenoml.construe.GetConstrueCodesCodesystemSearchTextRequest} request
      * @param {Construe.RequestOptions} requestOptions - Request-specific configuration.
@@ -173,13 +183,13 @@ export declare class Construe {
      * @throws {@link phenoml.construe.ServiceUnavailableError}
      *
      * @example
-     *     await client.construe.textSearchKeywordBased("ICD-10-CM", {
+     *     await client.construe.terminologyServerTextSearch("ICD-10-CM", {
      *         q: "E11.65",
      *         version: "version",
      *         limit: 1
      *     })
      */
-    textSearchKeywordBased(codesystem: string, request: phenoml.construe.GetConstrueCodesCodesystemSearchTextRequest, requestOptions?: Construe.RequestOptions): core.HttpResponsePromise<phenoml.construe.TextSearchResponse>;
-    private __textSearchKeywordBased;
+    terminologyServerTextSearch(codesystem: string, request: phenoml.construe.GetConstrueCodesCodesystemSearchTextRequest, requestOptions?: Construe.RequestOptions): core.HttpResponsePromise<phenoml.construe.TextSearchResponse>;
+    private __terminologyServerTextSearch;
     protected _getAuthorizationHeader(): Promise<string>;
 }

package/dist/esm/api/resources/construe/client/Client.mjs

@@ -18,7 +18,7 @@ export class Construe {
         this._options = _options;
     }
     /**
-     * Upload a custom medical code system with codes and descriptions for use in code extraction.
+     * Upload a custom medical code system with codes and descriptions for use in code extraction. Requires a paid plan.
      * Upon upload, construe generates embeddings for all of the codes in the code system and stores them in the vector database so you can
      * subsequently use the code system for construe/extract and lang2fhir/create (coming soon!)
      *
@@ -102,7 +102,9 @@ export class Construe {
         });
     }
     /**
-     * Converts natural language text into structured medical codes
+     * Converts natural language text into structured medical codes.
+     *
+     * Usage of CPT is subject to AMA requirements: see PhenoML Terms of Service.
      *
      * @param {phenoml.construe.ExtractRequest} request
      * @param {Construe.RequestOptions} requestOptions - Request-specific configuration.
@@ -175,7 +177,7 @@ export class Construe {
         });
     }
     /**
-     * Returns metadata about all available code systems including built-in and custom systems.
+     * Returns the terminology server's catalog of available code systems, including both built-in standard terminologies and custom uploaded systems.
      *
      * @param {Construe.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -239,7 +241,9 @@ export class Construe {
         });
     }
     /**
-     * Returns a paginated list of all codes in the specified code system.
+     * Returns a paginated list of all codes in the specified code system from the terminology server.
+     *
+     * Usage of CPT is subject to AMA requirements: see PhenoML Terms of Service.
      *
      * @param {string} codesystem - Code system name (e.g., "ICD-10-CM", "SNOMED_CT_US_LITE")
      * @param {phenoml.construe.GetConstrueCodesCodesystemRequest} request
@@ -323,7 +327,9 @@ export class Construe {
         });
     }
     /**
-     * Returns details for a specific code within a code system.
+     * Looks up a specific code in the terminology server and returns its details.
+     *
+     * Usage of CPT is subject to AMA requirements: see PhenoML Terms of Service.
      *
      * @param {string} codesystem - Code system name
      * @param {string} codeId - The code identifier
@@ -416,6 +422,8 @@ export class Construe {
      *
      * See also: `/search/text` for faster keyword-based lookup with typo tolerance.
      *
+     * Usage of CPT is subject to AMA requirements: see PhenoML Terms of Service.
+     *
      * @param {string} codesystem - Code system name
      * @param {phenoml.construe.GetConstrueCodesCodesystemSearchSemanticRequest} request
      * @param {Construe.RequestOptions} requestOptions - Request-specific configuration.
@@ -518,6 +526,8 @@ export class Construe {
      *
      * See also: `/search/semantic` for finding conceptually similar codes.
      *
+     * Usage of CPT is subject to AMA requirements: see PhenoML Terms of Service.
+     *
      * @param {string} codesystem - Code system name
      * @param {phenoml.construe.GetConstrueCodesCodesystemSearchTextRequest} request
      * @param {Construe.RequestOptions} requestOptions - Request-specific configuration.
@@ -530,16 +540,16 @@ export class Construe {
      * @throws {@link phenoml.construe.ServiceUnavailableError}
      *
      * @example
-     *     await client.construe.textSearchKeywordBased("ICD-10-CM", {
+     *     await client.construe.terminologyServerTextSearch("ICD-10-CM", {
      *         q: "E11.65",
      *         version: "version",
      *         limit: 1
      *     })
      */
-    textSearchKeywordBased(codesystem, request, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__textSearchKeywordBased(codesystem, request, requestOptions));
+    terminologyServerTextSearch(codesystem, request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__terminologyServerTextSearch(codesystem, request, requestOptions));
     }
-    __textSearchKeywordBased(codesystem, request, requestOptions) {
+    __terminologyServerTextSearch(codesystem, request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
             const { q, version, limit } = request;

package/dist/esm/api/resources/construe/types/Citation.d.mts

@@ -0,0 +1,11 @@
+/**
+ * A reference to source text that led to a code extraction
+ */
+export interface Citation {
+    /** The exact text span containing evidence for the code */
+    text: string;
+    /** Starting byte offset in the original input text (0-indexed) */
+    begin_offset: number;
+    /** Ending byte offset (exclusive), such that input[begin_offset:end_offset] == text */
+    end_offset: number;
+}

package/dist/esm/api/resources/construe/types/Citation.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/construe/types/ExtractRequestConfig.d.mts

@@ -23,6 +23,14 @@ export interface ExtractRequestConfig {
     include_ancestors?: boolean;
     /** Whether to include codes that failed validation in the results */
     include_invalid?: boolean;
+    /**
+     * Whether to include source text citations for each extracted code.
+     * Citations show the exact text spans (with character offsets) that led to each code.
+     * Only available when using chunking_method: "sentences".
+     * The "none" method returns full text as one chunk (not useful for citations).
+     * LLM-based chunking (paragraphs, topics) does not support citations.
+     */
+    include_citations?: boolean;
 }
 export declare namespace ExtractRequestConfig {
     /** Method for splitting input text into chunks before code extraction */

package/dist/esm/api/resources/construe/types/ExtractRequestSystem.d.mts

@@ -12,7 +12,9 @@ export interface ExtractRequestSystem {
      * * CPT - version 2025
      *
      * Custom systems:
-     * * Any valid system name configured in your environment. Must have self-hosted construe module.
+     * * Any valid system name uploaded via /construe/upload. Requires a paid plan.
+     *
+     * Usage of CPT is subject to AMA requirements: see PhenoML Terms of Service.
      */
     name?: string;
     /** Code system version. Must match the version available in your environment. */

package/dist/esm/api/resources/construe/types/ExtractedCodeResult.d.mts

@@ -1,3 +1,4 @@
+import type * as phenoml from "../../../index.mjs";
 export interface ExtractedCodeResult {
     /** The extracted code */
     code: string;
@@ -9,4 +10,15 @@ export interface ExtractedCodeResult {
     longDescription?: string;
     /** Explanation for why this code was extracted (if include_rationale is true) */
     rationale?: string;
+    /**
+     * Whether this code is an ancestor (parent) of an extracted code rather than directly extracted.
+     * Only present when include_ancestors is true.
+     */
+    is_ancestor?: boolean;
+    /**
+     * Source text references showing where this code was found in the input.
+     * Only present when include_citations is true and chunking method supports it.
+     * Ancestor codes do not receive citations.
+     */
+    citations?: phenoml.construe.Citation[];
 }

package/dist/esm/api/resources/construe/types/index.d.mts

@@ -1,3 +1,4 @@
+export * from "./Citation.mjs";
 export * from "./CodeResponse.mjs";
 export * from "./CodeSystemDetails.mjs";
 export * from "./CodeSystemInfo.mjs";

package/dist/esm/api/resources/construe/types/index.mjs

@@ -1,3 +1,4 @@
+export * from "./Citation.mjs";
 export * from "./CodeResponse.mjs";
 export * from "./CodeSystemDetails.mjs";
 export * from "./CodeSystemInfo.mjs";

package/dist/esm/api/resources/fhir/client/Client.d.mts

@@ -30,6 +30,7 @@ export declare class Fhir {
      * @throws {@link phenoml.fhir.UnauthorizedError}
      * @throws {@link phenoml.fhir.NotFoundError}
      * @throws {@link phenoml.fhir.InternalServerError}
+     * @throws {@link phenoml.fhir.BadGatewayError}
      *
      * @example
      *     await client.fhir.search("550e8400-e29b-41d4-a716-446655440000", "Patient", {
@@ -58,6 +59,7 @@ export declare class Fhir {
      * @throws {@link phenoml.fhir.BadRequestError}
      * @throws {@link phenoml.fhir.UnauthorizedError}
      * @throws {@link phenoml.fhir.InternalServerError}
+     * @throws {@link phenoml.fhir.BadGatewayError}
      *
      * @example
      *     await client.fhir.create("550e8400-e29b-41d4-a716-446655440000", "Patient", {
@@ -99,6 +101,7 @@ export declare class Fhir {
      * @throws {@link phenoml.fhir.BadRequestError}
      * @throws {@link phenoml.fhir.UnauthorizedError}
      * @throws {@link phenoml.fhir.InternalServerError}
+     * @throws {@link phenoml.fhir.BadGatewayError}
      *
      * @example
      *     await client.fhir.upsert("550e8400-e29b-41d4-a716-446655440000", "Patient", {
@@ -143,6 +146,7 @@ export declare class Fhir {
      * @throws {@link phenoml.fhir.UnauthorizedError}
      * @throws {@link phenoml.fhir.NotFoundError}
      * @throws {@link phenoml.fhir.InternalServerError}
+     * @throws {@link phenoml.fhir.BadGatewayError}
      *
      * @example
      *     await client.fhir.delete("550e8400-e29b-41d4-a716-446655440000", "Patient", {
@@ -177,6 +181,7 @@ export declare class Fhir {
      * @throws {@link phenoml.fhir.UnauthorizedError}
      * @throws {@link phenoml.fhir.NotFoundError}
      * @throws {@link phenoml.fhir.InternalServerError}
+     * @throws {@link phenoml.fhir.BadGatewayError}
      *
      * @example
      *     await client.fhir.patch("550e8400-e29b-41d4-a716-446655440000", "Patient", {
@@ -258,6 +263,7 @@ export declare class Fhir {
      * @throws {@link phenoml.fhir.BadRequestError}
      * @throws {@link phenoml.fhir.UnauthorizedError}
      * @throws {@link phenoml.fhir.InternalServerError}
+     * @throws {@link phenoml.fhir.BadGatewayError}
      *
      * @example
      *     await client.fhir.executeBundle("550e8400-e29b-41d4-a716-446655440000", {

package/dist/esm/api/resources/fhir/client/Client.mjs

@@ -38,6 +38,7 @@ export class Fhir {
      * @throws {@link phenoml.fhir.UnauthorizedError}
      * @throws {@link phenoml.fhir.NotFoundError}
      * @throws {@link phenoml.fhir.InternalServerError}
+     * @throws {@link phenoml.fhir.BadGatewayError}
      *
      * @example
      *     await client.fhir.search("550e8400-e29b-41d4-a716-446655440000", "Patient", {
@@ -83,6 +84,8 @@ export class Fhir {
                         throw new phenoml.fhir.NotFoundError(_response.error.body, _response.rawResponse);
                     case 500:
                         throw new phenoml.fhir.InternalServerError(_response.error.body, _response.rawResponse);
+                    case 502:
+                        throw new phenoml.fhir.BadGatewayError(_response.error.body, _response.rawResponse);
                     default:
                         throw new errors.phenomlError({
                             statusCode: _response.error.statusCode,
@@ -127,6 +130,7 @@ export class Fhir {
      * @throws {@link phenoml.fhir.BadRequestError}
      * @throws {@link phenoml.fhir.UnauthorizedError}
      * @throws {@link phenoml.fhir.InternalServerError}
+     * @throws {@link phenoml.fhir.BadGatewayError}
      *
      * @example
      *     await client.fhir.create("550e8400-e29b-41d4-a716-446655440000", "Patient", {
@@ -182,6 +186,8 @@ export class Fhir {
                         throw new phenoml.fhir.UnauthorizedError(_response.error.body, _response.rawResponse);
                     case 500:
                         throw new phenoml.fhir.InternalServerError(_response.error.body, _response.rawResponse);
+                    case 502:
+                        throw new phenoml.fhir.BadGatewayError(_response.error.body, _response.rawResponse);
                     default:
                         throw new errors.phenomlError({
                             statusCode: _response.error.statusCode,
@@ -226,6 +232,7 @@ export class Fhir {
      * @throws {@link phenoml.fhir.BadRequestError}
      * @throws {@link phenoml.fhir.UnauthorizedError}
      * @throws {@link phenoml.fhir.InternalServerError}
+     * @throws {@link phenoml.fhir.BadGatewayError}
      *
      * @example
      *     await client.fhir.upsert("550e8400-e29b-41d4-a716-446655440000", "Patient", {
@@ -283,6 +290,8 @@ export class Fhir {
                         throw new phenoml.fhir.UnauthorizedError(_response.error.body, _response.rawResponse);
                     case 500:
                         throw new phenoml.fhir.InternalServerError(_response.error.body, _response.rawResponse);
+                    case 502:
+                        throw new phenoml.fhir.BadGatewayError(_response.error.body, _response.rawResponse);
                     default:
                         throw new errors.phenomlError({
                             statusCode: _response.error.statusCode,
@@ -328,6 +337,7 @@ export class Fhir {
      * @throws {@link phenoml.fhir.UnauthorizedError}
      * @throws {@link phenoml.fhir.NotFoundError}
      * @throws {@link phenoml.fhir.InternalServerError}
+     * @throws {@link phenoml.fhir.BadGatewayError}
      *
      * @example
      *     await client.fhir.delete("550e8400-e29b-41d4-a716-446655440000", "Patient", {
@@ -369,6 +379,8 @@ export class Fhir {
                         throw new phenoml.fhir.NotFoundError(_response.error.body, _response.rawResponse);
                     case 500:
                         throw new phenoml.fhir.InternalServerError(_response.error.body, _response.rawResponse);
+                    case 502:
+                        throw new phenoml.fhir.BadGatewayError(_response.error.body, _response.rawResponse);
                     default:
                         throw new errors.phenomlError({
                             statusCode: _response.error.statusCode,
@@ -419,6 +431,7 @@ export class Fhir {
      * @throws {@link phenoml.fhir.UnauthorizedError}
      * @throws {@link phenoml.fhir.NotFoundError}
      * @throws {@link phenoml.fhir.InternalServerError}
+     * @throws {@link phenoml.fhir.BadGatewayError}
      *
      * @example
      *     await client.fhir.patch("550e8400-e29b-41d4-a716-446655440000", "Patient", {
@@ -519,6 +532,8 @@ export class Fhir {
                         throw new phenoml.fhir.NotFoundError(_response.error.body, _response.rawResponse);
                     case 500:
                         throw new phenoml.fhir.InternalServerError(_response.error.body, _response.rawResponse);
+                    case 502:
+                        throw new phenoml.fhir.BadGatewayError(_response.error.body, _response.rawResponse);
                     default:
                         throw new errors.phenomlError({
                             statusCode: _response.error.statusCode,
@@ -560,6 +575,7 @@ export class Fhir {
      * @throws {@link phenoml.fhir.BadRequestError}
      * @throws {@link phenoml.fhir.UnauthorizedError}
      * @throws {@link phenoml.fhir.InternalServerError}
+     * @throws {@link phenoml.fhir.BadGatewayError}
      *
      * @example
      *     await client.fhir.executeBundle("550e8400-e29b-41d4-a716-446655440000", {
@@ -634,6 +650,8 @@ export class Fhir {
                         throw new phenoml.fhir.UnauthorizedError(_response.error.body, _response.rawResponse);
                     case 500:
                         throw new phenoml.fhir.InternalServerError(_response.error.body, _response.rawResponse);
+                    case 502:
+                        throw new phenoml.fhir.BadGatewayError(_response.error.body, _response.rawResponse);
                     default:
                         throw new errors.phenomlError({
                             statusCode: _response.error.statusCode,

package/dist/esm/api/resources/fhir/errors/BadGatewayError.d.mts

@@ -0,0 +1,6 @@
+import type * as core from "../../../../core/index.mjs";
+import * as errors from "../../../../errors/index.mjs";
+import type * as phenoml from "../../../index.mjs";
+export declare class BadGatewayError extends errors.phenomlError {
+    constructor(body: phenoml.fhir.ErrorResponse, rawResponse?: core.RawResponse);
+}

package/dist/esm/api/resources/fhir/errors/BadGatewayError.mjs

@@ -0,0 +1,13 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as errors from "../../../../errors/index.mjs";
+export class BadGatewayError extends errors.phenomlError {
+    constructor(body, rawResponse) {
+        super({
+            message: "BadGatewayError",
+            statusCode: 502,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, BadGatewayError.prototype);
+    }
+}

package/dist/esm/api/resources/fhir/errors/index.d.mts

@@ -1,3 +1,4 @@
+export * from "./BadGatewayError.mjs";
 export * from "./BadRequestError.mjs";
 export * from "./InternalServerError.mjs";
 export * from "./NotFoundError.mjs";

package/dist/esm/api/resources/fhir/errors/index.mjs

@@ -1,3 +1,4 @@
+export * from "./BadGatewayError.mjs";
 export * from "./BadRequestError.mjs";
 export * from "./InternalServerError.mjs";
 export * from "./NotFoundError.mjs";

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "2.0.0";
+export declare const SDK_VERSION = "3.1.0";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "2.0.0";
+export const SDK_VERSION = "3.1.0";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "phenoml",
-    "version": "2.0.0",
+    "version": "3.1.0",
     "private": false,
     "repository": "github:PhenoML/phenoml-ts-sdk",
     "type": "commonjs",

package/reference.md

@@ -29,7 +29,8 @@ Creates a new PhenoAgent with specified configuration
 ```typescript
 await client.agent.create({
     name: "name",
-    prompts: ["prompt_123", "prompt_456"]
+    prompts: ["prompt_123", "prompt_456"],
+    provider: "provider"
 });
 
 ```
@@ -223,7 +224,8 @@ Updates an existing agent's configuration
 ```typescript
 await client.agent.update("id", {
     name: "name",
-    prompts: ["prompt_123", "prompt_456"]
+    prompts: ["prompt_123", "prompt_456"],
+    provider: "provider"
 });
 
 ```
@@ -1151,7 +1153,7 @@ await client.cohort.analyze({
 <dl>
 <dd>
 
-Upload a custom medical code system with codes and descriptions for use in code extraction.
+Upload a custom medical code system with codes and descriptions for use in code extraction. Requires a paid plan.
 Upon upload, construe generates embeddings for all of the codes in the code system and stores them in the vector database so you can
 subsequently use the code system for construe/extract and lang2fhir/create (coming soon!)
 </dd>
@@ -1221,7 +1223,9 @@ await client.construe.uploadCodeSystem({
 <dl>
 <dd>
 
-Converts natural language text into structured medical codes
+Converts natural language text into structured medical codes.
+
+Usage of CPT is subject to AMA requirements: see PhenoML Terms of Service.
 </dd>
 </dl>
 </dd>
@@ -1286,7 +1290,7 @@ await client.construe.extractCodes({
 <dl>
 <dd>
 
-Returns metadata about all available code systems including built-in and custom systems.
+Returns the terminology server's catalog of available code systems, including both built-in standard terminologies and custom uploaded systems.
 </dd>
 </dl>
 </dd>
@@ -1341,7 +1345,9 @@ await client.construe.listAvailableCodeSystems();
 <dl>
 <dd>
 
-Returns a paginated list of all codes in the specified code system.
+Returns a paginated list of all codes in the specified code system from the terminology server.
+
+Usage of CPT is subject to AMA requirements: see PhenoML Terms of Service.
 </dd>
 </dl>
 </dd>
@@ -1416,7 +1422,9 @@ await client.construe.listCodesInACodeSystem("ICD-10-CM", {
 <dl>
 <dd>
 
-Returns details for a specific code within a code system.
+Looks up a specific code in the terminology server and returns its details.
+
+Usage of CPT is subject to AMA requirements: see PhenoML Terms of Service.
 </dd>
 </dl>
 </dd>
@@ -1512,6 +1520,8 @@ not just keywords.
 conceptually similar results that keyword search would miss.
 
 See also: `/search/text` for faster keyword-based lookup with typo tolerance.
+
+Usage of CPT is subject to AMA requirements: see PhenoML Terms of Service.
 </dd>
 </dl>
 </dd>
@@ -1574,7 +1584,7 @@ await client.construe.semanticSearchEmbeddingBased("ICD-10-CM", {
 </dl>
 </details>
 
-<details><summary><code>client.construe.<a href="/src/api/resources/construe/client/Client.ts">textSearchKeywordBased</a>(codesystem, { ...params }) -> phenoml.TextSearchResponse</code></summary>
+<details><summary><code>client.construe.<a href="/src/api/resources/construe/client/Client.ts">terminologyServerTextSearch</a>(codesystem, { ...params }) -> phenoml.TextSearchResponse</code></summary>
 <dl>
 <dd>
 
@@ -1604,6 +1614,8 @@ the code ID or specific keywords. Fast response times suitable for typeahead int
 Won't find conceptually related codes with different terminology.
 
 See also: `/search/semantic` for finding conceptually similar codes.
+
+Usage of CPT is subject to AMA requirements: see PhenoML Terms of Service.
 </dd>
 </dl>
 </dd>
@@ -1618,7 +1630,7 @@ See also: `/search/semantic` for finding conceptually similar codes.
 <dd>
 
 ```typescript
-await client.construe.textSearchKeywordBased("ICD-10-CM", {
+await client.construe.terminologyServerTextSearch("ICD-10-CM", {
     q: "E11.65",
     version: "version",
     limit: 1