phenoml 16.0.0 → 17.0.0

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

@@ -2,6 +2,8 @@ import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClie
 import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
 import * as core from "../../../../core/index.js";
 import * as phenoml from "../../../index.js";
+import { CodeSystemsClient } from "../resources/codeSystems/client/Client.js";
+import { CodesClient } from "../resources/codes/client/Client.js";
 export declare namespace ConstrueClient {
     type Options = BaseClientOptions;
     interface RequestOptions extends BaseRequestOptions {
@@ -9,292 +11,11 @@ export declare namespace ConstrueClient {
 }
 export declare class ConstrueClient {
     protected readonly _options: NormalizedClientOptionsWithAuth<ConstrueClient.Options>;
+    protected _codeSystems: CodeSystemsClient | undefined;
+    protected _codes: CodesClient | undefined;
     constructor(options?: ConstrueClient.Options);
-    /**
-     * Upload a custom medical code system with codes and descriptions for use in code extraction. Requires a paid plan.
-     * Returns 202 immediately; embedding generation runs asynchronously. Poll
-     * GET /construe/codes/systems/{codesystem}?version={version} to check when status
-     * transitions from "processing" to "ready" or "failed".
-     *
-     * @param {phenoml.construe.UploadRequest} request
-     * @param {ConstrueClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link phenoml.construe.BadRequestError}
-     * @throws {@link phenoml.construe.UnauthorizedError}
-     * @throws {@link phenoml.construe.ForbiddenError}
-     * @throws {@link phenoml.construe.ConflictError}
-     * @throws {@link phenoml.construe.FailedDependencyError}
-     * @throws {@link phenoml.construe.InternalServerError}
-     *
-     * @example
-     *     await client.construe.uploadCodeSystem({
-     *         name: "CUSTOM_CODES",
-     *         version: "1.0",
-     *         format: "json",
-     *         codes: [{
-     *                 code: "X001",
-     *                 description: "Example custom code 1"
-     *             }, {
-     *                 code: "X002",
-     *                 description: "Example custom code 2"
-     *             }]
-     *     })
-     *
-     * @example
-     *     await client.construe.uploadCodeSystem({
-     *         name: "CUSTOM_CODES",
-     *         version: "1.0",
-     *         format: "csv",
-     *         file: "Y29kZSxkZXNjcmlwdGlvbgpYMDAxLEV4YW1wbGUgY3VzdG9tIGNvZGUgMQo=",
-     *         code_col: "code",
-     *         desc_col: "description"
-     *     })
-     */
-    uploadCodeSystem(request: phenoml.construe.UploadRequest, requestOptions?: ConstrueClient.RequestOptions): core.HttpResponsePromise<phenoml.construe.UploadCodeSystemResponse>;
-    private __uploadCodeSystem;
-    /**
-     * 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 {ConstrueClient.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.extractCodes({
-     *         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.extractCodes({
-     *         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.extractCodes({
-     *         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.extractCodes({
-     *         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.extractCodes({
-     *         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
-     *         }
-     *     })
-     */
-    extractCodes(request: phenoml.construe.ExtractRequest, requestOptions?: ConstrueClient.RequestOptions): core.HttpResponsePromise<phenoml.construe.ExtractCodesResult>;
-    private __extractCodes;
-    /**
-     * Returns the terminology server's catalog of available code systems, including both built-in standard terminologies and custom uploaded systems.
-     *
-     * @param {ConstrueClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link phenoml.construe.UnauthorizedError}
-     * @throws {@link phenoml.construe.InternalServerError}
-     *
-     * @example
-     *     await client.construe.listCodeSystems()
-     */
-    listCodeSystems(requestOptions?: ConstrueClient.RequestOptions): core.HttpResponsePromise<phenoml.construe.ListCodeSystemsResponse>;
-    private __listCodeSystems;
-    /**
-     * Returns full metadata for a single code system, including timestamps and builtin status.
-     *
-     * @param {string} codesystem - Code system name (e.g., "ICD-10-CM", "SNOMED_CT_US_LITE")
-     * @param {phenoml.construe.GetCodeSystemRequest} request
-     * @param {ConstrueClient.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.getCodeSystem("ICD-10-CM", {
-     *         version: "2025"
-     *     })
-     */
-    getCodeSystem(codesystem: string, request?: phenoml.construe.GetCodeSystemRequest, requestOptions?: ConstrueClient.RequestOptions): core.HttpResponsePromise<phenoml.construe.GetCodeSystemDetailResponse>;
-    private __getCodeSystem;
-    /**
-     * Deletes a custom (non-builtin) code system and all its codes. Builtin systems cannot be deleted.
-     * Only available on dedicated instances. Large systems may take up to a minute to delete.
-     *
-     * @param {string} codesystem - Code system name
-     * @param {phenoml.construe.DeleteCodeSystemRequest} request
-     * @param {ConstrueClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link phenoml.construe.BadRequestError}
-     * @throws {@link phenoml.construe.UnauthorizedError}
-     * @throws {@link phenoml.construe.ForbiddenError}
-     * @throws {@link phenoml.construe.NotFoundError}
-     * @throws {@link phenoml.construe.InternalServerError}
-     *
-     * @example
-     *     await client.construe.deleteCodeSystem("CUSTOM_CODES", {
-     *         version: "version"
-     *     })
-     */
-    deleteCodeSystem(codesystem: string, request?: phenoml.construe.DeleteCodeSystemRequest, requestOptions?: ConstrueClient.RequestOptions): core.HttpResponsePromise<phenoml.construe.DeleteCodeSystemResponse>;
-    private __deleteCodeSystem;
-    /**
-     * Exports a custom (non-builtin) code system as a JSON file compatible with the upload format.
-     * The exported file can be re-uploaded directly via POST /construe/upload with format "json".
-     * Only available on dedicated instances. Builtin systems cannot be exported.
-     *
-     * @param {string} codesystem - Code system name
-     * @param {phenoml.construe.ExportCodeSystemRequest} request
-     * @param {ConstrueClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link phenoml.construe.BadRequestError}
-     * @throws {@link phenoml.construe.UnauthorizedError}
-     * @throws {@link phenoml.construe.ForbiddenError}
-     * @throws {@link phenoml.construe.NotFoundError}
-     * @throws {@link phenoml.construe.ConflictError}
-     * @throws {@link phenoml.construe.FailedDependencyError}
-     * @throws {@link phenoml.construe.InternalServerError}
-     *
-     * @example
-     *     await client.construe.exportCodeSystem("CUSTOM_CODES", {
-     *         version: "version"
-     *     })
-     */
-    exportCodeSystem(codesystem: string, request?: phenoml.construe.ExportCodeSystemRequest, requestOptions?: ConstrueClient.RequestOptions): core.HttpResponsePromise<phenoml.construe.ExportCodeSystemResponse>;
-    private __exportCodeSystem;
-    /**
-     * 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.ListCodesRequest} request
-     * @param {ConstrueClient.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.listCodes("ICD-10-CM", {
-     *         version: "2025",
-     *         cursor: "cursor",
-     *         limit: 1
-     *     })
-     */
-    listCodes(codesystem: string, request?: phenoml.construe.ListCodesRequest, requestOptions?: ConstrueClient.RequestOptions): core.HttpResponsePromise<phenoml.construe.ListCodesResponse>;
-    private __listCodes;
-    /**
-     * 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.GetCodeRequest} request
-     * @param {ConstrueClient.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.getCode("ICD-10-CM", "E1165", {
-     *         version: "version"
-     *     })
-     */
-    getCode(codesystem: string, codeID: string, request?: phenoml.construe.GetCodeRequest, requestOptions?: ConstrueClient.RequestOptions): core.HttpResponsePromise<phenoml.construe.GetCodeResponse>;
-    private __getCode;
-    /**
-     * 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 {ConstrueClient.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.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?: ConstrueClient.RequestOptions): core.HttpResponsePromise<phenoml.construe.SemanticSearchResponse>;
-    private __searchSemantic;
+    get codeSystems(): CodeSystemsClient;
+    get codes(): CodesClient;
     /**
      * Submits user feedback on results from the Construe extraction endpoint.
      * Feedback includes the full extraction result received and the result the user expected.
@@ -337,49 +58,4 @@ export declare class ConstrueClient {
      */
     submitFeedback(request: phenoml.construe.FeedbackRequest, requestOptions?: ConstrueClient.RequestOptions): core.HttpResponsePromise<phenoml.construe.FeedbackResponse>;
     private __submitFeedback;
-    /**
-     * 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 {ConstrueClient.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.searchText("ICD-10-CM", {
-     *         q: "E11.65",
-     *         version: "version",
-     *         limit: 1
-     *     })
-     */
-    searchText(codesystem: string, request: phenoml.construe.SearchTextRequest, requestOptions?: ConstrueClient.RequestOptions): core.HttpResponsePromise<phenoml.construe.TextSearchResponse>;
-    private __searchText;
 }