phenoml 6.3.0 → 6.4.0

package/reference.md

@@ -427,7 +427,7 @@ await client.agent.patch("id", [{
 <dl>
 <dd>
 
-Send a message to an agent and receive a response
+Send a message to an agent and receive a JSON response.
 </dd>
 </dl>
 </dd>
@@ -479,6 +479,79 @@ await client.agent.chat({
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.agent.<a href="/src/api/resources/agent/client/Client.ts">streamChat</a>({ ...params }) -> core.Stream<phenoml.AgentChatStreamEvent></code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Send a message to an agent and receive the response as a Server-Sent Events
+(SSE) stream. Events include message_start, content_delta, tool_use,
+tool_result, message_end, and error.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+const response = await client.agent.streamChat({
+    "X-Phenoml-On-Behalf-Of": "Patient/550e8400-e29b-41d4-a716-446655440000",
+    "X-Phenoml-Fhir-Provider": "550e8400-e29b-41d4-a716-446655440000:eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c...",
+    message: "What is the patient's current condition?",
+    agent_id: "agent-123"
+});
+for await (const item of response) {
+    console.log(item);
+}
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `phenoml.agent.AgentStreamChatRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Agent.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -1632,7 +1705,7 @@ await client.construe.listCodesInACodeSystem("ICD-10-CM", {
 </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>
+<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>
 
@@ -1687,7 +1760,7 @@ await client.construe.getASpecificCode("ICD-10-CM", "E11.65", {
 <dl>
 <dd>
 
-**codeId:** `string` — The code identifier
+**codeID:** `string` — The code identifier
     
 </dd>
 </dl>
@@ -1907,7 +1980,7 @@ await client.construe.terminologyServerTextSearch("ICD-10-CM", {
 </details>
 
 ## Fhir
-<details><summary><code>client.fhir.<a href="/src/api/resources/fhir/client/Client.ts">search</a>(fhirProviderId, fhirPath, { ...params }) -> phenoml.FhirSearchResponse</code></summary>
+<details><summary><code>client.fhir.<a href="/src/api/resources/fhir/client/Client.ts">search</a>(fhir_provider_id, fhir_path, { ...params }) -> phenoml.FhirSearchResponse</code></summary>
 <dl>
 <dd>
 
@@ -1955,7 +2028,7 @@ await client.fhir.search("550e8400-e29b-41d4-a716-446655440000", "Patient", {
 <dl>
 <dd>
 
-**fhirProviderId:** `string` 
+**fhir_provider_id:** `string` 
 
 The ID of the FHIR provider to use. Can be either:
 - A UUID representing the provider ID
@@ -1967,7 +2040,7 @@ The ID of the FHIR provider to use. Can be either:
 <dl>
 <dd>
 
-**fhirPath:** `string` 
+**fhir_path:** `string` 
 
 The FHIR resource path to operate on. This follows FHIR RESTful API conventions.
 Examples:
@@ -2001,7 +2074,7 @@ Examples:
 </dl>
 </details>
 
-<details><summary><code>client.fhir.<a href="/src/api/resources/fhir/client/Client.ts">create</a>(fhirProviderId, fhirPath, { ...params }) -> phenoml.FhirResource</code></summary>
+<details><summary><code>client.fhir.<a href="/src/api/resources/fhir/client/Client.ts">create</a>(fhir_provider_id, fhir_path, { ...params }) -> phenoml.FhirResource</code></summary>
 <dl>
 <dd>
 
@@ -2062,7 +2135,7 @@ await client.fhir.create("550e8400-e29b-41d4-a716-446655440000", "Patient", {
 <dl>
 <dd>
 
-**fhirProviderId:** `string` 
+**fhir_provider_id:** `string` 
 
 The ID of the FHIR provider to use. Can be either:
 - A UUID representing the provider ID
@@ -2074,7 +2147,7 @@ The ID of the FHIR provider to use. Can be either:
 <dl>
 <dd>
 
-**fhirPath:** `string` 
+**fhir_path:** `string` 
 
 The FHIR resource path to operate on. This follows FHIR RESTful API conventions.
 Examples:
@@ -2108,7 +2181,7 @@ Examples:
 </dl>
 </details>
 
-<details><summary><code>client.fhir.<a href="/src/api/resources/fhir/client/Client.ts">upsert</a>(fhirProviderId, fhirPath, { ...params }) -> phenoml.FhirResource</code></summary>
+<details><summary><code>client.fhir.<a href="/src/api/resources/fhir/client/Client.ts">upsert</a>(fhir_provider_id, fhir_path, { ...params }) -> phenoml.FhirResource</code></summary>
 <dl>
 <dd>
 
@@ -2171,7 +2244,7 @@ await client.fhir.upsert("550e8400-e29b-41d4-a716-446655440000", "Patient", {
 <dl>
 <dd>
 
-**fhirProviderId:** `string` 
+**fhir_provider_id:** `string` 
 
 The ID of the FHIR provider to use. Can be either:
 - A UUID representing the provider ID
@@ -2183,7 +2256,7 @@ The ID of the FHIR provider to use. Can be either:
 <dl>
 <dd>
 
-**fhirPath:** `string` 
+**fhir_path:** `string` 
 
 The FHIR resource path to operate on. This follows FHIR RESTful API conventions.
 Examples:
@@ -2217,7 +2290,7 @@ Examples:
 </dl>
 </details>
 
-<details><summary><code>client.fhir.<a href="/src/api/resources/fhir/client/Client.ts">delete</a>(fhirProviderId, fhirPath, { ...params }) -> Record<string, unknown></code></summary>
+<details><summary><code>client.fhir.<a href="/src/api/resources/fhir/client/Client.ts">delete</a>(fhir_provider_id, fhir_path, { ...params }) -> Record<string, unknown></code></summary>
 <dl>
 <dd>
 
@@ -2265,7 +2338,7 @@ await client.fhir.delete("550e8400-e29b-41d4-a716-446655440000", "Patient", {
 <dl>
 <dd>
 
-**fhirProviderId:** `string` 
+**fhir_provider_id:** `string` 
 
 The ID of the FHIR provider to use. Can be either:
 - A UUID representing the provider ID
@@ -2277,7 +2350,7 @@ The ID of the FHIR provider to use. Can be either:
 <dl>
 <dd>
 
-**fhirPath:** `string` 
+**fhir_path:** `string` 
 
 The FHIR resource path to operate on. This follows FHIR RESTful API conventions.
 Examples:
@@ -2311,7 +2384,7 @@ Examples:
 </dl>
 </details>
 
-<details><summary><code>client.fhir.<a href="/src/api/resources/fhir/client/Client.ts">patch</a>(fhirProviderId, fhirPath, { ...params }) -> phenoml.FhirResource</code></summary>
+<details><summary><code>client.fhir.<a href="/src/api/resources/fhir/client/Client.ts">patch</a>(fhir_provider_id, fhir_path, { ...params }) -> phenoml.FhirResource</code></summary>
 <dl>
 <dd>
 
@@ -2369,7 +2442,7 @@ await client.fhir.patch("550e8400-e29b-41d4-a716-446655440000", "Patient", {
 <dl>
 <dd>
 
-**fhirProviderId:** `string` 
+**fhir_provider_id:** `string` 
 
 The ID of the FHIR provider to use. Can be either:
 - A UUID representing the provider ID
@@ -2381,7 +2454,7 @@ The ID of the FHIR provider to use. Can be either:
 <dl>
 <dd>
 
-**fhirPath:** `string` 
+**fhir_path:** `string` 
 
 The FHIR resource path to operate on. This follows FHIR RESTful API conventions.
 Examples:
@@ -2415,7 +2488,7 @@ Examples:
 </dl>
 </details>
 
-<details><summary><code>client.fhir.<a href="/src/api/resources/fhir/client/Client.ts">executeBundle</a>(fhirProviderId, { ...params }) -> phenoml.FhirBundle</code></summary>
+<details><summary><code>client.fhir.<a href="/src/api/resources/fhir/client/Client.ts">executeBundle</a>(fhir_provider_id, { ...params }) -> phenoml.FhirBundle</code></summary>
 <dl>
 <dd>
 
@@ -2497,7 +2570,7 @@ await client.fhir.executeBundle("550e8400-e29b-41d4-a716-446655440000", {
 <dl>
 <dd>
 
-**fhirProviderId:** `string` 
+**fhir_provider_id:** `string` 
 
 The ID of the FHIR provider to use. Can be either:
 - A UUID representing the provider ID
@@ -2658,7 +2731,7 @@ await client.fhirProvider.list();
 </dl>
 </details>
 
-<details><summary><code>client.fhirProvider.<a href="/src/api/resources/fhirProvider/client/Client.ts">get</a>(fhirProviderId) -> phenoml.FhirProviderResponse</code></summary>
+<details><summary><code>client.fhirProvider.<a href="/src/api/resources/fhirProvider/client/Client.ts">get</a>(fhir_provider_id) -> phenoml.FhirProviderResponse</code></summary>
 <dl>
 <dd>
 
@@ -2704,7 +2777,7 @@ await client.fhirProvider.get("fhir_provider_id");
 <dl>
 <dd>
 
-**fhirProviderId:** `string` — ID of the FHIR provider to retrieve
+**fhir_provider_id:** `string` — ID of the FHIR provider to retrieve
     
 </dd>
 </dl>
@@ -2724,7 +2797,7 @@ await client.fhirProvider.get("fhir_provider_id");
 </dl>
 </details>
 
-<details><summary><code>client.fhirProvider.<a href="/src/api/resources/fhirProvider/client/Client.ts">delete</a>(fhirProviderId) -> phenoml.FhirProviderDeleteResponse</code></summary>
+<details><summary><code>client.fhirProvider.<a href="/src/api/resources/fhirProvider/client/Client.ts">delete</a>(fhir_provider_id) -> phenoml.FhirProviderDeleteResponse</code></summary>
 <dl>
 <dd>
 
@@ -2769,7 +2842,7 @@ await client.fhirProvider.delete("fhir_provider_id");
 <dl>
 <dd>
 
-**fhirProviderId:** `string` — ID of the FHIR provider to delete
+**fhir_provider_id:** `string` — ID of the FHIR provider to delete
     
 </dd>
 </dl>
@@ -2789,7 +2862,7 @@ await client.fhirProvider.delete("fhir_provider_id");
 </dl>
 </details>
 
-<details><summary><code>client.fhirProvider.<a href="/src/api/resources/fhirProvider/client/Client.ts">addAuthConfig</a>(fhirProviderId, { ...params }) -> phenoml.FhirProviderResponse</code></summary>
+<details><summary><code>client.fhirProvider.<a href="/src/api/resources/fhirProvider/client/Client.ts">addAuthConfig</a>(fhir_provider_id, { ...params }) -> phenoml.FhirProviderResponse</code></summary>
 <dl>
 <dd>
 
@@ -2837,7 +2910,7 @@ await client.fhirProvider.addAuthConfig("1716d214-de93-43a4-aa6b-a878d864e2ad",
 <dl>
 <dd>
 
-**fhirProviderId:** `string` — ID of the FHIR provider to add auth config to
+**fhir_provider_id:** `string` — ID of the FHIR provider to add auth config to
     
 </dd>
 </dl>
@@ -2865,7 +2938,7 @@ await client.fhirProvider.addAuthConfig("1716d214-de93-43a4-aa6b-a878d864e2ad",
 </dl>
 </details>
 
-<details><summary><code>client.fhirProvider.<a href="/src/api/resources/fhirProvider/client/Client.ts">setActiveAuthConfig</a>(fhirProviderId, { ...params }) -> phenoml.FhirProviderResponse</code></summary>
+<details><summary><code>client.fhirProvider.<a href="/src/api/resources/fhirProvider/client/Client.ts">setActiveAuthConfig</a>(fhir_provider_id, { ...params }) -> phenoml.FhirProviderResponse</code></summary>
 <dl>
 <dd>
 
@@ -2916,7 +2989,7 @@ await client.fhirProvider.setActiveAuthConfig("1716d214-de93-43a4-aa6b-a878d864e
 <dl>
 <dd>
 
-**fhirProviderId:** `string` — ID of the FHIR provider
+**fhir_provider_id:** `string` — ID of the FHIR provider
     
 </dd>
 </dl>
@@ -2944,7 +3017,7 @@ await client.fhirProvider.setActiveAuthConfig("1716d214-de93-43a4-aa6b-a878d864e
 </dl>
 </details>
 
-<details><summary><code>client.fhirProvider.<a href="/src/api/resources/fhirProvider/client/Client.ts">removeAuthConfig</a>(fhirProviderId, { ...params }) -> phenoml.FhirProviderRemoveAuthConfigResponse</code></summary>
+<details><summary><code>client.fhirProvider.<a href="/src/api/resources/fhirProvider/client/Client.ts">removeAuthConfig</a>(fhir_provider_id, { ...params }) -> phenoml.FhirProviderRemoveAuthConfigResponse</code></summary>
 <dl>
 <dd>
 
@@ -2992,7 +3065,7 @@ await client.fhirProvider.removeAuthConfig("1716d214-de93-43a4-aa6b-a878d864e2ad
 <dl>
 <dd>
 
-**fhirProviderId:** `string` — ID of the FHIR provider
+**fhir_provider_id:** `string` — ID of the FHIR provider
     
 </dd>
 </dl>
@@ -4162,7 +4235,7 @@ await client.tools.mcpServer.list();
 </dl>
 </details>
 
-<details><summary><code>client.tools.mcpServer.<a href="/src/api/resources/tools/resources/mcpServer/client/Client.ts">get</a>(mcpServerId) -> phenoml.McpServerResponse</code></summary>
+<details><summary><code>client.tools.mcpServer.<a href="/src/api/resources/tools/resources/mcpServer/client/Client.ts">get</a>(mcp_server_id) -> phenoml.McpServerResponse</code></summary>
 <dl>
 <dd>
 
@@ -4205,7 +4278,7 @@ await client.tools.mcpServer.get("mcp_server_id");
 <dl>
 <dd>
 
-**mcpServerId:** `string` — ID of the MCP server to retrieve
+**mcp_server_id:** `string` — ID of the MCP server to retrieve
     
 </dd>
 </dl>
@@ -4225,7 +4298,7 @@ await client.tools.mcpServer.get("mcp_server_id");
 </dl>
 </details>
 
-<details><summary><code>client.tools.mcpServer.<a href="/src/api/resources/tools/resources/mcpServer/client/Client.ts">delete</a>(mcpServerId) -> phenoml.McpServerResponse</code></summary>
+<details><summary><code>client.tools.mcpServer.<a href="/src/api/resources/tools/resources/mcpServer/client/Client.ts">delete</a>(mcp_server_id) -> phenoml.McpServerResponse</code></summary>
 <dl>
 <dd>
 
@@ -4268,7 +4341,7 @@ await client.tools.mcpServer.delete("mcp_server_id");
 <dl>
 <dd>
 
-**mcpServerId:** `string` — ID of the MCP server to delete
+**mcp_server_id:** `string` — ID of the MCP server to delete
     
 </dd>
 </dl>
@@ -4289,7 +4362,7 @@ await client.tools.mcpServer.delete("mcp_server_id");
 </details>
 
 ## Tools McpServer Tools
-<details><summary><code>client.tools.mcpServer.tools.<a href="/src/api/resources/tools/resources/mcpServer/resources/tools/client/Client.ts">list</a>(mcpServerId) -> phenoml.McpServerToolResponse</code></summary>
+<details><summary><code>client.tools.mcpServer.tools.<a href="/src/api/resources/tools/resources/mcpServer/resources/tools/client/Client.ts">list</a>(mcp_server_id) -> phenoml.McpServerToolResponse</code></summary>
 <dl>
 <dd>
 
@@ -4332,7 +4405,7 @@ await client.tools.mcpServer.tools.list("mcp_server_id");
 <dl>
 <dd>
 
-**mcpServerId:** `string` — ID of the MCP server to list tools for
+**mcp_server_id:** `string` — ID of the MCP server to list tools for
     
 </dd>
 </dl>
@@ -4352,7 +4425,7 @@ await client.tools.mcpServer.tools.list("mcp_server_id");
 </dl>
 </details>
 
-<details><summary><code>client.tools.mcpServer.tools.<a href="/src/api/resources/tools/resources/mcpServer/resources/tools/client/Client.ts">get</a>(mcpServerToolId) -> phenoml.McpServerToolResponse</code></summary>
+<details><summary><code>client.tools.mcpServer.tools.<a href="/src/api/resources/tools/resources/mcpServer/resources/tools/client/Client.ts">get</a>(mcp_server_tool_id) -> phenoml.McpServerToolResponse</code></summary>
 <dl>
 <dd>
 
@@ -4395,7 +4468,7 @@ await client.tools.mcpServer.tools.get("mcp_server_tool_id");
 <dl>
 <dd>
 
-**mcpServerToolId:** `string` — ID of the MCP server tool to retrieve
+**mcp_server_tool_id:** `string` — ID of the MCP server tool to retrieve
     
 </dd>
 </dl>
@@ -4415,7 +4488,7 @@ await client.tools.mcpServer.tools.get("mcp_server_tool_id");
 </dl>
 </details>
 
-<details><summary><code>client.tools.mcpServer.tools.<a href="/src/api/resources/tools/resources/mcpServer/resources/tools/client/Client.ts">delete</a>(mcpServerToolId) -> phenoml.McpServerToolResponse</code></summary>
+<details><summary><code>client.tools.mcpServer.tools.<a href="/src/api/resources/tools/resources/mcpServer/resources/tools/client/Client.ts">delete</a>(mcp_server_tool_id) -> phenoml.McpServerToolResponse</code></summary>
 <dl>
 <dd>
 
@@ -4458,7 +4531,7 @@ await client.tools.mcpServer.tools.delete("mcp_server_tool_id");
 <dl>
 <dd>
 
-**mcpServerToolId:** `string` — ID of the MCP server tool to delete
+**mcp_server_tool_id:** `string` — ID of the MCP server tool to delete
     
 </dd>
 </dl>
@@ -4478,7 +4551,7 @@ await client.tools.mcpServer.tools.delete("mcp_server_tool_id");
 </dl>
 </details>
 
-<details><summary><code>client.tools.mcpServer.tools.<a href="/src/api/resources/tools/resources/mcpServer/resources/tools/client/Client.ts">call</a>(mcpServerToolId, { ...params }) -> phenoml.McpServerToolCallResponse</code></summary>
+<details><summary><code>client.tools.mcpServer.tools.<a href="/src/api/resources/tools/resources/mcpServer/resources/tools/client/Client.ts">call</a>(mcp_server_tool_id, { ...params }) -> phenoml.McpServerToolCallResponse</code></summary>
 <dl>
 <dd>
 
@@ -4525,7 +4598,7 @@ await client.tools.mcpServer.tools.call("mcp_server_tool_id", {
 <dl>
 <dd>
 
-**mcpServerToolId:** `string` — ID of the MCP server tool to call
+**mcp_server_tool_id:** `string` — ID of the MCP server tool to call
     
 </dd>
 </dl>