@healthcloudai/hc-sdk 3.3.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.
@@ -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
@@ -1,5 +1,5 @@
1
1
  {
2
- "docsDataContentDigest": "sha256:6b0bf86aa73f54469a6673774a73c572665950f8c7c9dfaa0df2910ab85e5b8f",
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",
@@ -2903,9 +2909,11 @@
2903
2909
  "operations/graph.getMedicalConceptRelationships.md",
2904
2910
  "operations/graph.getMedicalConceptVocabularies.md",
2905
2911
  "operations/graph.getPolicyDocument.md",
2912
+ "operations/graph.getVectorDocumentChunks.md",
2906
2913
  "operations/graph.listDiagnosticTests.md",
2907
2914
  "operations/graph.listMedicalConceptsGet.md",
2908
2915
  "operations/graph.listPolicyDocuments.md",
2916
+ "operations/graph.listVectorCollections.md",
2909
2917
  "operations/graph.searchDiagnosticTests.md",
2910
2918
  "operations/graph.searchDocumentSummaries.md",
2911
2919
  "operations/graph.searchDocumentSummariesCypher.md",
@@ -2917,6 +2925,7 @@
2917
2925
  "operations/graph.searchPolicyDocuments.md",
2918
2926
  "operations/graph.searchProviders.md",
2919
2927
  "operations/graph.searchProvidersCypher.md",
2928
+ "operations/graph.vectorSearchDocuments.md",
2920
2929
  "operations/list_public_and_orchestrator_agent_ids_api_ams_application_agents__tenant_id__get.md",
2921
2930
  "operations/mcp.connect.md",
2922
2931
  "operations/mcp.mcpFieldagent.md",
@@ -3049,7 +3058,7 @@
3049
3058
  "operations/vitals.recordVitals.md"
3050
3059
  ],
3051
3060
  "language": "nodejs",
3052
- "modelCount": 1982,
3053
- "operationCount": 1010,
3061
+ "modelCount": 1988,
3062
+ "operationCount": 1013,
3054
3063
  "schemaVersion": 1
3055
3064
  }
@@ -868,9 +868,11 @@ Generated call examples use exact public surface signatures. Workflow examples r
868
868
  - [Get a concept's 1-hop relationships](../operations/graph.getMedicalConceptRelationships.md)
869
869
  - [Get per-vocabulary concept counts](../operations/graph.getMedicalConceptVocabularies.md)
870
870
  - [Get a policy document](../operations/graph.getPolicyDocument.md)
871
+ - [Get one document's chunks](../operations/graph.getVectorDocumentChunks.md)
871
872
  - [List/filter diagnostic tests](../operations/graph.listDiagnosticTests.md)
872
873
  - [List/filter medical concepts](../operations/graph.listMedicalConceptsGet.md)
873
874
  - [List/filter policy documents](../operations/graph.listPolicyDocuments.md)
875
+ - [List searchable vector collections](../operations/graph.listVectorCollections.md)
874
876
  - [Search diagnostic tests](../operations/graph.searchDiagnosticTests.md)
875
877
  - [Search document summaries](../operations/graph.searchDocumentSummaries.md)
876
878
  - [Search document summaries with a raw Cypher query](../operations/graph.searchDocumentSummariesCypher.md)
@@ -882,6 +884,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
882
884
  - [Full-text search policy documents](../operations/graph.searchPolicyDocuments.md)
883
885
  - [Search providers](../operations/graph.searchProviders.md)
884
886
  - [Search providers with a raw Cypher query](../operations/graph.searchProvidersCypher.md)
887
+ - [Semantic search over document chunks](../operations/graph.vectorSearchDocuments.md)
885
888
  - [List public and orchestrator agent IDs](../operations/list_public_and_orchestrator_agent_ids_api_ams_application_agents__tenant_id__get.md)
886
889
  - [GET /connect](../operations/mcp.connect.md)
887
890
  - [POST /fieldagent](../operations/mcp.mcpFieldagent.md)
package/docs/index.md CHANGED
@@ -876,9 +876,11 @@ This directory is generated from the shared structured docs data. Do not edit ge
876
876
  - [Get a concept's 1-hop relationships](operations/graph.getMedicalConceptRelationships.md) (`graph.getMedicalConceptRelationships`)
877
877
  - [Get per-vocabulary concept counts](operations/graph.getMedicalConceptVocabularies.md) (`graph.getMedicalConceptVocabularies`)
878
878
  - [Get a policy document](operations/graph.getPolicyDocument.md) (`graph.getPolicyDocument`)
879
+ - [Get one document's chunks](operations/graph.getVectorDocumentChunks.md) (`graph.getVectorDocumentChunks`)
879
880
  - [List/filter diagnostic tests](operations/graph.listDiagnosticTests.md) (`graph.listDiagnosticTests`)
880
881
  - [List/filter medical concepts](operations/graph.listMedicalConceptsGet.md) (`graph.listMedicalConceptsGet`)
881
882
  - [List/filter policy documents](operations/graph.listPolicyDocuments.md) (`graph.listPolicyDocuments`)
883
+ - [List searchable vector collections](operations/graph.listVectorCollections.md) (`graph.listVectorCollections`)
882
884
  - [Search diagnostic tests](operations/graph.searchDiagnosticTests.md) (`graph.searchDiagnosticTests`)
883
885
  - [Search document summaries](operations/graph.searchDocumentSummaries.md) (`graph.searchDocumentSummaries`)
884
886
  - [Search document summaries with a raw Cypher query](operations/graph.searchDocumentSummariesCypher.md) (`graph.searchDocumentSummariesCypher`)
@@ -890,6 +892,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
890
892
  - [Full-text search policy documents](operations/graph.searchPolicyDocuments.md) (`graph.searchPolicyDocuments`)
891
893
  - [Search providers](operations/graph.searchProviders.md) (`graph.searchProviders`)
892
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`)
893
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`)
894
897
  - [GET /connect](operations/mcp.connect.md) (`mcp.connect`)
895
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.
@@ -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,189 @@
1
+ # Get one document's chunks
2
+
3
+ Operation ID: `graph.getVectorDocumentChunks`
4
+
5
+ Return every stored chunk of one document, ordered by chunk_index. Concatenating them reconstructs the text that was embedded. The doc_id is the identifier carried on each search hit. Reading a document from the payer-policy collection requires payer_key, the same rule the search follows: knowing a document id is not on its own enough to read another payer's policy.
6
+
7
+ ## Public method
8
+
9
+ `getVectorDocumentChunks`
10
+
11
+ Signature: `graph.getVectorDocumentChunks(docId, query)`
12
+
13
+ Return type: `Promise<GetVectorDocumentChunksResponse>`
14
+
15
+ ## Authentication
16
+
17
+ Classification: **AUTHENTICATED**
18
+
19
+ Schemes: `bearerAuth`
20
+
21
+ ## Prerequisites
22
+
23
+ None documented.
24
+
25
+ ## HTTP
26
+
27
+ `GET /graph/vector/documents/{doc_id}`
28
+
29
+ ## Path parameters
30
+
31
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
32
+ |---|---|---:|---|---|---|---:|---|
33
+ | `doc_id` | `string` | Yes | | | | No | |
34
+
35
+ ## Query parameters
36
+
37
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
38
+ |---|---|---:|---|---|---|---:|---|
39
+ | `collection` | `string` | No | | | | No | Collection to read from; defaults to the documents corpus |
40
+ | `limit` | `integer` | No | | | `100` | No | |
41
+ | `payer_key` | `string` | No | | | | No | Payer slug; REQUIRED when reading from the payer-policy collection |
42
+
43
+ ## Body parameters
44
+
45
+ None.
46
+
47
+ Request model: None.
48
+
49
+ ## Request example
50
+
51
+ None declared in canonical OpenAPI.
52
+
53
+ ## Success responses
54
+
55
+ | Status | Shape | Content type | Description |
56
+ |---|---|---|---|
57
+ | `200` | [`GetVectorDocumentChunksResponse`](../models/GetVectorDocumentChunksResponse.md) | application/json | The document's chunks, ordered by chunk_index |
58
+
59
+ ## Success response examples
60
+
61
+ ### 200
62
+
63
+ ```json
64
+ {
65
+ "chunk_count": 0,
66
+ "chunks": [
67
+ {
68
+ "chunk_index": 0,
69
+ "collection_group": "string",
70
+ "doc_id": "string",
71
+ "id": "string",
72
+ "language": "string",
73
+ "metadata": {},
74
+ "network_id": "string",
75
+ "payer_key": "string",
76
+ "score": 0,
77
+ "source": "string",
78
+ "tags": [
79
+ "string"
80
+ ],
81
+ "text": "string",
82
+ "title": "string",
83
+ "url": "string"
84
+ }
85
+ ],
86
+ "collection": "string",
87
+ "collection_group": "string",
88
+ "doc_id": "string",
89
+ "language": "string",
90
+ "metadata": {},
91
+ "payer_key": "string",
92
+ "source": "string",
93
+ "tags": [
94
+ "string"
95
+ ],
96
+ "title": "string",
97
+ "url": "string"
98
+ }
99
+ ```
100
+
101
+ ## Common errors
102
+
103
+ | Status | Shape | Content type | Description |
104
+ |---|---|---|---|
105
+ | `400` | [`graph.ErrorResponse`](../models/graph.ErrorResponse.md) | application/json | The request was invalid — a required parameter was missing or a filter value was not recognized |
106
+ | `401` | [`graph.ErrorResponse`](../models/graph.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
107
+ | `404` | [`graph.ErrorResponse`](../models/graph.ErrorResponse.md) | application/json | No chunks exist for doc_id in the collection |
108
+ | `500` | [`graph.ErrorResponse`](../models/graph.ErrorResponse.md) | application/json | Internal server error |
109
+ | `503` | [`graph.ErrorResponse`](../models/graph.ErrorResponse.md) | application/json | Vector search is not configured in this environment |
110
+
111
+ ## Error examples
112
+
113
+ ### 400 — A required query parameter was missing or a filter value was not recognized (sanitized example)
114
+
115
+ ```json
116
+ {
117
+ "error": "Bad request"
118
+ }
119
+ ```
120
+
121
+ ### 401 — Missing or invalid access token
122
+
123
+ ```json
124
+ {
125
+ "error": "Authorization required"
126
+ }
127
+ ```
128
+
129
+ ### 404 — The document is not loaded in this collection
130
+
131
+ ```json
132
+ {
133
+ "error": "Document not found in the vector store"
134
+ }
135
+ ```
136
+
137
+ ### 500 — Unexpected service failure (sanitized example)
138
+
139
+ ```json
140
+ {
141
+ "error": "Internal server error"
142
+ }
143
+ ```
144
+
145
+ ### 503 — No Milvus endpoint or embedding key is provisioned
146
+
147
+ ```json
148
+ {
149
+ "error": "Vector search is not configured"
150
+ }
151
+ ```
152
+
153
+ ## NodeJS / TypeScript implementation
154
+
155
+ ```ts
156
+ import { HCSDK } from "@healthcloudai/hc-sdk";
157
+ ```
158
+
159
+ ```ts
160
+ const docId = "<DOC_ID>";
161
+
162
+ const query = {
163
+ "collection": "<COLLECTION>",
164
+ "limit": 100,
165
+ "payer_key": "<PAYER_KEY>"
166
+ };
167
+
168
+ const result = await graph.getVectorDocumentChunks(docId, query);
169
+ ```
170
+
171
+ ## cURL
172
+
173
+ ```bash
174
+ curl -X GET \
175
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
176
+ 'https://dev-api-graph.health.cloud/graph/vector/documents/%3CDOC_ID%3E?collection=%3CCOLLECTION%3E&limit=100&payer_key=%3CPAYER_KEY%3E'
177
+ ```
178
+
179
+ ## Notes
180
+
181
+ None.
182
+
183
+ ## Prepared Test Console scenario
184
+
185
+ No canonical scenario is currently associated.
186
+
187
+ ## Real response
188
+
189
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
@@ -0,0 +1,138 @@
1
+ # List searchable vector collections
2
+
3
+ Operation ID: `graph.listVectorCollections`
4
+
5
+ List the vector collections this deployment can search, with each one's chunk count, vector width, similarity metric, and whether it is partitioned by payer (which makes payer_key mandatory when reading it). The width is the operationally important field: the collections are loaded by a separate pipeline, so a corpus embedded with a different model has a different width and cannot be searched with this deployment's query vectors at all.
6
+
7
+ ## Public method
8
+
9
+ `listVectorCollections`
10
+
11
+ Signature: `graph.listVectorCollections()`
12
+
13
+ Return type: `Promise<ListVectorCollectionsResponse>`
14
+
15
+ ## Authentication
16
+
17
+ Classification: **AUTHENTICATED**
18
+
19
+ Schemes: `bearerAuth`
20
+
21
+ ## Prerequisites
22
+
23
+ None documented.
24
+
25
+ ## HTTP
26
+
27
+ `GET /graph/vector/collections`
28
+
29
+ ## Path parameters
30
+
31
+ None.
32
+
33
+ ## Query parameters
34
+
35
+ None.
36
+
37
+ ## Body parameters
38
+
39
+ None.
40
+
41
+ Request model: None.
42
+
43
+ ## Request example
44
+
45
+ None declared in canonical OpenAPI.
46
+
47
+ ## Success responses
48
+
49
+ | Status | Shape | Content type | Description |
50
+ |---|---|---|---|
51
+ | `200` | [`ListVectorCollectionsResponse`](../models/ListVectorCollectionsResponse.md) | application/json | Configured collections with chunk count, vector width and metric |
52
+
53
+ ## Success response examples
54
+
55
+ ### 200
56
+
57
+ ```json
58
+ {
59
+ "collections": [
60
+ {
61
+ "available": true,
62
+ "chunk_count": 4211,
63
+ "collection": "medical_documents",
64
+ "detail": null,
65
+ "dimension": 384,
66
+ "metric_type": "COSINE",
67
+ "partitioned_by_payer": false,
68
+ "role": "documents"
69
+ }
70
+ ],
71
+ "embedding_model": "BAAI/bge-small-en-v1.5",
72
+ "total": 1
73
+ }
74
+ ```
75
+
76
+ ## Common errors
77
+
78
+ | Status | Shape | Content type | Description |
79
+ |---|---|---|---|
80
+ | `401` | [`graph.ErrorResponse`](../models/graph.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
81
+ | `500` | [`graph.ErrorResponse`](../models/graph.ErrorResponse.md) | application/json | Internal server error |
82
+ | `503` | [`graph.ErrorResponse`](../models/graph.ErrorResponse.md) | application/json | Vector search is not configured in this environment |
83
+
84
+ ## Error examples
85
+
86
+ ### 401 — Missing or invalid access token
87
+
88
+ ```json
89
+ {
90
+ "error": "Authorization required"
91
+ }
92
+ ```
93
+
94
+ ### 500 — Unexpected service failure (sanitized example)
95
+
96
+ ```json
97
+ {
98
+ "error": "Internal server error"
99
+ }
100
+ ```
101
+
102
+ ### 503 — No Milvus endpoint or embedding key is provisioned
103
+
104
+ ```json
105
+ {
106
+ "error": "Vector search is not configured"
107
+ }
108
+ ```
109
+
110
+ ## NodeJS / TypeScript implementation
111
+
112
+ ```ts
113
+ import { HCSDK } from "@healthcloudai/hc-sdk";
114
+ ```
115
+
116
+ ```ts
117
+ const result = await graph.listVectorCollections();
118
+ ```
119
+
120
+ ## cURL
121
+
122
+ ```bash
123
+ curl -X GET \
124
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
125
+ 'https://dev-api-graph.health.cloud/graph/vector/collections'
126
+ ```
127
+
128
+ ## Notes
129
+
130
+ None.
131
+
132
+ ## Prepared Test Console scenario
133
+
134
+ No canonical scenario is currently associated.
135
+
136
+ ## Real response
137
+
138
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.