@healthcloudai/hc-sdk 3.2.0 → 3.4.0
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/dist/index.cjs +31 -0
- package/dist/index.d.cts +117 -1
- package/dist/index.d.ts +117 -1
- package/dist/index.js +31 -0
- package/docs/clients/AppointmentsClient.md +1 -0
- package/docs/clients/GraphClient.md +3 -0
- package/docs/docs-manifest.json +13 -3
- package/docs/examples/index.md +4 -0
- package/docs/index.md +4 -0
- package/docs/models/GetVectorDocumentChunksResponse.md +30 -0
- package/docs/models/ListVectorCollectionsResponse.md +19 -0
- package/docs/models/VectorCollection.md +24 -0
- package/docs/models/VectorSearchDocumentsRequest.md +25 -0
- package/docs/models/VectorSearchHit.md +30 -0
- package/docs/models/VectorSearchResponse.md +22 -0
- package/docs/models/index.md +6 -0
- package/docs/operations/appointments.getTelehealthLink.md +118 -0
- package/docs/operations/graph.getVectorDocumentChunks.md +189 -0
- package/docs/operations/graph.listVectorCollections.md +138 -0
- package/docs/operations/graph.vectorSearchDocuments.md +207 -0
- package/package.json +1 -1
package/dist/index.js
CHANGED
|
@@ -291,6 +291,19 @@ var AppointmentsClient = class extends BaseServiceClient {
|
|
|
291
291
|
body: request
|
|
292
292
|
});
|
|
293
293
|
}
|
|
294
|
+
/**
|
|
295
|
+
* Get the telehealth join link for an Athena-booked telehealth appointment.
|
|
296
|
+
* GET /appointments/{appointment_id}/telehealth-link
|
|
297
|
+
*
|
|
298
|
+
* Reads the link back from the Athena appointment's notes (written at
|
|
299
|
+
* booking time) — `book`'s own response also carries it once, right after
|
|
300
|
+
* booking, but `listPatientAppointments`/`cancel`/`reschedule` do not.
|
|
301
|
+
*/
|
|
302
|
+
getTelehealthLink(appointmentId) {
|
|
303
|
+
return this.send("GET", "/appointments/{appointment_id}/telehealth-link", {
|
|
304
|
+
pathParams: { appointment_id: appointmentId }
|
|
305
|
+
});
|
|
306
|
+
}
|
|
294
307
|
// ─── Patient Appointments ────────────────────────────────────────────
|
|
295
308
|
/**
|
|
296
309
|
* List all appointments for a patient.
|
|
@@ -2923,6 +2936,24 @@ var GraphClient = class extends BaseServiceClient {
|
|
|
2923
2936
|
query
|
|
2924
2937
|
});
|
|
2925
2938
|
}
|
|
2939
|
+
// ─── Vector search (Milvus) ──────────────────────────────────────────
|
|
2940
|
+
//
|
|
2941
|
+
// The semantic tier, alongside the keyword (Algolia) and graph (Neo4j)
|
|
2942
|
+
// reads above. Searching the payer-policy collection requires
|
|
2943
|
+
// `payer_key`: that corpus is partitioned by payer, so one search only
|
|
2944
|
+
// ever returns one payer's policies.
|
|
2945
|
+
vectorSearchDocuments(request) {
|
|
2946
|
+
return this.send("POST", "/graph/vector/search", { body: request });
|
|
2947
|
+
}
|
|
2948
|
+
listVectorCollections() {
|
|
2949
|
+
return this.send("GET", "/graph/vector/collections");
|
|
2950
|
+
}
|
|
2951
|
+
getVectorDocumentChunks(docId, query) {
|
|
2952
|
+
return this.send("GET", "/graph/vector/documents/{doc_id}", {
|
|
2953
|
+
pathParams: { doc_id: docId },
|
|
2954
|
+
query
|
|
2955
|
+
});
|
|
2956
|
+
}
|
|
2926
2957
|
};
|
|
2927
2958
|
|
|
2928
2959
|
// src/clients/connectors/ConnectorFactory.ts
|
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
- [`cancel`](../operations/appointments.cancel.md) — Cancel an appointment
|
|
5
5
|
- [`connect`](../operations/appointments.connect.md) — Health check
|
|
6
6
|
- [`createSlot`](../operations/appointments.createSlot.md) — Create a new slot
|
|
7
|
+
- [`getTelehealthLink`](../operations/appointments.getTelehealthLink.md) — Get the telehealth join link for an Athena-booked appointment
|
|
7
8
|
- [`listPatientAppointments`](../operations/appointments.listPatientAppointments.md) — List patient appointments
|
|
8
9
|
- [`listSlots`](../operations/appointments.listSlots.md) — List available slots
|
|
9
10
|
- [`reschedule`](../operations/appointments.reschedule.md) — Reschedule an appointment
|
|
@@ -12,9 +12,11 @@
|
|
|
12
12
|
- [`listMedicalConceptRelationships`](../operations/graph.getMedicalConceptRelationships.md) — Get a concept's 1-hop relationships
|
|
13
13
|
- [`listMedicalConceptVocabularies`](../operations/graph.getMedicalConceptVocabularies.md) — Get per-vocabulary concept counts
|
|
14
14
|
- [`getPolicyDocument`](../operations/graph.getPolicyDocument.md) — Get a policy document
|
|
15
|
+
- [`getVectorDocumentChunks`](../operations/graph.getVectorDocumentChunks.md) — Get one document's chunks
|
|
15
16
|
- [`listDiagnosticTests`](../operations/graph.listDiagnosticTests.md) — List/filter diagnostic tests
|
|
16
17
|
- [`listMedicalConcepts`](../operations/graph.listMedicalConceptsGet.md) — List/filter medical concepts
|
|
17
18
|
- [`listPolicyDocuments`](../operations/graph.listPolicyDocuments.md) — List/filter policy documents
|
|
19
|
+
- [`listVectorCollections`](../operations/graph.listVectorCollections.md) — List searchable vector collections
|
|
18
20
|
- [`searchDiagnosticTests`](../operations/graph.searchDiagnosticTests.md) — Search diagnostic tests
|
|
19
21
|
- [`searchDocumentSummaries`](../operations/graph.searchDocumentSummaries.md) — Search document summaries
|
|
20
22
|
- [`searchDocumentSummariesCypher`](../operations/graph.searchDocumentSummariesCypher.md) — Search document summaries with a raw Cypher query
|
|
@@ -26,3 +28,4 @@
|
|
|
26
28
|
- [`searchPolicyDocuments`](../operations/graph.searchPolicyDocuments.md) — Full-text search policy documents
|
|
27
29
|
- [`searchProviders`](../operations/graph.searchProviders.md) — Search providers
|
|
28
30
|
- [`searchProvidersCypher`](../operations/graph.searchProvidersCypher.md) — Search providers with a raw Cypher query
|
|
31
|
+
- [`vectorSearchDocuments`](../operations/graph.vectorSearchDocuments.md) — Semantic search over document chunks
|
package/docs/docs-manifest.json
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
{
|
|
2
|
-
"docsDataContentDigest": "sha256:
|
|
2
|
+
"docsDataContentDigest": "sha256:65253ce7594dae1592abe0d6882026acc16d9d091cb456e74174f0cd5cfdd2d9",
|
|
3
3
|
"generatedFiles": [
|
|
4
4
|
"authentication.md",
|
|
5
5
|
"clients/AmsClient.md",
|
|
@@ -607,6 +607,7 @@
|
|
|
607
607
|
"models/GetPreferredPharmacyResponse.md",
|
|
608
608
|
"models/GetScanUploadUrlRequest.md",
|
|
609
609
|
"models/GetTestResultResponse.md",
|
|
610
|
+
"models/GetVectorDocumentChunksResponse.md",
|
|
610
611
|
"models/GetVitalsResponse.md",
|
|
611
612
|
"models/GlucoseReading.md",
|
|
612
613
|
"models/GoogleAICandidate.md",
|
|
@@ -1218,6 +1219,7 @@
|
|
|
1218
1219
|
"models/ListQuestionnaireResponsesResponse.md",
|
|
1219
1220
|
"models/ListSlotsResponse.md",
|
|
1220
1221
|
"models/ListSocialHistoryResponse.md",
|
|
1222
|
+
"models/ListVectorCollectionsResponse.md",
|
|
1221
1223
|
"models/ListVitalsResponse.md",
|
|
1222
1224
|
"models/LocationStatus.md",
|
|
1223
1225
|
"models/MaritalStatus.md",
|
|
@@ -1778,6 +1780,10 @@
|
|
|
1778
1780
|
"models/UpsertInviteRequest.md",
|
|
1779
1781
|
"models/UpsertMessageRequest.md",
|
|
1780
1782
|
"models/UpsertPresenceRequest.md",
|
|
1783
|
+
"models/VectorCollection.md",
|
|
1784
|
+
"models/VectorSearchDocumentsRequest.md",
|
|
1785
|
+
"models/VectorSearchHit.md",
|
|
1786
|
+
"models/VectorSearchResponse.md",
|
|
1781
1787
|
"models/VerifyOtpResponse.md",
|
|
1782
1788
|
"models/VisionFaceCompareRequest.md",
|
|
1783
1789
|
"models/VisionFaceCompareResponse.md",
|
|
@@ -2041,6 +2047,7 @@
|
|
|
2041
2047
|
"operations/appointments.cancel.md",
|
|
2042
2048
|
"operations/appointments.connect.md",
|
|
2043
2049
|
"operations/appointments.createSlot.md",
|
|
2050
|
+
"operations/appointments.getTelehealthLink.md",
|
|
2044
2051
|
"operations/appointments.listPatientAppointments.md",
|
|
2045
2052
|
"operations/appointments.listSlots.md",
|
|
2046
2053
|
"operations/appointments.reschedule.md",
|
|
@@ -2902,9 +2909,11 @@
|
|
|
2902
2909
|
"operations/graph.getMedicalConceptRelationships.md",
|
|
2903
2910
|
"operations/graph.getMedicalConceptVocabularies.md",
|
|
2904
2911
|
"operations/graph.getPolicyDocument.md",
|
|
2912
|
+
"operations/graph.getVectorDocumentChunks.md",
|
|
2905
2913
|
"operations/graph.listDiagnosticTests.md",
|
|
2906
2914
|
"operations/graph.listMedicalConceptsGet.md",
|
|
2907
2915
|
"operations/graph.listPolicyDocuments.md",
|
|
2916
|
+
"operations/graph.listVectorCollections.md",
|
|
2908
2917
|
"operations/graph.searchDiagnosticTests.md",
|
|
2909
2918
|
"operations/graph.searchDocumentSummaries.md",
|
|
2910
2919
|
"operations/graph.searchDocumentSummariesCypher.md",
|
|
@@ -2916,6 +2925,7 @@
|
|
|
2916
2925
|
"operations/graph.searchPolicyDocuments.md",
|
|
2917
2926
|
"operations/graph.searchProviders.md",
|
|
2918
2927
|
"operations/graph.searchProvidersCypher.md",
|
|
2928
|
+
"operations/graph.vectorSearchDocuments.md",
|
|
2919
2929
|
"operations/list_public_and_orchestrator_agent_ids_api_ams_application_agents__tenant_id__get.md",
|
|
2920
2930
|
"operations/mcp.connect.md",
|
|
2921
2931
|
"operations/mcp.mcpFieldagent.md",
|
|
@@ -3048,7 +3058,7 @@
|
|
|
3048
3058
|
"operations/vitals.recordVitals.md"
|
|
3049
3059
|
],
|
|
3050
3060
|
"language": "nodejs",
|
|
3051
|
-
"modelCount":
|
|
3052
|
-
"operationCount":
|
|
3061
|
+
"modelCount": 1988,
|
|
3062
|
+
"operationCount": 1013,
|
|
3053
3063
|
"schemaVersion": 1
|
|
3054
3064
|
}
|
package/docs/examples/index.md
CHANGED
|
@@ -6,6 +6,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
6
6
|
- [Cancel an appointment](../operations/appointments.cancel.md)
|
|
7
7
|
- [Health check](../operations/appointments.connect.md)
|
|
8
8
|
- [Create a new slot](../operations/appointments.createSlot.md)
|
|
9
|
+
- [Get the telehealth join link for an Athena-booked appointment](../operations/appointments.getTelehealthLink.md)
|
|
9
10
|
- [List patient appointments](../operations/appointments.listPatientAppointments.md)
|
|
10
11
|
- [List available slots](../operations/appointments.listSlots.md)
|
|
11
12
|
- [Reschedule an appointment](../operations/appointments.reschedule.md)
|
|
@@ -867,9 +868,11 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
867
868
|
- [Get a concept's 1-hop relationships](../operations/graph.getMedicalConceptRelationships.md)
|
|
868
869
|
- [Get per-vocabulary concept counts](../operations/graph.getMedicalConceptVocabularies.md)
|
|
869
870
|
- [Get a policy document](../operations/graph.getPolicyDocument.md)
|
|
871
|
+
- [Get one document's chunks](../operations/graph.getVectorDocumentChunks.md)
|
|
870
872
|
- [List/filter diagnostic tests](../operations/graph.listDiagnosticTests.md)
|
|
871
873
|
- [List/filter medical concepts](../operations/graph.listMedicalConceptsGet.md)
|
|
872
874
|
- [List/filter policy documents](../operations/graph.listPolicyDocuments.md)
|
|
875
|
+
- [List searchable vector collections](../operations/graph.listVectorCollections.md)
|
|
873
876
|
- [Search diagnostic tests](../operations/graph.searchDiagnosticTests.md)
|
|
874
877
|
- [Search document summaries](../operations/graph.searchDocumentSummaries.md)
|
|
875
878
|
- [Search document summaries with a raw Cypher query](../operations/graph.searchDocumentSummariesCypher.md)
|
|
@@ -881,6 +884,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
881
884
|
- [Full-text search policy documents](../operations/graph.searchPolicyDocuments.md)
|
|
882
885
|
- [Search providers](../operations/graph.searchProviders.md)
|
|
883
886
|
- [Search providers with a raw Cypher query](../operations/graph.searchProvidersCypher.md)
|
|
887
|
+
- [Semantic search over document chunks](../operations/graph.vectorSearchDocuments.md)
|
|
884
888
|
- [List public and orchestrator agent IDs](../operations/list_public_and_orchestrator_agent_ids_api_ams_application_agents__tenant_id__get.md)
|
|
885
889
|
- [GET /connect](../operations/mcp.connect.md)
|
|
886
890
|
- [POST /fieldagent](../operations/mcp.mcpFieldagent.md)
|
package/docs/index.md
CHANGED
|
@@ -14,6 +14,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
14
14
|
- [Cancel an appointment](operations/appointments.cancel.md) (`appointments.cancel`)
|
|
15
15
|
- [Health check](operations/appointments.connect.md) (`appointments.connect`)
|
|
16
16
|
- [Create a new slot](operations/appointments.createSlot.md) (`appointments.createSlot`)
|
|
17
|
+
- [Get the telehealth join link for an Athena-booked appointment](operations/appointments.getTelehealthLink.md) (`appointments.getTelehealthLink`)
|
|
17
18
|
- [List patient appointments](operations/appointments.listPatientAppointments.md) (`appointments.listPatientAppointments`)
|
|
18
19
|
- [List available slots](operations/appointments.listSlots.md) (`appointments.listSlots`)
|
|
19
20
|
- [Reschedule an appointment](operations/appointments.reschedule.md) (`appointments.reschedule`)
|
|
@@ -875,9 +876,11 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
875
876
|
- [Get a concept's 1-hop relationships](operations/graph.getMedicalConceptRelationships.md) (`graph.getMedicalConceptRelationships`)
|
|
876
877
|
- [Get per-vocabulary concept counts](operations/graph.getMedicalConceptVocabularies.md) (`graph.getMedicalConceptVocabularies`)
|
|
877
878
|
- [Get a policy document](operations/graph.getPolicyDocument.md) (`graph.getPolicyDocument`)
|
|
879
|
+
- [Get one document's chunks](operations/graph.getVectorDocumentChunks.md) (`graph.getVectorDocumentChunks`)
|
|
878
880
|
- [List/filter diagnostic tests](operations/graph.listDiagnosticTests.md) (`graph.listDiagnosticTests`)
|
|
879
881
|
- [List/filter medical concepts](operations/graph.listMedicalConceptsGet.md) (`graph.listMedicalConceptsGet`)
|
|
880
882
|
- [List/filter policy documents](operations/graph.listPolicyDocuments.md) (`graph.listPolicyDocuments`)
|
|
883
|
+
- [List searchable vector collections](operations/graph.listVectorCollections.md) (`graph.listVectorCollections`)
|
|
881
884
|
- [Search diagnostic tests](operations/graph.searchDiagnosticTests.md) (`graph.searchDiagnosticTests`)
|
|
882
885
|
- [Search document summaries](operations/graph.searchDocumentSummaries.md) (`graph.searchDocumentSummaries`)
|
|
883
886
|
- [Search document summaries with a raw Cypher query](operations/graph.searchDocumentSummariesCypher.md) (`graph.searchDocumentSummariesCypher`)
|
|
@@ -889,6 +892,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
889
892
|
- [Full-text search policy documents](operations/graph.searchPolicyDocuments.md) (`graph.searchPolicyDocuments`)
|
|
890
893
|
- [Search providers](operations/graph.searchProviders.md) (`graph.searchProviders`)
|
|
891
894
|
- [Search providers with a raw Cypher query](operations/graph.searchProvidersCypher.md) (`graph.searchProvidersCypher`)
|
|
895
|
+
- [Semantic search over document chunks](operations/graph.vectorSearchDocuments.md) (`graph.vectorSearchDocuments`)
|
|
892
896
|
- [List public and orchestrator agent IDs](operations/list_public_and_orchestrator_agent_ids_api_ams_application_agents__tenant_id__get.md) (`list_public_and_orchestrator_agent_ids_api_ams_application_agents__tenant_id__get`)
|
|
893
897
|
- [GET /connect](operations/mcp.connect.md) (`mcp.connect`)
|
|
894
898
|
- [POST /fieldagent](operations/mcp.mcpFieldagent.md) (`mcp.mcpFieldagent`)
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# GetVectorDocumentChunksResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `GetVectorDocumentChunksResponse`
|
|
4
|
+
|
|
5
|
+
`GET /graph/vector/documents/{doc_id}` — one document's chunks, in order.
|
|
6
|
+
|
|
7
|
+
Concatenating `chunks` in `chunk_index` order reconstructs the embedded body.
|
|
8
|
+
|
|
9
|
+
Type: `object`
|
|
10
|
+
|
|
11
|
+
## Fields
|
|
12
|
+
|
|
13
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
14
|
+
|---|---|---:|---|---|---|---:|---|
|
|
15
|
+
| `chunk_count` | `integer` | Yes | | | | No | Number of chunks in this response. |
|
|
16
|
+
| `chunks` | array of [`VectorSearchHit`](./VectorSearchHit.md) | Yes | | | | No | The document's chunks, ordered by chunk_index. |
|
|
17
|
+
| `collection` | `string` | Yes | | | | No | Collection the chunks were read from. |
|
|
18
|
+
| `collection_group` | `string|null` | No | | | | Yes | Corpus label the document belongs to. |
|
|
19
|
+
| `doc_id` | `string` | Yes | | | | No | The document identifier that was requested. |
|
|
20
|
+
| `language` | `string|null` | No | | | | Yes | Document language. |
|
|
21
|
+
| `metadata` | `object` | No | | | | No | The document's normalized metadata. |
|
|
22
|
+
| `payer_key` | `string|null` | No | | | | Yes | Payer the document belongs to, for policy documents. |
|
|
23
|
+
| `source` | `string|null` | No | | | | Yes | Pipeline that produced the document. |
|
|
24
|
+
| `tags` | `array` | No | | | | No | Health tags carried by the document. |
|
|
25
|
+
| `title` | `string|null` | No | | | | Yes | Document title, taken from its first chunk. |
|
|
26
|
+
| `url` | `string|null` | No | | | | Yes | Source URL of the document, when known. |
|
|
27
|
+
|
|
28
|
+
## Example
|
|
29
|
+
|
|
30
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# ListVectorCollectionsResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `ListVectorCollectionsResponse`
|
|
4
|
+
|
|
5
|
+
`GET /graph/vector/collections` — what can be searched, and with what.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `collections` | array of [`VectorCollection`](./VectorCollection.md) | Yes | | | | No | Configured collections, documents corpus first. |
|
|
14
|
+
| `embedding_model` | `string` | Yes | | | | No | Model this deployment embeds queries with. |
|
|
15
|
+
| `total` | `integer` | Yes | | | | No | Number of collections in this response. |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# VectorCollection
|
|
2
|
+
|
|
3
|
+
Model ID: `VectorCollection`
|
|
4
|
+
|
|
5
|
+
One searchable collection and the facts that decide whether it is usable.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `available` | `boolean` | Yes | | | | No | Whether the collection could be described and counted. |
|
|
14
|
+
| `chunk_count` | `integer` | Yes | | | | No | Number of chunk rows currently loaded. |
|
|
15
|
+
| `collection` | `string` | Yes | | | | No | Collection name. |
|
|
16
|
+
| `detail` | `string|null` | No | | | | Yes | Why the collection is unavailable, when it is. |
|
|
17
|
+
| `dimension` | `integer|null` | No | | | | Yes | Vector width. Must equal the query embedding's width or search cannot work. |
|
|
18
|
+
| `metric_type` | `string|null` | No | | | | Yes | Similarity metric the vector index was built with, e.g. COSINE. |
|
|
19
|
+
| `partitioned_by_payer` | `boolean` | Yes | | | | No | When true, the collection is grouped by payer and every search of it must supply payer_key. |
|
|
20
|
+
| `role` | `string` | Yes | | | | No | Which corpus this collection holds: documents \| policies. |
|
|
21
|
+
|
|
22
|
+
## Example
|
|
23
|
+
|
|
24
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# VectorSearchRequest
|
|
2
|
+
|
|
3
|
+
Model ID: `VectorSearchDocumentsRequest`
|
|
4
|
+
|
|
5
|
+
Semantic search over one collection's document chunks.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `collection` | `string|null` | No | | | `null` | Yes | Collection to search; defaults to the documents collection. Must be one reported by GET /graph/vector/collections. |
|
|
14
|
+
| `collection_group` | `string|null` | No | | | `null` | Yes | Corpus label within the collection, e.g. MedlinePlus or MedicalPolicy. |
|
|
15
|
+
| `language` | `string|null` | No | | | `null` | Yes | Document language, e.g. English. |
|
|
16
|
+
| `network_id` | `string|null` | No | | | `null` | Yes | Stedi payer id. A narrower scope than payer_key and only resolved for some payers, so prefer payer_key. |
|
|
17
|
+
| `payer_key` | `string|null` | No | | | `null` | Yes | Payer registry slug, e.g. cigna \| aetna \| bcbsma. REQUIRED when searching the payer-policy collection, which is partitioned by payer so that one search only ever returns one payer's policies. Ignored for the consumer-health collection. |
|
|
18
|
+
| `q` | `string` | Yes | | | | No | Natural-language query; embedded and matched by meaning, not keyword. |
|
|
19
|
+
| `source` | `string|null` | No | | | `null` | Yes | Pipeline that produced the chunk: medlineplus \| medical_policy \| guideline. |
|
|
20
|
+
| `tags` | `array` | No | | | | No | Health tags; a chunk matching ANY of them is returned, so more tags broaden the result set. |
|
|
21
|
+
| `top_k` | `integer` | No | | | `10` | No | Maximum hits returned. |
|
|
22
|
+
|
|
23
|
+
## Example
|
|
24
|
+
|
|
25
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# VectorSearchHit
|
|
2
|
+
|
|
3
|
+
Model ID: `VectorSearchHit`
|
|
4
|
+
|
|
5
|
+
One ranked chunk, carrying enough metadata to render without a second fetch.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `chunk_index` | `integer|null` | No | | | | Yes | 0-based position of this chunk within its document. |
|
|
14
|
+
| `collection_group` | `string|null` | No | | | | Yes | Corpus label the chunk belongs to. |
|
|
15
|
+
| `doc_id` | `string|null` | No | | | | Yes | Identifier of the document this chunk came from. |
|
|
16
|
+
| `id` | `string` | Yes | | | | No | Chunk primary key, '<doc_id>#<chunk_index>'. |
|
|
17
|
+
| `language` | `string|null` | No | | | | Yes | Document language. |
|
|
18
|
+
| `metadata` | `object` | No | | | | No | Per-source extras (topic ids, MeSH headings, payer, policy number, ...). |
|
|
19
|
+
| `network_id` | `string|null` | No | | | | Yes | Stedi payer id, for policy chunks; empty when it could not be resolved. |
|
|
20
|
+
| `payer_key` | `string|null` | No | | | | Yes | Payer registry slug the chunk belongs to; empty for consumer-health chunks. |
|
|
21
|
+
| `score` | `number|null` | No | | | | Yes | Cosine similarity to the query; higher is closer. |
|
|
22
|
+
| `source` | `string|null` | No | | | | Yes | Pipeline that produced the chunk. |
|
|
23
|
+
| `tags` | `array` | No | | | | No | Health tags derived from the document's own metadata. |
|
|
24
|
+
| `text` | `string|null` | No | | | | Yes | The chunk body that was embedded. |
|
|
25
|
+
| `title` | `string|null` | No | | | | Yes | Document title. |
|
|
26
|
+
| `url` | `string|null` | No | | | | Yes | Source URL of the document, when known. |
|
|
27
|
+
|
|
28
|
+
## Example
|
|
29
|
+
|
|
30
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# VectorSearchResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `VectorSearchResponse`
|
|
4
|
+
|
|
5
|
+
Ranked semantic-search results, with the resolved query context.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `collection` | `string` | Yes | | | | No | Collection that was searched. |
|
|
14
|
+
| `count` | `integer` | Yes | | | | No | Number of hits in this response. |
|
|
15
|
+
| `embedding_model` | `string` | Yes | | | | No | Model used to embed the query; must match the model the collection was loaded with. |
|
|
16
|
+
| `filter` | `string` | Yes | | | | No | Milvus filter expression the scoping parameters produced; empty when unscoped. |
|
|
17
|
+
| `hits` | array of [`VectorSearchHit`](./VectorSearchHit.md) | Yes | | | | No | Ranked chunks, closest first. |
|
|
18
|
+
| `query` | `string` | Yes | | | | No | The query that was embedded. |
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
None declared in canonical OpenAPI.
|
package/docs/models/index.md
CHANGED
|
@@ -591,6 +591,7 @@
|
|
|
591
591
|
- [GetPreferredPharmacyResponse](GetPreferredPharmacyResponse.md)
|
|
592
592
|
- [ScanUploadUrlRequest](GetScanUploadUrlRequest.md)
|
|
593
593
|
- [GetTestResultResponse](GetTestResultResponse.md)
|
|
594
|
+
- [GetVectorDocumentChunksResponse](GetVectorDocumentChunksResponse.md)
|
|
594
595
|
- [GetVitalsResponse](GetVitalsResponse.md)
|
|
595
596
|
- [GlucoseReading](GlucoseReading.md)
|
|
596
597
|
- [GoogleAICandidate](GoogleAICandidate.md)
|
|
@@ -1207,6 +1208,7 @@
|
|
|
1207
1208
|
- [ListQuestionnaireResponsesResponse](ListQuestionnaireResponsesResponse.md)
|
|
1208
1209
|
- [ListSlotsResponse](ListSlotsResponse.md)
|
|
1209
1210
|
- [ListSocialHistoryResponse](ListSocialHistoryResponse.md)
|
|
1211
|
+
- [ListVectorCollectionsResponse](ListVectorCollectionsResponse.md)
|
|
1210
1212
|
- [ListVitalsResponse](ListVitalsResponse.md)
|
|
1211
1213
|
- [LocationStatus](LocationStatus.md)
|
|
1212
1214
|
- [MaritalStatus](MaritalStatus.md)
|
|
@@ -1847,6 +1849,10 @@
|
|
|
1847
1849
|
- [UpsertInviteRequest](UpsertInviteRequest.md)
|
|
1848
1850
|
- [UpsertMessageRequest](UpsertMessageRequest.md)
|
|
1849
1851
|
- [UpsertPresenceRequest](UpsertPresenceRequest.md)
|
|
1852
|
+
- [VectorCollection](VectorCollection.md)
|
|
1853
|
+
- [VectorSearchRequest](VectorSearchDocumentsRequest.md)
|
|
1854
|
+
- [VectorSearchHit](VectorSearchHit.md)
|
|
1855
|
+
- [VectorSearchResponse](VectorSearchResponse.md)
|
|
1850
1856
|
- [VerifyOtpResponse](VerifyOtpResponse.md)
|
|
1851
1857
|
- [VisionFaceCompareRequest](VisionFaceCompareRequest.md)
|
|
1852
1858
|
- [VisionFaceCompareResponse](VisionFaceCompareResponse.md)
|
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
# Get the telehealth join link for an Athena-booked appointment
|
|
2
|
+
|
|
3
|
+
Operation ID: `appointments.getTelehealthLink`
|
|
4
|
+
|
|
5
|
+
Get the telehealth join link for an Athena-booked appointment
|
|
6
|
+
|
|
7
|
+
## Public method
|
|
8
|
+
|
|
9
|
+
`getTelehealthLink`
|
|
10
|
+
|
|
11
|
+
Signature: `appointments.getTelehealthLink(appointmentId)`
|
|
12
|
+
|
|
13
|
+
Return type: `Promise<GetTelehealthLinkResponse>`
|
|
14
|
+
|
|
15
|
+
## Authentication
|
|
16
|
+
|
|
17
|
+
Classification: **AUTHENTICATED**
|
|
18
|
+
|
|
19
|
+
Schemes: `bearerAuth`
|
|
20
|
+
|
|
21
|
+
## Prerequisites
|
|
22
|
+
|
|
23
|
+
None documented.
|
|
24
|
+
|
|
25
|
+
## HTTP
|
|
26
|
+
|
|
27
|
+
`GET /appointments/{appointment_id}/telehealth-link`
|
|
28
|
+
|
|
29
|
+
## Path parameters
|
|
30
|
+
|
|
31
|
+
| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
32
|
+
|---|---|---:|---|---|---|---:|---|
|
|
33
|
+
| `appointment_id` | `string` | Yes | | | | No | |
|
|
34
|
+
|
|
35
|
+
## Query parameters
|
|
36
|
+
|
|
37
|
+
None.
|
|
38
|
+
|
|
39
|
+
## Body parameters
|
|
40
|
+
|
|
41
|
+
None.
|
|
42
|
+
|
|
43
|
+
Request model: None.
|
|
44
|
+
|
|
45
|
+
## Request example
|
|
46
|
+
|
|
47
|
+
None declared in canonical OpenAPI.
|
|
48
|
+
|
|
49
|
+
## Success responses
|
|
50
|
+
|
|
51
|
+
| Status | Shape | Content type | Description |
|
|
52
|
+
|---|---|---|---|
|
|
53
|
+
| `200` | `object` | application/json | The telehealth join link written to this appointment's Athena notes at booking time |
|
|
54
|
+
|
|
55
|
+
## Success response examples
|
|
56
|
+
|
|
57
|
+
### 200
|
|
58
|
+
|
|
59
|
+
```json
|
|
60
|
+
{}
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
## Common errors
|
|
64
|
+
|
|
65
|
+
| Status | Shape | Content type | Description |
|
|
66
|
+
|---|---|---|---|
|
|
67
|
+
| `401` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
|
|
68
|
+
| `500` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | Internal server error |
|
|
69
|
+
|
|
70
|
+
## Error examples
|
|
71
|
+
|
|
72
|
+
### 401 — Missing or invalid access token
|
|
73
|
+
|
|
74
|
+
```json
|
|
75
|
+
{
|
|
76
|
+
"error": "Authorization required"
|
|
77
|
+
}
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
### 500 — Unexpected service failure (sanitized example)
|
|
81
|
+
|
|
82
|
+
```json
|
|
83
|
+
{
|
|
84
|
+
"error": "Internal server error"
|
|
85
|
+
}
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
## NodeJS / TypeScript implementation
|
|
89
|
+
|
|
90
|
+
```ts
|
|
91
|
+
import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
```ts
|
|
95
|
+
const appointmentId = "<APPOINTMENT_ID>";
|
|
96
|
+
|
|
97
|
+
const result = await appointments.getTelehealthLink(appointmentId);
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
## cURL
|
|
101
|
+
|
|
102
|
+
```bash
|
|
103
|
+
curl -X GET \
|
|
104
|
+
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
105
|
+
'https://dev-api-appointments.health.cloud/appointments/%3CAPPOINTMENT_ID%3E/telehealth-link'
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
## Notes
|
|
109
|
+
|
|
110
|
+
None.
|
|
111
|
+
|
|
112
|
+
## Prepared Test Console scenario
|
|
113
|
+
|
|
114
|
+
No canonical scenario is currently associated.
|
|
115
|
+
|
|
116
|
+
## Real response
|
|
117
|
+
|
|
118
|
+
No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
|