@amigo-ai/platform-sdk 0.9.1 → 0.9.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -1
- package/dist/types/generated/api.d.ts +120 -62
- package/dist/types/generated/api.d.ts.map +1 -1
- package/dist/types/resources/functions.d.ts.map +1 -1
- package/dist/types/resources/metrics.d.ts.map +1 -1
- package/dist/types/resources/settings.d.ts +10 -0
- package/dist/types/resources/settings.d.ts.map +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -483,7 +483,13 @@ Build ambient clinical documentation tools. The SDK covers encounter review acti
|
|
|
483
483
|
```typescript
|
|
484
484
|
// Configure scribe settings
|
|
485
485
|
const settings = await client.settings.scribe.get()
|
|
486
|
-
await client.settings.scribe.update({
|
|
486
|
+
await client.settings.scribe.update({
|
|
487
|
+
enabled: true,
|
|
488
|
+
soap_style: 'detailed',
|
|
489
|
+
language: 'es',
|
|
490
|
+
keyterms: ['metformin', 'Ozempic', 'Dr. Ramirez'],
|
|
491
|
+
specialty: 'Primary care',
|
|
492
|
+
})
|
|
487
493
|
|
|
488
494
|
// Approve ICD-10 codes after physician review
|
|
489
495
|
await client.POST('/v1/{workspace_id}/scribe/encounters/{encounter_id}/icd10/approve', {
|
|
@@ -3320,26 +3320,6 @@ export interface paths {
|
|
|
3320
3320
|
patch?: never;
|
|
3321
3321
|
trace?: never;
|
|
3322
3322
|
};
|
|
3323
|
-
"/v1/{workspace_id}/intake/links/{link_id}/uploads/{upload_id}/download": {
|
|
3324
|
-
parameters: {
|
|
3325
|
-
query?: never;
|
|
3326
|
-
header?: never;
|
|
3327
|
-
path?: never;
|
|
3328
|
-
cookie?: never;
|
|
3329
|
-
};
|
|
3330
|
-
/**
|
|
3331
|
-
* Download an uploaded file
|
|
3332
|
-
* @description Proxy the raw file bytes from the UC Volume back to the caller.
|
|
3333
|
-
*/
|
|
3334
|
-
get: operations["download-intake-upload"];
|
|
3335
|
-
put?: never;
|
|
3336
|
-
post?: never;
|
|
3337
|
-
delete?: never;
|
|
3338
|
-
options?: never;
|
|
3339
|
-
head?: never;
|
|
3340
|
-
patch?: never;
|
|
3341
|
-
trace?: never;
|
|
3342
|
-
};
|
|
3343
3323
|
"/v1/{workspace_id}/integrations": {
|
|
3344
3324
|
parameters: {
|
|
3345
3325
|
query?: never;
|
|
@@ -3825,8 +3805,8 @@ export interface paths {
|
|
|
3825
3805
|
*
|
|
3826
3806
|
* Returns aggregate stats about the memory extraction pipeline:
|
|
3827
3807
|
* per-dimension fact counts, coverage rates, source intelligence,
|
|
3828
|
-
* and recent activity. Cached in Valkey (60s TTL).
|
|
3829
|
-
*
|
|
3808
|
+
* and recent activity. Cached in Valkey (60s TTL). Reads only Lakebase
|
|
3809
|
+
* memory projections on cache miss.
|
|
3830
3810
|
*
|
|
3831
3811
|
* Permissions: authenticated (any role).
|
|
3832
3812
|
*/
|
|
@@ -3890,6 +3870,35 @@ export interface paths {
|
|
|
3890
3870
|
patch?: never;
|
|
3891
3871
|
trace?: never;
|
|
3892
3872
|
};
|
|
3873
|
+
"/v1/{workspace_id}/metering/emit": {
|
|
3874
|
+
parameters: {
|
|
3875
|
+
query?: never;
|
|
3876
|
+
header?: never;
|
|
3877
|
+
path?: never;
|
|
3878
|
+
cookie?: never;
|
|
3879
|
+
};
|
|
3880
|
+
get?: never;
|
|
3881
|
+
put?: never;
|
|
3882
|
+
/**
|
|
3883
|
+
* Emit Metering Event
|
|
3884
|
+
* @description Emit one metering event for the calling workspace.
|
|
3885
|
+
*
|
|
3886
|
+
* Scope: workspace-scoped via path param; auth via API key (same as every
|
|
3887
|
+
* other workspace route). 202 on success — emission is fire-and-forget.
|
|
3888
|
+
*
|
|
3889
|
+
* ``event_type`` is a free-form string (regex-validated). Aggregation
|
|
3890
|
+
* into ``customer_meter_values`` is handled by SDP materialized views
|
|
3891
|
+
* in ``databricks/pipelines/billing.py``; an event_type with no matching
|
|
3892
|
+
* MV still lands in ``world_events`` but doesn't roll up into invoices
|
|
3893
|
+
* until someone adds an MV for it.
|
|
3894
|
+
*/
|
|
3895
|
+
post: operations["emit-metering-event"];
|
|
3896
|
+
delete?: never;
|
|
3897
|
+
options?: never;
|
|
3898
|
+
head?: never;
|
|
3899
|
+
patch?: never;
|
|
3900
|
+
trace?: never;
|
|
3901
|
+
};
|
|
3893
3902
|
"/v1/{workspace_id}/metrics": {
|
|
3894
3903
|
parameters: {
|
|
3895
3904
|
query?: never;
|
|
@@ -16507,6 +16516,25 @@ export interface components {
|
|
|
16507
16516
|
*/
|
|
16508
16517
|
value: string;
|
|
16509
16518
|
};
|
|
16519
|
+
/** MeteringEmitRequest */
|
|
16520
|
+
MeteringEmitRequest: {
|
|
16521
|
+
/** Event Type */
|
|
16522
|
+
event_type: string;
|
|
16523
|
+
/**
|
|
16524
|
+
* Metering Metadata
|
|
16525
|
+
* @description Optional audit/dispute breadcrumbs.
|
|
16526
|
+
*/
|
|
16527
|
+
metering_metadata?: {
|
|
16528
|
+
[key: string]: unknown;
|
|
16529
|
+
} | null;
|
|
16530
|
+
/** Metering Quantity */
|
|
16531
|
+
metering_quantity: number;
|
|
16532
|
+
/**
|
|
16533
|
+
* Metering Unit
|
|
16534
|
+
* @description Optional unit string ('pages', 'minutes', 'tokens') describing what metering_quantity represents.
|
|
16535
|
+
*/
|
|
16536
|
+
metering_unit?: string | null;
|
|
16537
|
+
};
|
|
16510
16538
|
/** MetricCatalogEntry */
|
|
16511
16539
|
MetricCatalogEntry: {
|
|
16512
16540
|
/** Builtin */
|
|
@@ -18298,8 +18326,18 @@ export interface components {
|
|
|
18298
18326
|
umap_y: number;
|
|
18299
18327
|
/** Workspace Id */
|
|
18300
18328
|
workspace_id: string;
|
|
18329
|
+
/** Y Hat Asthma 12Mo */
|
|
18330
|
+
y_hat_asthma_12mo?: number | null;
|
|
18331
|
+
/** Y Hat Chf 90D */
|
|
18332
|
+
y_hat_chf_90d?: number | null;
|
|
18333
|
+
/** Y Hat Ckd 1Yr */
|
|
18334
|
+
y_hat_ckd_1yr?: number | null;
|
|
18301
18335
|
/** Y Hat Composite */
|
|
18302
18336
|
y_hat_composite?: number | null;
|
|
18337
|
+
/** Y Hat Copd 12Mo */
|
|
18338
|
+
y_hat_copd_12mo?: number | null;
|
|
18339
|
+
/** Y Hat Htn 1Yr */
|
|
18340
|
+
y_hat_htn_1yr?: number | null;
|
|
18303
18341
|
/** Y Hat T2D 1Yr */
|
|
18304
18342
|
y_hat_t2d_1yr?: number | null;
|
|
18305
18343
|
};
|
|
@@ -19941,12 +19979,22 @@ export interface components {
|
|
|
19941
19979
|
/** Authorized Clinicians */
|
|
19942
19980
|
authorized_clinicians?: components["schemas"]["ScribeClinician"][] | null;
|
|
19943
19981
|
cds?: components["schemas"]["ScribeCdsConfig"] | null;
|
|
19982
|
+
/** Custom Instructions */
|
|
19983
|
+
custom_instructions?: string | null;
|
|
19944
19984
|
/** Enabled */
|
|
19945
19985
|
enabled?: boolean | null;
|
|
19986
|
+
/** Keyterms */
|
|
19987
|
+
keyterms?: string[] | null;
|
|
19988
|
+
/** Language */
|
|
19989
|
+
language?: string | null;
|
|
19946
19990
|
post_encounter?: components["schemas"]["ScribePostEncounterConfig"] | null;
|
|
19947
19991
|
safety?: components["schemas"]["ScribeSafetyConfig"] | null;
|
|
19948
19992
|
/** Soap Style */
|
|
19949
19993
|
soap_style?: ("concise" | "detailed" | "structured") | null;
|
|
19994
|
+
/** Specialty */
|
|
19995
|
+
specialty?: string | null;
|
|
19996
|
+
/** Tools Enabled */
|
|
19997
|
+
tools_enabled?: string[] | null;
|
|
19950
19998
|
/** Voice Auth Enabled */
|
|
19951
19999
|
voice_auth_enabled?: boolean | null;
|
|
19952
20000
|
};
|
|
@@ -19955,8 +20003,17 @@ export interface components {
|
|
|
19955
20003
|
/** Authorized Clinicians */
|
|
19956
20004
|
authorized_clinicians: components["schemas"]["ScribeClinician"][];
|
|
19957
20005
|
cds?: components["schemas"]["ScribeCdsConfig"];
|
|
20006
|
+
/** Custom Instructions */
|
|
20007
|
+
custom_instructions?: string | null;
|
|
19958
20008
|
/** Enabled */
|
|
19959
20009
|
enabled: boolean;
|
|
20010
|
+
/** Keyterms */
|
|
20011
|
+
keyterms?: string[];
|
|
20012
|
+
/**
|
|
20013
|
+
* Language
|
|
20014
|
+
* @default en
|
|
20015
|
+
*/
|
|
20016
|
+
language?: string;
|
|
19960
20017
|
post_encounter?: components["schemas"]["ScribePostEncounterConfig"];
|
|
19961
20018
|
safety?: components["schemas"]["ScribeSafetyConfig"];
|
|
19962
20019
|
/**
|
|
@@ -19965,6 +20022,10 @@ export interface components {
|
|
|
19965
20022
|
* @enum {string}
|
|
19966
20023
|
*/
|
|
19967
20024
|
soap_style?: "concise" | "detailed" | "structured";
|
|
20025
|
+
/** Specialty */
|
|
20026
|
+
specialty?: string | null;
|
|
20027
|
+
/** Tools Enabled */
|
|
20028
|
+
tools_enabled?: string[] | null;
|
|
19968
20029
|
/**
|
|
19969
20030
|
* Voice Auth Enabled
|
|
19970
20031
|
* @default false
|
|
@@ -32401,46 +32462,6 @@ export interface operations {
|
|
|
32401
32462
|
};
|
|
32402
32463
|
};
|
|
32403
32464
|
};
|
|
32404
|
-
"download-intake-upload": {
|
|
32405
|
-
parameters: {
|
|
32406
|
-
query?: never;
|
|
32407
|
-
header?: never;
|
|
32408
|
-
path: {
|
|
32409
|
-
link_id: string;
|
|
32410
|
-
upload_id: string;
|
|
32411
|
-
workspace_id: string;
|
|
32412
|
-
};
|
|
32413
|
-
cookie?: never;
|
|
32414
|
-
};
|
|
32415
|
-
requestBody?: never;
|
|
32416
|
-
responses: {
|
|
32417
|
-
/** @description File bytes with Content-Disposition: attachment */
|
|
32418
|
-
200: {
|
|
32419
|
-
headers: {
|
|
32420
|
-
[name: string]: unknown;
|
|
32421
|
-
};
|
|
32422
|
-
content: {
|
|
32423
|
-
"application/octet-stream": string;
|
|
32424
|
-
};
|
|
32425
|
-
};
|
|
32426
|
-
/** @description Link, upload, or file not found */
|
|
32427
|
-
404: {
|
|
32428
|
-
headers: {
|
|
32429
|
-
[name: string]: unknown;
|
|
32430
|
-
};
|
|
32431
|
-
content?: never;
|
|
32432
|
-
};
|
|
32433
|
-
/** @description Validation Error */
|
|
32434
|
-
422: {
|
|
32435
|
-
headers: {
|
|
32436
|
-
[name: string]: unknown;
|
|
32437
|
-
};
|
|
32438
|
-
content: {
|
|
32439
|
-
"application/json": components["schemas"]["HTTPValidationError"];
|
|
32440
|
-
};
|
|
32441
|
-
};
|
|
32442
|
-
};
|
|
32443
|
-
};
|
|
32444
32465
|
"list-integrations": {
|
|
32445
32466
|
parameters: {
|
|
32446
32467
|
query?: {
|
|
@@ -33473,6 +33494,43 @@ export interface operations {
|
|
|
33473
33494
|
};
|
|
33474
33495
|
};
|
|
33475
33496
|
};
|
|
33497
|
+
"emit-metering-event": {
|
|
33498
|
+
parameters: {
|
|
33499
|
+
query?: never;
|
|
33500
|
+
header?: never;
|
|
33501
|
+
path: {
|
|
33502
|
+
workspace_id: string;
|
|
33503
|
+
};
|
|
33504
|
+
cookie?: never;
|
|
33505
|
+
};
|
|
33506
|
+
requestBody: {
|
|
33507
|
+
content: {
|
|
33508
|
+
"application/json": components["schemas"]["MeteringEmitRequest"];
|
|
33509
|
+
};
|
|
33510
|
+
};
|
|
33511
|
+
responses: {
|
|
33512
|
+
/** @description Successful Response */
|
|
33513
|
+
202: {
|
|
33514
|
+
headers: {
|
|
33515
|
+
[name: string]: unknown;
|
|
33516
|
+
};
|
|
33517
|
+
content: {
|
|
33518
|
+
"application/json": {
|
|
33519
|
+
[key: string]: string;
|
|
33520
|
+
};
|
|
33521
|
+
};
|
|
33522
|
+
};
|
|
33523
|
+
/** @description Validation Error */
|
|
33524
|
+
422: {
|
|
33525
|
+
headers: {
|
|
33526
|
+
[name: string]: unknown;
|
|
33527
|
+
};
|
|
33528
|
+
content: {
|
|
33529
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
33530
|
+
};
|
|
33531
|
+
};
|
|
33532
|
+
};
|
|
33533
|
+
};
|
|
33476
33534
|
"list-metrics": {
|
|
33477
33535
|
parameters: {
|
|
33478
33536
|
query?: {
|