phenoml 5.2.0 → 6.0.0

package/reference.md

@@ -1154,8 +1154,9 @@ await client.cohort.analyze({
 <dd>
 
 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!)
+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".
 </dd>
 </dl>
 </dd>
@@ -1171,12 +1172,9 @@ subsequently use the code system for construe/extract and lang2fhir/create (comi
 
 ```typescript
 await client.construe.uploadCodeSystem({
-    format: "csv",
     name: "CUSTOM_CODES",
     version: "1.0",
-    file: "file",
-    code_col: "code",
-    desc_col: "description"
+    format: "csv"
 });
 
 ```
@@ -1193,7 +1191,7 @@ await client.construe.uploadCodeSystem({
 <dl>
 <dd>
 
-**request:** `phenoml.UploadRequest` 
+**request:** `phenoml.construe.UploadRequest` 
     
 </dd>
 </dl>
@@ -1478,6 +1476,81 @@ await client.construe.deleteCustomCodeSystem("CUSTOM_CODES", {
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.construe.<a href="/src/api/resources/construe/client/Client.ts">exportCustomCodeSystem</a>(codesystem, { ...params }) -> phenoml.ExportCodeSystemResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.construe.exportCustomCodeSystem("CUSTOM_CODES", {
+    version: "version"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**codesystem:** `string` — Code system name
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `phenoml.construe.GetConstrueCodesSystemsCodesystemExportRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Construe.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>

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

@@ -1,10 +0,0 @@
-import type * as phenoml from "../../../index.js";
-export type UploadRequest = phenoml.construe.UploadRequest.Csv | phenoml.construe.UploadRequest.Json;
-export declare namespace UploadRequest {
-    interface Csv extends phenoml.construe.UploadRequestCsv {
-        format: "csv";
-    }
-    interface Json extends phenoml.construe.UploadRequestJson {
-        format: "json";
-    }
-}

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

@@ -1,32 +0,0 @@
-export interface UploadRequestCsv {
-    /**
-     * Name of the code system. Names are case-insensitive and stored uppercase.
-     * Builtin system names (e.g. ICD-10-CM, SNOMED_CT_US_LITE, LOINC, CPT, etc.) are
-     * reserved and cannot be used for custom uploads; attempts return HTTP 403 Forbidden.
-     */
-    name: string;
-    /** Version of the code system */
-    version: string;
-    /** Optional revision number */
-    revision?: number;
-    /** The CSV file contents as a base64-encoded string. */
-    file: string;
-    /** Column name containing codes */
-    code_col: string;
-    /** Column name containing descriptions */
-    desc_col: string;
-    /** Optional column name containing long definitions */
-    defn_col?: string;
-    /**
-     * If true, replaces an existing code system with the same name and version.
-     * Builtin systems cannot be replaced; attempts to do so return HTTP 403 Forbidden.
-     * When false (default), uploading a duplicate returns 409 Conflict.
-     */
-    replace?: boolean;
-    /**
-     * If true, returns 202 Accepted immediately after validation and starts processing
-     * in the background. Poll GET /construe/codes/systems/{name}?version={version} to
-     * check when status transitions from "processing" to "ready" or "failed".
-     */
-    async?: boolean;
-}

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

@@ -1,40 +0,0 @@
-import type * as phenoml from "../../../index.js";
-/**
- * Upload codes in JSON format. Either 'file' or 'codes' must be provided.
- * If both are provided, 'codes' takes precedence.
- */
-export interface UploadRequestJson {
-    /**
-     * Name of the code system. Names are case-insensitive and stored uppercase.
-     * Builtin system names (e.g. ICD-10-CM, SNOMED_CT_US_LITE, LOINC, CPT, etc.) are
-     * reserved and cannot be used for custom uploads; attempts return HTTP 403 Forbidden.
-     */
-    name: string;
-    /** Version of the code system */
-    version: string;
-    /** Optional revision number */
-    revision?: number;
-    /**
-     * The file contents as a base64-encoded JSON array string.
-     * Prefer using 'codes' instead to pass the array directly without base64 encoding.
-     */
-    file?: string;
-    /**
-     * The codes to upload as a JSON array.
-     * This is the preferred way to upload JSON codes, as it avoids unnecessary base64 encoding.
-     * If both 'codes' and 'file' are provided, 'codes' takes precedence.
-     */
-    codes?: phenoml.construe.CodeResponse[];
-    /**
-     * If true, replaces an existing code system with the same name and version.
-     * Builtin systems cannot be replaced; attempts to do so return HTTP 403 Forbidden.
-     * When false (default), uploading a duplicate returns 409 Conflict.
-     */
-    replace?: boolean;
-    /**
-     * If true, returns 202 Accepted immediately after validation and starts processing
-     * in the background. Poll GET /construe/codes/systems/{name}?version={version} to
-     * check when status transitions from "processing" to "ready" or "failed".
-     */
-    async?: boolean;
-}

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

@@ -1,3 +0,0 @@
-"use strict";
-// This file was auto-generated by Fern from our API Definition.
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,10 +0,0 @@
-import type * as phenoml from "../../../index.mjs";
-export type UploadRequest = phenoml.construe.UploadRequest.Csv | phenoml.construe.UploadRequest.Json;
-export declare namespace UploadRequest {
-    interface Csv extends phenoml.construe.UploadRequestCsv {
-        format: "csv";
-    }
-    interface Json extends phenoml.construe.UploadRequestJson {
-        format: "json";
-    }
-}

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

@@ -1,32 +0,0 @@
-export interface UploadRequestCsv {
-    /**
-     * Name of the code system. Names are case-insensitive and stored uppercase.
-     * Builtin system names (e.g. ICD-10-CM, SNOMED_CT_US_LITE, LOINC, CPT, etc.) are
-     * reserved and cannot be used for custom uploads; attempts return HTTP 403 Forbidden.
-     */
-    name: string;
-    /** Version of the code system */
-    version: string;
-    /** Optional revision number */
-    revision?: number;
-    /** The CSV file contents as a base64-encoded string. */
-    file: string;
-    /** Column name containing codes */
-    code_col: string;
-    /** Column name containing descriptions */
-    desc_col: string;
-    /** Optional column name containing long definitions */
-    defn_col?: string;
-    /**
-     * If true, replaces an existing code system with the same name and version.
-     * Builtin systems cannot be replaced; attempts to do so return HTTP 403 Forbidden.
-     * When false (default), uploading a duplicate returns 409 Conflict.
-     */
-    replace?: boolean;
-    /**
-     * If true, returns 202 Accepted immediately after validation and starts processing
-     * in the background. Poll GET /construe/codes/systems/{name}?version={version} to
-     * check when status transitions from "processing" to "ready" or "failed".
-     */
-    async?: boolean;
-}

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

@@ -1,40 +0,0 @@
-import type * as phenoml from "../../../index.mjs";
-/**
- * Upload codes in JSON format. Either 'file' or 'codes' must be provided.
- * If both are provided, 'codes' takes precedence.
- */
-export interface UploadRequestJson {
-    /**
-     * Name of the code system. Names are case-insensitive and stored uppercase.
-     * Builtin system names (e.g. ICD-10-CM, SNOMED_CT_US_LITE, LOINC, CPT, etc.) are
-     * reserved and cannot be used for custom uploads; attempts return HTTP 403 Forbidden.
-     */
-    name: string;
-    /** Version of the code system */
-    version: string;
-    /** Optional revision number */
-    revision?: number;
-    /**
-     * The file contents as a base64-encoded JSON array string.
-     * Prefer using 'codes' instead to pass the array directly without base64 encoding.
-     */
-    file?: string;
-    /**
-     * The codes to upload as a JSON array.
-     * This is the preferred way to upload JSON codes, as it avoids unnecessary base64 encoding.
-     * If both 'codes' and 'file' are provided, 'codes' takes precedence.
-     */
-    codes?: phenoml.construe.CodeResponse[];
-    /**
-     * If true, replaces an existing code system with the same name and version.
-     * Builtin systems cannot be replaced; attempts to do so return HTTP 403 Forbidden.
-     * When false (default), uploading a duplicate returns 409 Conflict.
-     */
-    replace?: boolean;
-    /**
-     * If true, returns 202 Accepted immediately after validation and starts processing
-     * in the background. Poll GET /construe/codes/systems/{name}?version={version} to
-     * check when status transitions from "processing" to "ready" or "failed".
-     */
-    async?: boolean;
-}

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

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