@amgix/amgix-client 1.0.0-beta1

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.
Files changed (80) hide show
  1. package/LICENSE +202 -0
  2. package/dist/apis/AmgixApi.d.ts +236 -0
  3. package/dist/apis/AmgixApi.d.ts.map +1 -0
  4. package/dist/apis/AmgixApi.js +554 -0
  5. package/dist/apis/index.d.ts +2 -0
  6. package/dist/apis/index.d.ts.map +1 -0
  7. package/dist/apis/index.js +19 -0
  8. package/dist/index.d.ts +4 -0
  9. package/dist/index.d.ts.map +1 -0
  10. package/dist/index.js +21 -0
  11. package/dist/models/BulkUploadRequest.d.ts +34 -0
  12. package/dist/models/BulkUploadRequest.d.ts.map +1 -0
  13. package/dist/models/BulkUploadRequest.js +51 -0
  14. package/dist/models/CollectionConfig.d.ts +47 -0
  15. package/dist/models/CollectionConfig.d.ts.map +1 -0
  16. package/dist/models/CollectionConfig.js +56 -0
  17. package/dist/models/CustomDocumentVector.d.ts +55 -0
  18. package/dist/models/CustomDocumentVector.d.ts.map +1 -0
  19. package/dist/models/CustomDocumentVector.js +68 -0
  20. package/dist/models/CustomVector.d.ts +40 -0
  21. package/dist/models/CustomVector.d.ts.map +1 -0
  22. package/dist/models/CustomVector.js +55 -0
  23. package/dist/models/Document.d.ts +80 -0
  24. package/dist/models/Document.d.ts.map +1 -0
  25. package/dist/models/Document.js +69 -0
  26. package/dist/models/DocumentStatus.d.ts +67 -0
  27. package/dist/models/DocumentStatus.d.ts.map +1 -0
  28. package/dist/models/DocumentStatus.js +70 -0
  29. package/dist/models/DocumentStatusResponse.d.ts +34 -0
  30. package/dist/models/DocumentStatusResponse.d.ts.map +1 -0
  31. package/dist/models/DocumentStatusResponse.js +51 -0
  32. package/dist/models/HTTPValidationError.d.ts +34 -0
  33. package/dist/models/HTTPValidationError.d.ts.map +1 -0
  34. package/dist/models/HTTPValidationError.js +49 -0
  35. package/dist/models/MetadataFilter.d.ts +74 -0
  36. package/dist/models/MetadataFilter.d.ts.map +1 -0
  37. package/dist/models/MetadataFilter.js +69 -0
  38. package/dist/models/MetadataIndex.d.ts +50 -0
  39. package/dist/models/MetadataIndex.d.ts.map +1 -0
  40. package/dist/models/MetadataIndex.js +65 -0
  41. package/dist/models/OkResponse.d.ts +33 -0
  42. package/dist/models/OkResponse.d.ts.map +1 -0
  43. package/dist/models/OkResponse.js +50 -0
  44. package/dist/models/QueueInfo.d.ts +52 -0
  45. package/dist/models/QueueInfo.d.ts.map +1 -0
  46. package/dist/models/QueueInfo.js +62 -0
  47. package/dist/models/SearchQuery.d.ts +86 -0
  48. package/dist/models/SearchQuery.d.ts.map +1 -0
  49. package/dist/models/SearchQuery.js +69 -0
  50. package/dist/models/SearchResult.d.ts +87 -0
  51. package/dist/models/SearchResult.d.ts.map +1 -0
  52. package/dist/models/SearchResult.js +74 -0
  53. package/dist/models/ValidationError.d.ts +46 -0
  54. package/dist/models/ValidationError.d.ts.map +1 -0
  55. package/dist/models/ValidationError.js +59 -0
  56. package/dist/models/ValidationErrorLocInner.d.ts +27 -0
  57. package/dist/models/ValidationErrorLocInner.d.ts.map +1 -0
  58. package/dist/models/ValidationErrorLocInner.js +38 -0
  59. package/dist/models/Vector.d.ts +27 -0
  60. package/dist/models/Vector.d.ts.map +1 -0
  61. package/dist/models/Vector.js +38 -0
  62. package/dist/models/VectorConfig.d.ts +154 -0
  63. package/dist/models/VectorConfig.d.ts.map +1 -0
  64. package/dist/models/VectorConfig.js +113 -0
  65. package/dist/models/VectorScore.d.ts +51 -0
  66. package/dist/models/VectorScore.d.ts.map +1 -0
  67. package/dist/models/VectorScore.js +62 -0
  68. package/dist/models/VectorSearchWeight.d.ts +56 -0
  69. package/dist/models/VectorSearchWeight.d.ts.map +1 -0
  70. package/dist/models/VectorSearchWeight.js +67 -0
  71. package/dist/models/VersionResponse.d.ts +33 -0
  72. package/dist/models/VersionResponse.d.ts.map +1 -0
  73. package/dist/models/VersionResponse.js +50 -0
  74. package/dist/models/index.d.ts +22 -0
  75. package/dist/models/index.d.ts.map +1 -0
  76. package/dist/models/index.js +39 -0
  77. package/dist/runtime.d.ts +185 -0
  78. package/dist/runtime.d.ts.map +1 -0
  79. package/dist/runtime.js +338 -0
  80. package/package.json +27 -0
package/LICENSE ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
@@ -0,0 +1,236 @@
1
+ /**
2
+ * Amalgam Index API
3
+ * Amalgam Index (Amgix). The Hybrid Semantic Search Platform, API
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0-dev
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import * as runtime from '../runtime';
13
+ import type { BulkUploadRequest, CollectionConfig, Document, DocumentStatusResponse, OkResponse, QueueInfo, SearchQuery, SearchResult, VersionResponse } from '../models/index';
14
+ export interface CreateCollectionRequest {
15
+ collectionName: string;
16
+ collectionConfig: CollectionConfig;
17
+ }
18
+ export interface DeleteCollectionRequest {
19
+ collectionName: string;
20
+ }
21
+ export interface DeleteCollectionQueueRequest {
22
+ collectionName: string;
23
+ }
24
+ export interface DeleteDocumentRequest {
25
+ collectionName: string;
26
+ documentId: string;
27
+ }
28
+ export interface EmptyCollectionRequest {
29
+ collectionName: string;
30
+ }
31
+ export interface GetCollectionConfigRequest {
32
+ collectionName: string;
33
+ }
34
+ export interface GetCollectionQueueInfoRequest {
35
+ collectionName: string;
36
+ }
37
+ export interface GetDocumentRequest {
38
+ collectionName: string;
39
+ documentId: string;
40
+ }
41
+ export interface GetDocumentStatusRequest {
42
+ collectionName: string;
43
+ documentId: string;
44
+ }
45
+ export interface SearchRequest {
46
+ collectionName: string;
47
+ searchQuery: SearchQuery;
48
+ }
49
+ export interface UpsertDocumentRequest {
50
+ collectionName: string;
51
+ document: Document;
52
+ }
53
+ export interface UpsertDocumentSyncRequest {
54
+ collectionName: string;
55
+ document: Document;
56
+ }
57
+ export interface UpsertDocumentsBulkRequest {
58
+ collectionName: string;
59
+ bulkUploadRequest: BulkUploadRequest;
60
+ }
61
+ /**
62
+ *
63
+ */
64
+ export declare class AmgixApi extends runtime.BaseAPI {
65
+ /**
66
+ * Create a new collection. This endpoint creates a new collection with the specified name and vector configurations. It validates the provided model configurations and ensures all required features are supported by the database. Args: collection_name: The unique name for the new collection (alphanumeric, underscores, hyphens only). config: Configuration details for the collection, including vector types and storage options. Returns: An `OkResponse` object indicating the success of the operation. Raises: HTTPException: - 400 if model validation fails or required features are not supported. - 409 if a collection with the same name already exists. - 500 if the collection creation fails in the database.
67
+ * Create Collection
68
+ */
69
+ createCollectionRaw(requestParameters: CreateCollectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OkResponse>>;
70
+ /**
71
+ * Create a new collection. This endpoint creates a new collection with the specified name and vector configurations. It validates the provided model configurations and ensures all required features are supported by the database. Args: collection_name: The unique name for the new collection (alphanumeric, underscores, hyphens only). config: Configuration details for the collection, including vector types and storage options. Returns: An `OkResponse` object indicating the success of the operation. Raises: HTTPException: - 400 if model validation fails or required features are not supported. - 409 if a collection with the same name already exists. - 500 if the collection creation fails in the database.
72
+ * Create Collection
73
+ */
74
+ createCollection(requestParameters: CreateCollectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OkResponse>;
75
+ /**
76
+ * Delete a collection. Deletes a collection and all its associated data. This operation is irreversible. Args: collection_name: The name of the collection to delete. Returns: An `OkResponse` object indicating the success of the operation.
77
+ * Delete Collection
78
+ */
79
+ deleteCollectionRaw(requestParameters: DeleteCollectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OkResponse>>;
80
+ /**
81
+ * Delete a collection. Deletes a collection and all its associated data. This operation is irreversible. Args: collection_name: The name of the collection to delete. Returns: An `OkResponse` object indicating the success of the operation.
82
+ * Delete Collection
83
+ */
84
+ deleteCollection(requestParameters: DeleteCollectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OkResponse>;
85
+ /**
86
+ * Delete all queue entries for a collection. Removes all documents from the processing queue for a specified collection. This does not affect documents already indexed in the collection. Args: collection_name: The name of the collection for which to delete queue entries. Returns: An `OkResponse` object indicating the success of the operation.
87
+ * Delete Collection Queue
88
+ */
89
+ deleteCollectionQueueRaw(requestParameters: DeleteCollectionQueueRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OkResponse>>;
90
+ /**
91
+ * Delete all queue entries for a collection. Removes all documents from the processing queue for a specified collection. This does not affect documents already indexed in the collection. Args: collection_name: The name of the collection for which to delete queue entries. Returns: An `OkResponse` object indicating the success of the operation.
92
+ * Delete Collection Queue
93
+ */
94
+ deleteCollectionQueue(requestParameters: DeleteCollectionQueueRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OkResponse>;
95
+ /**
96
+ * Delete a document. Deletes a specific document by its ID from the specified collection. Args: collection_name: The name of the collection. document_id: The unique identifier of the document to delete. Returns: An `OkResponse` object indicating the success of the operation.
97
+ * Delete Document
98
+ */
99
+ deleteDocumentRaw(requestParameters: DeleteDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OkResponse>>;
100
+ /**
101
+ * Delete a document. Deletes a specific document by its ID from the specified collection. Args: collection_name: The name of the collection. document_id: The unique identifier of the document to delete. Returns: An `OkResponse` object indicating the success of the operation.
102
+ * Delete Document
103
+ */
104
+ deleteDocument(requestParameters: DeleteDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OkResponse>;
105
+ /**
106
+ * Empty a collection. Removes all documents and their associated vector data from a specified collection, but keeps the collection\'s configuration. Args: collection_name: The name of the collection to empty. Returns: An `OkResponse` object indicating the success of the operation.
107
+ * Empty Collection
108
+ */
109
+ emptyCollectionRaw(requestParameters: EmptyCollectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OkResponse>>;
110
+ /**
111
+ * Empty a collection. Removes all documents and their associated vector data from a specified collection, but keeps the collection\'s configuration. Args: collection_name: The name of the collection to empty. Returns: An `OkResponse` object indicating the success of the operation.
112
+ * Empty Collection
113
+ */
114
+ emptyCollection(requestParameters: EmptyCollectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OkResponse>;
115
+ /**
116
+ * Get collection configuration. Retrieves the configuration details for a specific collection. Args: collection_name: The name of the collection. Returns: The configuration of the specified collection.
117
+ * Get Collection Config
118
+ */
119
+ getCollectionConfigRaw(requestParameters: GetCollectionConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CollectionConfig>>;
120
+ /**
121
+ * Get collection configuration. Retrieves the configuration details for a specific collection. Args: collection_name: The name of the collection. Returns: The configuration of the specified collection.
122
+ * Get Collection Config
123
+ */
124
+ getCollectionConfig(requestParameters: GetCollectionConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CollectionConfig>;
125
+ /**
126
+ * Get queue statistics for a collection. Retrieves counts of documents in different queue states (queued, requeued, failed). Args: collection_name: The name of the collection. Returns: A `QueueInfo` object with counts for each queue state.
127
+ * Get Collection Queue Info
128
+ */
129
+ getCollectionQueueInfoRaw(requestParameters: GetCollectionQueueInfoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<QueueInfo>>;
130
+ /**
131
+ * Get queue statistics for a collection. Retrieves counts of documents in different queue states (queued, requeued, failed). Args: collection_name: The name of the collection. Returns: A `QueueInfo` object with counts for each queue state.
132
+ * Get Collection Queue Info
133
+ */
134
+ getCollectionQueueInfo(requestParameters: GetCollectionQueueInfoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<QueueInfo>;
135
+ /**
136
+ * Retrieve a single document. Retrieves a specific document by its ID from the specified collection. Args: collection_name: The name of the collection. document_id: The unique identifier of the document to retrieve. Returns: The retrieved `Document` object. Raises: HTTPException: 404 if the document is not found in the collection.
137
+ * Get Document
138
+ */
139
+ getDocumentRaw(requestParameters: GetDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Document>>;
140
+ /**
141
+ * Retrieve a single document. Retrieves a specific document by its ID from the specified collection. Args: collection_name: The name of the collection. document_id: The unique identifier of the document to retrieve. Returns: The retrieved `Document` object. Raises: HTTPException: 404 if the document is not found in the collection.
142
+ * Get Document
143
+ */
144
+ getDocument(requestParameters: GetDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Document>;
145
+ /**
146
+ * Get document processing status. Retrieves the processing status of a document, including its current state in the queue and any associated messages. Args: collection_name: The name of the collection. document_id: The unique identifier of the document. Returns: A `DocumentStatusResponse` object containing the processing status of the document. Raises: HTTPException: 404 if the document is not found in the collection\'s queue.
147
+ * Get Document Status
148
+ */
149
+ getDocumentStatusRaw(requestParameters: GetDocumentStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentStatusResponse>>;
150
+ /**
151
+ * Get document processing status. Retrieves the processing status of a document, including its current state in the queue and any associated messages. Args: collection_name: The name of the collection. document_id: The unique identifier of the document. Returns: A `DocumentStatusResponse` object containing the processing status of the document. Raises: HTTPException: 404 if the document is not found in the collection\'s queue.
152
+ * Get Document Status
153
+ */
154
+ getDocumentStatus(requestParameters: GetDocumentStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentStatusResponse>;
155
+ /**
156
+ * Check API service responsiveness. This endpoint returns a simple \'ok\' status to indicate that the API service is running and able to respond to requests. Returns: An `OkResponse` object with the \'ok\' field set to True, confirming the service\'s responsiveness.
157
+ * Health
158
+ */
159
+ healthCheckRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OkResponse>>;
160
+ /**
161
+ * Check API service responsiveness. This endpoint returns a simple \'ok\' status to indicate that the API service is running and able to respond to requests. Returns: An `OkResponse` object with the \'ok\' field set to True, confirming the service\'s responsiveness.
162
+ * Health
163
+ */
164
+ healthCheck(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OkResponse>;
165
+ /**
166
+ * Check if service is ready to handle requests. Verifies connectivity to required dependencies: - Database (Qdrant/PostgreSQL/MariaDB) - RabbitMQ message broker Returns: An `OkResponse` object with ok=True if all dependencies are healthy. Raises: HTTPException: 503 if any dependency is unavailable.
167
+ * Readiness Check
168
+ */
169
+ healthReadyRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OkResponse>>;
170
+ /**
171
+ * Check if service is ready to handle requests. Verifies connectivity to required dependencies: - Database (Qdrant/PostgreSQL/MariaDB) - RabbitMQ message broker Returns: An `OkResponse` object with ok=True if all dependencies are healthy. Raises: HTTPException: 503 if any dependency is unavailable.
172
+ * Readiness Check
173
+ */
174
+ healthReady(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OkResponse>;
175
+ /**
176
+ * List all available collections. Retrieves a list of all collections managed by the application. Returns: A list of strings, where each string is the name of an available collection.
177
+ * List Collections
178
+ */
179
+ listCollectionsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<string>>>;
180
+ /**
181
+ * List all available collections. Retrieves a list of all collections managed by the application. Returns: A list of strings, where each string is the name of an available collection.
182
+ * List Collections
183
+ */
184
+ listCollections(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<string>>;
185
+ /**
186
+ * Perform a search query on a collection. Executes a search query against the specified collection. Args: collection_name: The name of the collection to search. query: The `SearchQuery` object containing the search text, filters, and other parameters. Returns: A list of `SearchResult` objects, where each object represents a search result.
187
+ * Search
188
+ */
189
+ searchRaw(requestParameters: SearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SearchResult>>>;
190
+ /**
191
+ * Perform a search query on a collection. Executes a search query against the specified collection. Args: collection_name: The name of the collection to search. query: The `SearchQuery` object containing the search text, filters, and other parameters. Returns: A list of `SearchResult` objects, where each object represents a search result.
192
+ * Search
193
+ */
194
+ search(requestParameters: SearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SearchResult>>;
195
+ /**
196
+ * Upsert a single document asynchronously. Adds or updates a single document in the specified collection by placing it into a processing queue. The document will be vectorized and indexed asynchronously. Args: collection_name: The name of the collection to upsert the document into. document: The document object to be upserted. Returns: An `OkResponse` object indicating that the document has been accepted for processing. Raises: HTTPException: 500 if publishing the event to the internal queue fails.
197
+ * Upsert Document
198
+ */
199
+ upsertDocumentRaw(requestParameters: UpsertDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OkResponse>>;
200
+ /**
201
+ * Upsert a single document asynchronously. Adds or updates a single document in the specified collection by placing it into a processing queue. The document will be vectorized and indexed asynchronously. Args: collection_name: The name of the collection to upsert the document into. document: The document object to be upserted. Returns: An `OkResponse` object indicating that the document has been accepted for processing. Raises: HTTPException: 500 if publishing the event to the internal queue fails.
202
+ * Upsert Document
203
+ */
204
+ upsertDocument(requestParameters: UpsertDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OkResponse>;
205
+ /**
206
+ * Upsert a single document synchronously. Adds or updates a single document in the specified collection and waits for the operation to complete, including vectorization and indexing. Args: collection_name: The name of the collection to upsert the document into. document: The document object to be upserted. Returns: An `OkResponse` object indicating the success of the operation. Raises: HTTPException: - 409 if a document with the same ID and newer timestamp already exists (conflict). - 500 for other internal server errors during processing.
207
+ * Upsert Document Sync
208
+ */
209
+ upsertDocumentSyncRaw(requestParameters: UpsertDocumentSyncRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OkResponse>>;
210
+ /**
211
+ * Upsert a single document synchronously. Adds or updates a single document in the specified collection and waits for the operation to complete, including vectorization and indexing. Args: collection_name: The name of the collection to upsert the document into. document: The document object to be upserted. Returns: An `OkResponse` object indicating the success of the operation. Raises: HTTPException: - 409 if a document with the same ID and newer timestamp already exists (conflict). - 500 for other internal server errors during processing.
212
+ * Upsert Document Sync
213
+ */
214
+ upsertDocumentSync(requestParameters: UpsertDocumentSyncRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OkResponse>;
215
+ /**
216
+ * Upsert multiple documents in bulk asynchronously. Adds or updates multiple documents in the specified collection by placing them into a processing queue. Documents will be vectorized and indexed asynchronously. This method is optimized for bulk operations. Args: collection_name: The name of the collection to upsert the documents into. request: A `BulkUploadRequest` object containing a list of `Document` objects to be upserted. Returns: An `OkResponse` object indicating that the documents have been accepted for processing. Raises: HTTPException: 500 if publishing events to the internal queue fails for any document.
217
+ * Upsert Documents Bulk
218
+ */
219
+ upsertDocumentsBulkRaw(requestParameters: UpsertDocumentsBulkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OkResponse>>;
220
+ /**
221
+ * Upsert multiple documents in bulk asynchronously. Adds or updates multiple documents in the specified collection by placing them into a processing queue. Documents will be vectorized and indexed asynchronously. This method is optimized for bulk operations. Args: collection_name: The name of the collection to upsert the documents into. request: A `BulkUploadRequest` object containing a list of `Document` objects to be upserted. Returns: An `OkResponse` object indicating that the documents have been accepted for processing. Raises: HTTPException: 500 if publishing events to the internal queue fails for any document.
222
+ * Upsert Documents Bulk
223
+ */
224
+ upsertDocumentsBulk(requestParameters: UpsertDocumentsBulkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OkResponse>;
225
+ /**
226
+ * Return the system version. Returns: A `VersionResponse` object with the system version.
227
+ * Version
228
+ */
229
+ versionRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VersionResponse>>;
230
+ /**
231
+ * Return the system version. Returns: A `VersionResponse` object with the system version.
232
+ * Version
233
+ */
234
+ version(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VersionResponse>;
235
+ }
236
+ //# sourceMappingURL=AmgixApi.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"AmgixApi.d.ts","sourceRoot":"","sources":["../../apis/AmgixApi.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAGH,OAAO,KAAK,OAAO,MAAM,YAAY,CAAC;AACtC,OAAO,KAAK,EACV,iBAAiB,EACjB,gBAAgB,EAChB,QAAQ,EACR,sBAAsB,EAEtB,UAAU,EACV,SAAS,EACT,WAAW,EACX,YAAY,EACZ,eAAe,EAChB,MAAM,iBAAiB,CAAC;AAwBzB,MAAM,WAAW,uBAAuB;IACpC,cAAc,EAAE,MAAM,CAAC;IACvB,gBAAgB,EAAE,gBAAgB,CAAC;CACtC;AAED,MAAM,WAAW,uBAAuB;IACpC,cAAc,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,4BAA4B;IACzC,cAAc,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,qBAAqB;IAClC,cAAc,EAAE,MAAM,CAAC;IACvB,UAAU,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,sBAAsB;IACnC,cAAc,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,0BAA0B;IACvC,cAAc,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,6BAA6B;IAC1C,cAAc,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,kBAAkB;IAC/B,cAAc,EAAE,MAAM,CAAC;IACvB,UAAU,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,wBAAwB;IACrC,cAAc,EAAE,MAAM,CAAC;IACvB,UAAU,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,aAAa;IAC1B,cAAc,EAAE,MAAM,CAAC;IACvB,WAAW,EAAE,WAAW,CAAC;CAC5B;AAED,MAAM,WAAW,qBAAqB;IAClC,cAAc,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,QAAQ,CAAC;CACtB;AAED,MAAM,WAAW,yBAAyB;IACtC,cAAc,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,QAAQ,CAAC;CACtB;AAED,MAAM,WAAW,0BAA0B;IACvC,cAAc,EAAE,MAAM,CAAC;IACvB,iBAAiB,EAAE,iBAAiB,CAAC;CACxC;AAED;;GAEG;AACH,qBAAa,QAAS,SAAQ,OAAO,CAAC,OAAO;IAEzC;;;OAGG;IACG,mBAAmB,CAAC,iBAAiB,EAAE,uBAAuB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAoC3K;;;OAGG;IACG,gBAAgB,CAAC,iBAAiB,EAAE,uBAAuB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,UAAU,CAAC;IAKnJ;;;OAGG;IACG,mBAAmB,CAAC,iBAAiB,EAAE,uBAAuB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IA0B3K;;;OAGG;IACG,gBAAgB,CAAC,iBAAiB,EAAE,uBAAuB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,UAAU,CAAC;IAKnJ;;;OAGG;IACG,wBAAwB,CAAC,iBAAiB,EAAE,4BAA4B,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IA0BrL;;;OAGG;IACG,qBAAqB,CAAC,iBAAiB,EAAE,4BAA4B,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,UAAU,CAAC;IAK7J;;;OAGG;IACG,iBAAiB,CAAC,iBAAiB,EAAE,qBAAqB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAkCvK;;;OAGG;IACG,cAAc,CAAC,iBAAiB,EAAE,qBAAqB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,UAAU,CAAC;IAK/I;;;OAGG;IACG,kBAAkB,CAAC,iBAAiB,EAAE,sBAAsB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IA0BzK;;;OAGG;IACG,eAAe,CAAC,iBAAiB,EAAE,sBAAsB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,UAAU,CAAC;IAKjJ;;;OAGG;IACG,sBAAsB,CAAC,iBAAiB,EAAE,0BAA0B,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC;IA0BvL;;;OAGG;IACG,mBAAmB,CAAC,iBAAiB,EAAE,0BAA0B,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAK/J;;;OAGG;IACG,yBAAyB,CAAC,iBAAiB,EAAE,6BAA6B,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;IA0BtL;;;OAGG;IACG,sBAAsB,CAAC,iBAAiB,EAAE,6BAA6B,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,SAAS,CAAC;IAK9J;;;OAGG;IACG,cAAc,CAAC,iBAAiB,EAAE,kBAAkB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IAkC/J;;;OAGG;IACG,WAAW,CAAC,iBAAiB,EAAE,kBAAkB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAKvI;;;OAGG;IACG,oBAAoB,CAAC,iBAAiB,EAAE,wBAAwB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,sBAAsB,CAAC,CAAC;IAkCzL;;;OAGG;IACG,iBAAiB,CAAC,iBAAiB,EAAE,wBAAwB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAKjK;;;OAGG;IACG,cAAc,CAAC,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAkB1H;;;OAGG;IACG,WAAW,CAAC,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,UAAU,CAAC;IAKlG;;;OAGG;IACG,cAAc,CAAC,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAkB1H;;;OAGG;IACG,WAAW,CAAC,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,UAAU,CAAC;IAKlG;;;OAGG;IACG,kBAAkB,CAAC,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;IAkBjI;;;OAGG;IACG,eAAe,CAAC,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAKzG;;;OAGG;IACG,SAAS,CAAC,iBAAiB,EAAE,aAAa,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC;IAoChK;;;OAGG;IACG,MAAM,CAAC,iBAAiB,EAAE,aAAa,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;IAKxI;;;OAGG;IACG,iBAAiB,CAAC,iBAAiB,EAAE,qBAAqB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAoCvK;;;OAGG;IACG,cAAc,CAAC,iBAAiB,EAAE,qBAAqB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,UAAU,CAAC;IAK/I;;;OAGG;IACG,qBAAqB,CAAC,iBAAiB,EAAE,yBAAyB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAoC/K;;;OAGG;IACG,kBAAkB,CAAC,iBAAiB,EAAE,yBAAyB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,UAAU,CAAC;IAKvJ;;;OAGG;IACG,sBAAsB,CAAC,iBAAiB,EAAE,0BAA0B,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAoCjL;;;OAGG;IACG,mBAAmB,CAAC,iBAAiB,EAAE,0BAA0B,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,UAAU,CAAC;IAKzJ;;;OAGG;IACG,UAAU,CAAC,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,eAAe,CAAC,CAAC;IAkB3H;;;OAGG;IACG,OAAO,CAAC,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,eAAe,CAAC;CAKtG"}