phenoml 1.0.0 → 1.1.0

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

@@ -0,0 +1,10 @@
+import type * as phenoml from "../../../index.mjs";
+export interface GetCodeResponse {
+    system: phenoml.construe.CodeSystemInfo;
+    /** The code identifier */
+    code: string;
+    /** Short description of the code */
+    description: string;
+    /** Extended definition of the code (if available) */
+    definition?: string;
+}

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

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

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

@@ -0,0 +1,4 @@
+import type * as phenoml from "../../../index.mjs";
+export interface ListCodeSystemsResponse {
+    systems: phenoml.construe.CodeSystemDetails[];
+}

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

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

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

@@ -0,0 +1,9 @@
+import type * as phenoml from "../../../index.mjs";
+export interface ListCodesResponse {
+    system: phenoml.construe.CodeSystemInfo;
+    codes: phenoml.construe.CodeResponse[];
+    /** Cursor for fetching the next page (null if no more results) */
+    next_cursor?: string;
+    /** Whether there are more results available */
+    has_more: boolean;
+}

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

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

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

@@ -0,0 +1,6 @@
+import type * as phenoml from "../../../index.mjs";
+export interface SemanticSearchResponse {
+    system: phenoml.construe.CodeSystemInfo;
+    /** Codes ordered by semantic similarity (most similar first) */
+    results: phenoml.construe.SemanticSearchResult[];
+}

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

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

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

@@ -0,0 +1,4 @@
+export interface SemanticSearchResult {
+    code: string;
+    description: string;
+}

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

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

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

@@ -0,0 +1,8 @@
+import type * as phenoml from "../../../index.mjs";
+export interface TextSearchResponse {
+    system: phenoml.construe.CodeSystemInfo;
+    /** Codes matching the search query */
+    results: phenoml.construe.TextSearchResult[];
+    /** Total number of matching results (may exceed results array due to pagination) */
+    found: number;
+}

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

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

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

@@ -0,0 +1,4 @@
+export interface TextSearchResult {
+    code: string;
+    description: string;
+}

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

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

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

@@ -1,5 +1,15 @@
+export * from "./CodeResponse.mjs";
+export * from "./CodeSystemDetails.mjs";
+export * from "./CodeSystemInfo.mjs";
 export * from "./ConstrueUploadCodeSystemResponse.mjs";
 export * from "./ExtractCodesResult.mjs";
 export * from "./ExtractedCodeResult.mjs";
 export * from "./ExtractRequestConfig.mjs";
 export * from "./ExtractRequestSystem.mjs";
+export * from "./GetCodeResponse.mjs";
+export * from "./ListCodeSystemsResponse.mjs";
+export * from "./ListCodesResponse.mjs";
+export * from "./SemanticSearchResponse.mjs";
+export * from "./SemanticSearchResult.mjs";
+export * from "./TextSearchResponse.mjs";
+export * from "./TextSearchResult.mjs";

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

@@ -1,5 +1,15 @@
+export * from "./CodeResponse.mjs";
+export * from "./CodeSystemDetails.mjs";
+export * from "./CodeSystemInfo.mjs";
 export * from "./ConstrueUploadCodeSystemResponse.mjs";
 export * from "./ExtractCodesResult.mjs";
 export * from "./ExtractedCodeResult.mjs";
 export * from "./ExtractRequestConfig.mjs";
 export * from "./ExtractRequestSystem.mjs";
+export * from "./GetCodeResponse.mjs";
+export * from "./ListCodeSystemsResponse.mjs";
+export * from "./ListCodesResponse.mjs";
+export * from "./SemanticSearchResponse.mjs";
+export * from "./SemanticSearchResult.mjs";
+export * from "./TextSearchResponse.mjs";
+export * from "./TextSearchResult.mjs";

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "1.0.0";
+export declare const SDK_VERSION = "1.1.0";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "1.0.0";
+export const SDK_VERSION = "1.1.0";

package/package.json

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

package/reference.md

@@ -1271,6 +1271,398 @@ await client.construe.extractCodes({
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.construe.<a href="/src/api/resources/construe/client/Client.ts">listAvailableCodeSystems</a>() -> phenoml.ListCodeSystemsResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Returns metadata about all available code systems including built-in and custom systems.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.construe.listAvailableCodeSystems();
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `Construe.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.construe.<a href="/src/api/resources/construe/client/Client.ts">listCodesInACodeSystem</a>(codesystem, { ...params }) -> phenoml.ListCodesResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Returns a paginated list of all codes in the specified code system.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.construe.listCodesInACodeSystem("ICD-10-CM", {
+    version: "2025",
+    cursor: "cursor",
+    limit: 1
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**codesystem:** `string` — Code system name (e.g., "ICD-10-CM", "SNOMED_CT_US_LITE")
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `phenoml.construe.GetConstrueCodesCodesystemRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Construe.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.construe.<a href="/src/api/resources/construe/client/Client.ts">getASpecificCode</a>(codesystem, codeId, { ...params }) -> phenoml.GetCodeResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Returns details for a specific code within a code system.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.construe.getASpecificCode("ICD-10-CM", "E11.65", {
+    version: "version"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**codesystem:** `string` — Code system name
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**codeId:** `string` — The code identifier
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `phenoml.construe.GetConstrueCodesCodesystemCodeIdRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Construe.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.construe.<a href="/src/api/resources/construe/client/Client.ts">semanticSearchEmbeddingBased</a>(codesystem, { ...params }) -> phenoml.SemanticSearchResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Performs semantic similarity search using vector embeddings.
+
+**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.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.construe.semanticSearchEmbeddingBased("ICD-10-CM", {
+    text: "patient has trouble breathing at night and wakes up gasping",
+    version: "version",
+    limit: 1
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**codesystem:** `string` — Code system name
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `phenoml.construe.GetConstrueCodesCodesystemSearchSemanticRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Construe.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.construe.<a href="/src/api/resources/construe/client/Client.ts">textSearchKeywordBased</a>(codesystem, { ...params }) -> phenoml.TextSearchResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Performs fast full-text search over code IDs and descriptions.
+
+**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.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.construe.textSearchKeywordBased("ICD-10-CM", {
+    q: "E11.65",
+    version: "version",
+    limit: 1
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**codesystem:** `string` — Code system name
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `phenoml.construe.GetConstrueCodesCodesystemSearchTextRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Construe.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>