phenoml 16.0.0 → 17.0.0

package/dist/{cjs/api/resources/construe/types/UploadCodeSystemResponse.d.ts → esm/api/resources/construe/resources/codeSystems/types/UploadResponse.d.mts}

@@ -1,4 +1,4 @@
-export interface UploadCodeSystemResponse {
+export interface UploadResponse {
     status?: string | undefined;
     name?: string | undefined;
     version?: string | undefined;

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

@@ -0,0 +1 @@
+export * from "./UploadResponse.mjs";

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

@@ -0,0 +1 @@
+export * from "./UploadResponse.mjs";

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

@@ -0,0 +1,227 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../../../BaseClient.mjs";
+import { type NormalizedClientOptionsWithAuth } from "../../../../../../BaseClient.mjs";
+import * as core from "../../../../../../core/index.mjs";
+import * as phenoml from "../../../../../index.mjs";
+export declare namespace CodesClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+/**
+ * Extract and search codes within a code system.
+ */
+export declare class CodesClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<CodesClient.Options>;
+    constructor(options?: CodesClient.Options);
+    /**
+     * 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 {CodesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link phenoml.construe.BadRequestError}
+     * @throws {@link phenoml.construe.UnauthorizedError}
+     * @throws {@link phenoml.construe.NotFoundError}
+     * @throws {@link phenoml.construe.InternalServerError}
+     * @throws {@link phenoml.construe.ServiceUnavailableError}
+     * @throws {@link phenoml.construe.GatewayTimeoutError}
+     *
+     * @example
+     *     await client.construe.codes.extract({
+     *         text: "Patient is a 14-year-old female, previously healthy, who is here for evaluation of abnormal renal ultrasound with atrophic right kidney.",
+     *         system: {
+     *             name: "ICD-10-CM",
+     *             version: "2025"
+     *         }
+     *     })
+     *
+     * @example
+     *     await client.construe.codes.extract({
+     *         text: "45-year-old male presents with chest pain radiating to left arm, shortness of breath, and diaphoresis. ECG shows ST elevation in leads II, III, and aVF.",
+     *         system: {
+     *             name: "SNOMED_CT_US_LITE",
+     *             version: "20240901"
+     *         },
+     *         config: {
+     *             chunking_method: "sentences",
+     *             validation_method: "simple",
+     *             include_rationale: true,
+     *             include_citations: true
+     *         }
+     *     })
+     *
+     * @example
+     *     await client.construe.codes.extract({
+     *         text: "Start Metformin 500mg twice daily for type 2 diabetes. Continue Lisinopril 10mg daily for hypertension. Add Atorvastatin 20mg at bedtime.",
+     *         system: {
+     *             name: "RXNORM",
+     *             version: "11042024"
+     *         },
+     *         config: {
+     *             validation_method: "medication_search",
+     *             include_rationale: true
+     *         }
+     *     })
+     *
+     * @example
+     *     await client.construe.codes.extract({
+     *         text: "Patient diagnosed with Type 2 diabetes mellitus with diabetic chronic kidney disease, stage 3.",
+     *         system: {
+     *             name: "ICD-10-CM",
+     *             version: "2025"
+     *         },
+     *         config: {
+     *             validation_method: "simple",
+     *             include_ancestors: true
+     *         }
+     *     })
+     *
+     * @example
+     *     await client.construe.codes.extract({
+     *         text: "5-year-old male with seizures, severe intellectual disability, microcephaly, and hypotonia.",
+     *         system: {
+     *             name: "HPO",
+     *             version: "2025"
+     *         },
+     *         config: {
+     *             chunking_method: "fasthpocr",
+     *             validation_method: "none",
+     *             include_rationale: false
+     *         }
+     *     })
+     */
+    extract(request: phenoml.construe.ExtractRequest, requestOptions?: CodesClient.RequestOptions): core.HttpResponsePromise<phenoml.construe.ExtractCodesResult>;
+    private __extract;
+    /**
+     * 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.CodesListRequest} request
+     * @param {CodesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link phenoml.construe.BadRequestError}
+     * @throws {@link phenoml.construe.UnauthorizedError}
+     * @throws {@link phenoml.construe.NotFoundError}
+     * @throws {@link phenoml.construe.InternalServerError}
+     *
+     * @example
+     *     await client.construe.codes.list("ICD-10-CM", {
+     *         version: "2025",
+     *         cursor: "cursor",
+     *         limit: 1
+     *     })
+     */
+    list(codesystem: string, request?: phenoml.construe.CodesListRequest, requestOptions?: CodesClient.RequestOptions): core.HttpResponsePromise<phenoml.construe.ListCodesResponse>;
+    private __list;
+    /**
+     * 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. ICD-10-CM codes are stored without their
+     *                          cosmetic dot (use "E1165", not "E11.65").
+     * @param {phenoml.construe.LookupRequest} request
+     * @param {CodesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link phenoml.construe.BadRequestError}
+     * @throws {@link phenoml.construe.UnauthorizedError}
+     * @throws {@link phenoml.construe.NotFoundError}
+     * @throws {@link phenoml.construe.InternalServerError}
+     *
+     * @example
+     *     await client.construe.codes.lookup("ICD-10-CM", "E1165", {
+     *         version: "version"
+     *     })
+     */
+    lookup(codesystem: string, codeID: string, request?: phenoml.construe.LookupRequest, requestOptions?: CodesClient.RequestOptions): core.HttpResponsePromise<phenoml.construe.GetCodeResponse>;
+    private __lookup;
+    /**
+     * Performs semantic similarity search using vector embeddings.
+     *
+     * **Availability**: This endpoint works for both **built-in and custom** code systems.
+     *
+     * **When to use**: Best for natural language queries where you want to find conceptually
+     * related codes, even when different terminology is used. The search understands meaning,
+     * not just keywords.
+     *
+     * **Examples**:
+     * - Query "trouble breathing at night" finds codes like "Sleep apnea", "Orthopnea",
+     *   "Nocturnal dyspnea" — semantically related but no exact keyword matches
+     * - Query "heart problems" finds "Myocardial infarction", "Cardiac arrest", "Arrhythmia"
+     *
+     * **Trade-offs**: Slower than text search (requires embedding generation), but finds
+     * 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.
+     *
+     * @param {string} codesystem - Code system name
+     * @param {phenoml.construe.SearchSemanticRequest} request
+     * @param {CodesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link phenoml.construe.BadRequestError}
+     * @throws {@link phenoml.construe.UnauthorizedError}
+     * @throws {@link phenoml.construe.NotFoundError}
+     * @throws {@link phenoml.construe.InternalServerError}
+     *
+     * @example
+     *     await client.construe.codes.searchSemantic("ICD-10-CM", {
+     *         text: "patient has trouble breathing at night and wakes up gasping",
+     *         version: "version",
+     *         limit: 1
+     *     })
+     */
+    searchSemantic(codesystem: string, request: phenoml.construe.SearchSemanticRequest, requestOptions?: CodesClient.RequestOptions): core.HttpResponsePromise<phenoml.construe.SemanticSearchResponse>;
+    private __searchSemantic;
+    /**
+     * Performs fast full-text search over code IDs and descriptions.
+     *
+     * **Availability**: This endpoint is only available for **built-in code systems**.
+     * Custom code systems uploaded via `/construe/upload` are not indexed for full-text search
+     * and will return empty results. Use `/search/semantic` to search custom code systems.
+     *
+     * **When to use**: Best for autocomplete UIs, code lookup, or when users know part of
+     * the code ID or specific keywords. Fast response times suitable for typeahead interfaces.
+     *
+     * **Features**:
+     * - Substring matching on code IDs (e.g., "11.65" finds "E11.65")
+     * - Typo tolerance on descriptions (not on code IDs)
+     * - Fast response times (~10-50ms)
+     *
+     * **Examples**:
+     * - Query "E11" finds all codes starting with E11 (diabetes codes)
+     * - Query "diabtes" (typo) still finds "diabetes" codes
+     *
+     * **Trade-offs**: Faster than semantic search, but only matches keywords/substrings.
+     * 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.
+     *
+     * @param {string} codesystem - Code system name
+     * @param {phenoml.construe.SearchTextRequest} request
+     * @param {CodesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link phenoml.construe.BadRequestError}
+     * @throws {@link phenoml.construe.UnauthorizedError}
+     * @throws {@link phenoml.construe.NotFoundError}
+     * @throws {@link phenoml.construe.InternalServerError}
+     * @throws {@link phenoml.construe.NotImplementedError}
+     *
+     * @example
+     *     await client.construe.codes.searchText("ICD-10-CM", {
+     *         q: "E11.65",
+     *         version: "version",
+     *         limit: 1
+     *     })
+     */
+    searchText(codesystem: string, request: phenoml.construe.SearchTextRequest, requestOptions?: CodesClient.RequestOptions): core.HttpResponsePromise<phenoml.construe.TextSearchResponse>;
+    private __searchText;
+}