@usecortex_ai/node 0.3.6 → 0.5.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.
Files changed (416) hide show
  1. package/LICENSE +23 -23
  2. package/README.md +141 -141
  3. package/dist/Client.d.ts +20 -24
  4. package/dist/Client.js +26 -34
  5. package/dist/api/errors/BadRequestError.d.ts +1 -2
  6. package/dist/api/errors/BadRequestError.js +0 -0
  7. package/dist/api/errors/ForbiddenError.d.ts +1 -2
  8. package/dist/api/errors/ForbiddenError.js +0 -0
  9. package/dist/api/errors/InternalServerError.d.ts +1 -2
  10. package/dist/api/errors/InternalServerError.js +0 -0
  11. package/dist/api/errors/NotFoundError.d.ts +1 -2
  12. package/dist/api/errors/NotFoundError.js +0 -0
  13. package/dist/api/errors/ServiceUnavailableError.d.ts +1 -2
  14. package/dist/api/errors/ServiceUnavailableError.js +0 -0
  15. package/dist/api/errors/TooManyRequestsError.d.ts +9 -0
  16. package/dist/api/errors/TooManyRequestsError.js +42 -0
  17. package/dist/api/errors/UnauthorizedError.d.ts +1 -2
  18. package/dist/api/errors/UnauthorizedError.js +0 -0
  19. package/dist/api/errors/UnprocessableEntityError.d.ts +0 -0
  20. package/dist/api/errors/UnprocessableEntityError.js +0 -0
  21. package/dist/api/errors/index.d.ts +1 -0
  22. package/dist/api/errors/index.js +1 -0
  23. package/dist/api/index.d.ts +0 -0
  24. package/dist/api/index.js +0 -0
  25. package/dist/api/resources/dashboard/client/Client.d.ts +136 -0
  26. package/dist/api/resources/{userMemory → dashboard}/client/Client.js +191 -138
  27. package/dist/api/resources/{user → dashboard}/client/index.d.ts +0 -0
  28. package/dist/api/resources/{user → dashboard}/client/index.js +0 -0
  29. package/dist/api/resources/dashboard/client/requests/CreateUserDashboardUserCreateUserPostRequest.d.ts +12 -0
  30. package/dist/api/resources/{embeddings/client/requests/EmbeddingsCreateCollectionRequest.js → dashboard/client/requests/CreateUserDashboardUserCreateUserPostRequest.js} +0 -0
  31. package/dist/api/resources/dashboard/client/requests/ListSourcesDashboardSourcesGetRequest.d.ts +16 -0
  32. package/dist/api/resources/{embeddings/client/requests/EmbeddingsSearchRequest.js → dashboard/client/requests/ListSourcesDashboardSourcesGetRequest.js} +0 -0
  33. package/dist/api/resources/dashboard/client/requests/index.d.ts +2 -0
  34. package/dist/api/resources/{document/client → dashboard/client/requests}/index.js +0 -0
  35. package/dist/api/resources/{document → dashboard}/index.d.ts +0 -0
  36. package/dist/api/resources/{document → dashboard}/index.js +0 -0
  37. package/dist/api/resources/embeddings/client/Client.d.ts +40 -27
  38. package/dist/api/resources/embeddings/client/Client.js +68 -44
  39. package/dist/api/resources/embeddings/client/index.d.ts +0 -0
  40. package/dist/api/resources/embeddings/client/index.js +0 -0
  41. package/dist/api/resources/embeddings/client/requests/BodyFilterRawEmbeddingsEndpointEmbeddingsFilterRawEmbeddingsPost.d.ts +24 -0
  42. package/dist/api/resources/embeddings/client/requests/{GetEmbeddingsBasedOnChunkIdsRequest.js → BodyFilterRawEmbeddingsEndpointEmbeddingsFilterRawEmbeddingsPost.js} +0 -0
  43. package/dist/api/resources/embeddings/client/requests/BodyInsertRawEmbeddingsEndpointEmbeddingsInsertRawEmbeddingsPost.d.ts +27 -0
  44. package/dist/api/resources/{fetch/client/requests/FetchContentRequest.js → embeddings/client/requests/BodyInsertRawEmbeddingsEndpointEmbeddingsInsertRawEmbeddingsPost.js} +0 -0
  45. package/dist/api/resources/embeddings/client/requests/BodySearchRawEmbeddingsEndpointEmbeddingsSearchRawEmbeddingsPost.d.ts +25 -0
  46. package/dist/api/resources/{search/client/requests/QnARequest.js → embeddings/client/requests/BodySearchRawEmbeddingsEndpointEmbeddingsSearchRawEmbeddingsPost.js} +0 -0
  47. package/dist/api/resources/embeddings/client/requests/EmbeddingsDeleteRequest.d.ts +6 -5
  48. package/dist/api/resources/embeddings/client/requests/EmbeddingsDeleteRequest.js +0 -0
  49. package/dist/api/resources/embeddings/client/requests/index.d.ts +3 -3
  50. package/dist/api/resources/embeddings/client/requests/index.js +0 -0
  51. package/dist/api/resources/embeddings/index.d.ts +0 -0
  52. package/dist/api/resources/embeddings/index.js +0 -0
  53. package/dist/api/resources/fetch/client/Client.d.ts +96 -7
  54. package/dist/api/resources/fetch/client/Client.js +288 -10
  55. package/dist/api/resources/fetch/client/index.d.ts +0 -0
  56. package/dist/api/resources/fetch/client/index.js +0 -0
  57. package/dist/api/resources/{sources/client/requests/SourcesGetGraphRelationsByIdRequest.d.ts → fetch/client/requests/FetchGraphRelationsBySourceIdRequest.d.ts} +2 -3
  58. package/dist/api/resources/{search/client/requests/SearchRequest.js → fetch/client/requests/FetchGraphRelationsBySourceIdRequest.js} +0 -0
  59. package/dist/api/resources/{sources/client/requests/SourcesGetAllRequest.d.ts → fetch/client/requests/FetchSourcesRequest.d.ts} +2 -3
  60. package/dist/api/resources/{sources/client/requests/SourceBodyParams.js → fetch/client/requests/FetchSourcesRequest.js} +0 -0
  61. package/dist/api/resources/fetch/client/requests/ListSourcesByIdRequest.d.ts +18 -0
  62. package/dist/api/resources/{sources/client/requests/SourcesGetAllRequest.js → fetch/client/requests/ListSourcesByIdRequest.js} +0 -0
  63. package/dist/api/resources/{upload/client/requests/UploadUpdateTextRequest.d.ts → fetch/client/requests/SourceFetchRequest.d.ts} +9 -10
  64. package/dist/api/resources/{sources/client/requests/SourcesGetGraphRelationsByIdRequest.js → fetch/client/requests/SourceFetchRequest.js} +0 -0
  65. package/dist/api/resources/fetch/client/requests/index.d.ts +4 -1
  66. package/dist/api/resources/fetch/client/requests/index.js +0 -0
  67. package/dist/api/resources/fetch/index.d.ts +0 -0
  68. package/dist/api/resources/fetch/index.js +0 -0
  69. package/dist/api/resources/index.d.ts +10 -13
  70. package/dist/api/resources/index.js +11 -14
  71. package/dist/api/resources/search/client/Client.d.ts +55 -26
  72. package/dist/api/resources/search/client/Client.js +70 -35
  73. package/dist/api/resources/search/client/index.d.ts +0 -0
  74. package/dist/api/resources/search/client/index.js +0 -0
  75. package/dist/api/resources/search/client/requests/FullTextSearchRequest.d.ts +6 -4
  76. package/dist/api/resources/search/client/requests/FullTextSearchRequest.js +0 -0
  77. package/dist/api/resources/search/client/requests/{SearchRequest.d.ts → HybridSearchRequest.d.ts} +15 -9
  78. package/dist/api/resources/{tenant/client/requests/TenantDeleteSubTenantRequest.js → search/client/requests/HybridSearchRequest.js} +0 -0
  79. package/dist/api/resources/search/client/requests/QnASearchRequest.d.ts +39 -0
  80. package/dist/api/resources/{tenant/client/requests/TenantGetSubTenantIdsRequest.js → search/client/requests/QnASearchRequest.js} +0 -0
  81. package/dist/api/resources/search/client/requests/index.d.ts +2 -2
  82. package/dist/api/resources/search/client/requests/index.js +0 -0
  83. package/dist/api/resources/search/index.d.ts +0 -0
  84. package/dist/api/resources/search/index.js +0 -0
  85. package/dist/api/resources/sources/client/Client.d.ts +11 -61
  86. package/dist/api/resources/sources/client/Client.js +14 -191
  87. package/dist/api/resources/sources/client/index.d.ts +0 -0
  88. package/dist/api/resources/sources/client/index.js +0 -0
  89. package/dist/api/resources/sources/client/requests/SourceDeleteRequest.d.ts +17 -0
  90. package/dist/api/resources/{upload/client/requests/BodyBatchUpdateUploadBatchUpdatePatch.js → sources/client/requests/SourceDeleteRequest.js} +0 -0
  91. package/dist/api/resources/sources/client/requests/index.d.ts +1 -3
  92. package/dist/api/resources/sources/client/requests/index.js +0 -0
  93. package/dist/api/resources/sources/index.d.ts +0 -0
  94. package/dist/api/resources/sources/index.js +0 -0
  95. package/dist/api/resources/tenant/client/Client.d.ts +54 -38
  96. package/dist/api/resources/tenant/client/Client.js +67 -114
  97. package/dist/api/resources/tenant/client/index.d.ts +0 -0
  98. package/dist/api/resources/tenant/client/index.js +0 -0
  99. package/dist/api/resources/tenant/client/requests/TenantCreateRequest.d.ts +20 -0
  100. package/dist/api/resources/{upload/client/requests/BodyBatchUploadUploadBatchUploadPost.js → tenant/client/requests/TenantCreateRequest.js} +0 -0
  101. package/dist/api/resources/tenant/client/requests/TenantStatsRequest.d.ts +1 -4
  102. package/dist/api/resources/tenant/client/requests/TenantStatsRequest.js +0 -0
  103. package/dist/api/resources/tenant/client/requests/index.d.ts +1 -2
  104. package/dist/api/resources/tenant/client/requests/index.js +0 -0
  105. package/dist/api/resources/tenant/index.d.ts +0 -0
  106. package/dist/api/resources/tenant/index.js +0 -0
  107. package/dist/api/resources/upload/client/Client.d.ts +54 -428
  108. package/dist/api/resources/upload/client/Client.js +97 -1417
  109. package/dist/api/resources/upload/client/index.d.ts +0 -0
  110. package/dist/api/resources/upload/client/index.js +0 -0
  111. package/dist/api/resources/upload/client/requests/{UploadUploadMarkdownRequest.d.ts → BodyAddMemoryMemoriesAddMemoryPost.d.ts} +7 -7
  112. package/dist/api/resources/upload/client/requests/{BodyUpdateFileUploadUpdateDocumentPatch.js → BodyAddMemoryMemoriesAddMemoryPost.js} +0 -0
  113. package/dist/api/resources/upload/client/requests/BodyUploadAppIngestionUploadAppPost.d.ts +31 -0
  114. package/dist/api/resources/upload/client/requests/{BodyUploadFilesUploadUploadDocumentPost.js → BodyUploadAppIngestionUploadAppPost.js} +0 -0
  115. package/dist/api/resources/upload/client/requests/BodyUploadDocumentIngestionUploadDocumentPost.d.ts +22 -0
  116. package/dist/api/resources/upload/client/requests/{EmbeddingsUpdateRequest.js → BodyUploadDocumentIngestionUploadDocumentPost.js} +0 -0
  117. package/dist/api/resources/upload/client/requests/UploadDeleteMemoryRequest.d.ts +18 -0
  118. package/dist/api/resources/upload/client/requests/{EmbeddingsUploadRequest.js → UploadDeleteMemoryRequest.js} +0 -0
  119. package/dist/api/resources/upload/client/requests/UploadVerifyProcessingRequest.d.ts +1 -2
  120. package/dist/api/resources/upload/client/requests/UploadVerifyProcessingRequest.js +0 -0
  121. package/dist/api/resources/upload/client/requests/index.d.ts +4 -16
  122. package/dist/api/resources/upload/client/requests/index.js +0 -0
  123. package/dist/api/resources/upload/index.d.ts +0 -0
  124. package/dist/api/resources/upload/index.js +0 -0
  125. package/dist/api/types/ActualErrorResponse.d.ts +0 -0
  126. package/dist/api/types/ActualErrorResponse.js +0 -0
  127. package/dist/api/types/AddMemoryResponse.d.ts +17 -0
  128. package/dist/api/{resources/upload/client/requests/UploadBatchScrapeWebpageRequest.js → types/AddMemoryResponse.js} +0 -0
  129. package/dist/api/types/ApiKeyInfo.d.ts +17 -0
  130. package/dist/api/{resources/upload/client/requests/UploadBatchUploadMarkdownRequest.js → types/ApiKeyInfo.js} +0 -0
  131. package/dist/api/types/AppSourcesUploadData.d.ts +10 -4
  132. package/dist/api/types/AppSourcesUploadData.js +0 -0
  133. package/dist/api/types/AttachmentModel.d.ts +0 -0
  134. package/dist/api/types/AttachmentModel.js +0 -0
  135. package/dist/api/types/Bm25OperatorType.d.ts +0 -0
  136. package/dist/api/types/Bm25OperatorType.js +0 -0
  137. package/dist/api/types/CollectionStats.d.ts +9 -0
  138. package/dist/api/{resources/upload/client/requests/UploadBatchUploadTextRequest.js → types/CollectionStats.js} +0 -0
  139. package/dist/api/types/ContentModel.d.ts +0 -0
  140. package/dist/api/types/ContentModel.js +0 -0
  141. package/dist/api/types/CustomPropertyDefinition.d.ts +38 -0
  142. package/dist/api/{resources/upload/client/requests/UploadScrapeWebpageRequest.js → types/CustomPropertyDefinition.js} +0 -0
  143. package/dist/api/types/DashboardApisResponse.d.ts +12 -0
  144. package/dist/api/{resources/upload/client/requests/UploadUpdateMarkdownRequest.js → types/DashboardApisResponse.js} +0 -0
  145. package/dist/api/types/DashboardSourcesResponse.d.ts +12 -0
  146. package/dist/api/{resources/upload/client/requests/UploadUpdateTextRequest.js → types/DashboardSourcesResponse.js} +0 -0
  147. package/dist/api/types/DashboardTenantsResponse.d.ts +12 -0
  148. package/dist/api/{resources/upload/client/requests/UploadUpdateWebpageRequest.js → types/DashboardTenantsResponse.js} +0 -0
  149. package/dist/api/types/DeleteResult.d.ts +14 -0
  150. package/dist/api/{resources/upload/client/requests/UploadUploadAppSourcesRequest.js → types/DeleteResult.js} +0 -0
  151. package/dist/api/types/DeleteUserMemoryResponse.d.ts +1 -1
  152. package/dist/api/types/DeleteUserMemoryResponse.js +0 -0
  153. package/dist/api/types/Entity.d.ts +2 -2
  154. package/dist/api/types/Entity.js +0 -0
  155. package/dist/api/types/ErrorResponse.d.ts +0 -0
  156. package/dist/api/types/ErrorResponse.js +0 -0
  157. package/dist/api/types/FetchMode.d.ts +12 -0
  158. package/dist/api/types/FetchMode.js +11 -0
  159. package/dist/api/types/ForcefulRelationsPayload.d.ts +9 -0
  160. package/dist/api/{resources/upload/client/requests/UploadUploadMarkdownRequest.js → types/ForcefulRelationsPayload.js} +0 -0
  161. package/dist/api/types/GraphContext.d.ts +12 -0
  162. package/dist/api/{resources/upload/client/requests/UploadUploadTextRequest.js → types/GraphContext.js} +0 -0
  163. package/dist/api/types/HttpValidationError.d.ts +0 -0
  164. package/dist/api/types/HttpValidationError.js +0 -0
  165. package/dist/api/types/Infra.d.ts +8 -0
  166. package/dist/api/{resources/user/client/requests/BodyCreateTenantUserCreateTenantPost.js → types/Infra.js} +0 -0
  167. package/dist/api/types/InsertResult.d.ts +16 -0
  168. package/dist/api/{resources/userMemory/client/requests/AddUserMemoryRequest.js → types/InsertResult.js} +0 -0
  169. package/dist/api/types/MemoryItem.d.ts +43 -0
  170. package/dist/api/{resources/userMemory/client/requests/RetrieveUserMemoryRequest.js → types/MemoryItem.js} +0 -0
  171. package/dist/api/types/MemoryResultItem.d.ts +19 -0
  172. package/dist/api/{resources/userMemory/client/requests/UserMemoryDeleteUserMemoryRequest.js → types/MemoryResultItem.js} +0 -0
  173. package/dist/api/types/MilvusDataType.d.ts +21 -0
  174. package/dist/api/types/MilvusDataType.js +20 -0
  175. package/dist/api/types/PathTriplet.d.ts +1 -7
  176. package/dist/api/types/PathTriplet.js +0 -0
  177. package/dist/api/types/ProcessingStatus.d.ts +16 -2
  178. package/dist/api/types/ProcessingStatus.js +12 -0
  179. package/dist/api/types/QnASearchResponse.d.ts +20 -0
  180. package/dist/api/{resources/userMemory/client/requests/UserMemoryListUserMemoriesRequest.js → types/QnASearchResponse.js} +0 -0
  181. package/dist/api/types/RawEmbeddingDocument.d.ts +15 -0
  182. package/dist/api/types/{AddUserMemoryResponse.js → RawEmbeddingDocument.js} +0 -0
  183. package/dist/api/types/RawEmbeddingSearchResult.d.ts +19 -0
  184. package/dist/api/types/{BatchUploadData.js → RawEmbeddingSearchResult.js} +0 -0
  185. package/dist/api/types/RawEmbeddingVector.d.ts +12 -0
  186. package/dist/api/types/{BodyScrapeWebpageUploadScrapeWebpagePost.js → RawEmbeddingVector.js} +0 -0
  187. package/dist/api/types/RelationEvidence.d.ts +13 -4
  188. package/dist/api/types/RelationEvidence.js +0 -0
  189. package/dist/api/types/RetrievalResult.d.ts +13 -0
  190. package/dist/api/types/{BodyUpdateScrapeJobUploadUpdateWebpagePatch.js → RetrievalResult.js} +0 -0
  191. package/dist/api/types/RetrieveMode.d.ts +0 -0
  192. package/dist/api/types/RetrieveMode.js +0 -0
  193. package/dist/api/types/ScoredPathResponse.d.ts +4 -11
  194. package/dist/api/types/ScoredPathResponse.js +0 -0
  195. package/dist/api/types/SearchMode.d.ts +11 -0
  196. package/dist/api/types/SearchMode.js +10 -0
  197. package/dist/api/types/SourceDeleteResponse.d.ts +14 -0
  198. package/dist/api/types/{ChunkGraphRelationsResponse.js → SourceDeleteResponse.js} +0 -0
  199. package/dist/api/types/SourceDeleteResultItem.d.ts +14 -0
  200. package/dist/api/types/{DeleteMemoryRequest.js → SourceDeleteResultItem.js} +0 -0
  201. package/dist/api/types/SourceFetchResponse.d.ts +26 -0
  202. package/dist/api/types/{DeleteSources.js → SourceFetchResponse.js} +0 -0
  203. package/dist/api/types/{GraphRelationsResponse.d.ts → SourceGraphRelationsResponse.d.ts} +2 -2
  204. package/dist/api/types/{DeleteSubTenantData.js → SourceGraphRelationsResponse.js} +0 -0
  205. package/dist/api/types/SourceListResponse.d.ts +11 -0
  206. package/dist/api/types/{EmbeddingsCreateCollectionData.js → SourceListResponse.js} +0 -0
  207. package/dist/api/types/SourceModel.d.ts +5 -1
  208. package/dist/api/types/SourceModel.js +0 -0
  209. package/dist/api/types/SourceStatus.d.ts +10 -0
  210. package/dist/api/types/SourceStatus.js +12 -0
  211. package/dist/api/types/SourceUploadResponse.d.ts +14 -0
  212. package/dist/api/types/{EmbeddingsDeleteData.js → SourceUploadResponse.js} +0 -0
  213. package/dist/api/types/SourceUploadResultItem.d.ts +14 -0
  214. package/dist/api/types/{EmbeddingsGetData.js → SourceUploadResultItem.js} +0 -0
  215. package/dist/api/types/SupportedLlmProviders.d.ts +11 -0
  216. package/dist/api/types/SupportedLlmProviders.js +13 -0
  217. package/dist/api/types/TenantCreateResponse.d.ts +14 -0
  218. package/dist/api/types/{EmbeddingsSearchData.js → TenantCreateResponse.js} +0 -0
  219. package/dist/api/types/TenantInfo.d.ts +11 -0
  220. package/dist/api/types/{ExtendedContext.js → TenantInfo.js} +0 -0
  221. package/dist/api/types/TenantMetadataSchemaInfo.d.ts +14 -0
  222. package/dist/api/types/{FetchContentData.js → TenantMetadataSchemaInfo.js} +0 -0
  223. package/dist/api/types/TenantStatsResponse.d.ts +14 -0
  224. package/dist/api/types/{FileUploadResult.js → TenantStatsResponse.js} +0 -0
  225. package/dist/api/types/{TripleWithEvidence.d.ts → TripletWithEvidence.d.ts} +4 -1
  226. package/dist/api/types/{GraphRelationsResponse.js → TripletWithEvidence.js} +0 -0
  227. package/dist/api/types/UserAssistantPair.d.ts +3 -0
  228. package/dist/api/types/UserAssistantPair.js +0 -0
  229. package/dist/api/types/ValidationError.d.ts +0 -0
  230. package/dist/api/types/ValidationError.js +0 -0
  231. package/dist/api/types/{SearchChunk.d.ts → VectorStoreChunk.d.ts} +5 -8
  232. package/dist/api/types/{ListSourcesResponse.js → VectorStoreChunk.js} +0 -0
  233. package/dist/api/types/index.d.ts +37 -33
  234. package/dist/api/types/index.js +37 -33
  235. package/dist/core/auth/AuthProvider.d.ts +0 -0
  236. package/dist/core/auth/AuthProvider.js +0 -0
  237. package/dist/core/auth/AuthRequest.d.ts +0 -0
  238. package/dist/core/auth/AuthRequest.js +0 -0
  239. package/dist/core/auth/BasicAuth.d.ts +0 -0
  240. package/dist/core/auth/BasicAuth.js +0 -0
  241. package/dist/core/auth/BearerToken.d.ts +0 -0
  242. package/dist/core/auth/BearerToken.js +0 -0
  243. package/dist/core/auth/index.d.ts +0 -0
  244. package/dist/core/auth/index.js +0 -0
  245. package/dist/core/base64.d.ts +0 -0
  246. package/dist/core/base64.js +0 -0
  247. package/dist/core/exports.d.ts +0 -0
  248. package/dist/core/exports.js +0 -0
  249. package/dist/core/fetcher/APIResponse.d.ts +0 -0
  250. package/dist/core/fetcher/APIResponse.js +0 -0
  251. package/dist/core/fetcher/BinaryResponse.d.ts +0 -0
  252. package/dist/core/fetcher/BinaryResponse.js +0 -0
  253. package/dist/core/fetcher/Fetcher.d.ts +0 -0
  254. package/dist/core/fetcher/Fetcher.js +0 -0
  255. package/dist/core/fetcher/Headers.d.ts +0 -0
  256. package/dist/core/fetcher/Headers.js +0 -0
  257. package/dist/core/fetcher/HttpResponsePromise.d.ts +0 -0
  258. package/dist/core/fetcher/HttpResponsePromise.js +0 -0
  259. package/dist/core/fetcher/RawResponse.d.ts +0 -0
  260. package/dist/core/fetcher/RawResponse.js +0 -0
  261. package/dist/core/fetcher/ResponseWithBody.d.ts +0 -0
  262. package/dist/core/fetcher/ResponseWithBody.js +0 -0
  263. package/dist/core/fetcher/Supplier.d.ts +0 -0
  264. package/dist/core/fetcher/Supplier.js +0 -0
  265. package/dist/core/fetcher/createRequestUrl.d.ts +0 -0
  266. package/dist/core/fetcher/createRequestUrl.js +0 -0
  267. package/dist/core/fetcher/getErrorResponseBody.d.ts +0 -0
  268. package/dist/core/fetcher/getErrorResponseBody.js +0 -0
  269. package/dist/core/fetcher/getFetchFn.d.ts +0 -0
  270. package/dist/core/fetcher/getFetchFn.js +0 -0
  271. package/dist/core/fetcher/getHeader.d.ts +0 -0
  272. package/dist/core/fetcher/getHeader.js +0 -0
  273. package/dist/core/fetcher/getRequestBody.d.ts +0 -0
  274. package/dist/core/fetcher/getRequestBody.js +0 -0
  275. package/dist/core/fetcher/getResponseBody.d.ts +0 -0
  276. package/dist/core/fetcher/getResponseBody.js +0 -0
  277. package/dist/core/fetcher/index.d.ts +0 -0
  278. package/dist/core/fetcher/index.js +0 -0
  279. package/dist/core/fetcher/makeRequest.d.ts +0 -0
  280. package/dist/core/fetcher/makeRequest.js +0 -0
  281. package/dist/core/fetcher/requestWithRetries.d.ts +0 -0
  282. package/dist/core/fetcher/requestWithRetries.js +0 -0
  283. package/dist/core/fetcher/signals.d.ts +0 -0
  284. package/dist/core/fetcher/signals.js +0 -0
  285. package/dist/core/file/exports.d.ts +0 -0
  286. package/dist/core/file/exports.js +0 -0
  287. package/dist/core/file/file.d.ts +0 -0
  288. package/dist/core/file/file.js +0 -0
  289. package/dist/core/file/index.d.ts +0 -0
  290. package/dist/core/file/index.js +0 -0
  291. package/dist/core/file/types.d.ts +0 -0
  292. package/dist/core/file/types.js +0 -0
  293. package/dist/core/form-data-utils/FormDataWrapper.d.ts +0 -0
  294. package/dist/core/form-data-utils/FormDataWrapper.js +0 -0
  295. package/dist/core/form-data-utils/encodeAsFormParameter.d.ts +0 -0
  296. package/dist/core/form-data-utils/encodeAsFormParameter.js +0 -0
  297. package/dist/core/form-data-utils/index.d.ts +0 -0
  298. package/dist/core/form-data-utils/index.js +0 -0
  299. package/dist/core/headers.d.ts +0 -0
  300. package/dist/core/headers.js +0 -0
  301. package/dist/core/index.d.ts +0 -0
  302. package/dist/core/index.js +0 -0
  303. package/dist/core/json.d.ts +0 -0
  304. package/dist/core/json.js +0 -0
  305. package/dist/core/runtime/index.d.ts +0 -0
  306. package/dist/core/runtime/index.js +0 -0
  307. package/dist/core/runtime/runtime.d.ts +0 -0
  308. package/dist/core/runtime/runtime.js +0 -0
  309. package/dist/core/url/index.d.ts +0 -0
  310. package/dist/core/url/index.js +0 -0
  311. package/dist/core/url/join.d.ts +0 -0
  312. package/dist/core/url/join.js +0 -0
  313. package/dist/core/url/qs.d.ts +0 -0
  314. package/dist/core/url/qs.js +0 -0
  315. package/dist/environments.d.ts +0 -0
  316. package/dist/environments.js +0 -0
  317. package/dist/errors/CortexAIError.d.ts +0 -0
  318. package/dist/errors/CortexAIError.js +0 -0
  319. package/dist/errors/CortexAITimeoutError.d.ts +0 -0
  320. package/dist/errors/CortexAITimeoutError.js +0 -0
  321. package/dist/errors/index.d.ts +0 -0
  322. package/dist/errors/index.js +0 -0
  323. package/dist/exports.d.ts +0 -0
  324. package/dist/exports.js +0 -0
  325. package/dist/index.d.ts +0 -0
  326. package/dist/index.js +0 -0
  327. package/package.json +31 -34
  328. package/dist/api/resources/document/client/Client.d.ts +0 -59
  329. package/dist/api/resources/document/client/Client.js +0 -132
  330. package/dist/api/resources/document/client/index.d.ts +0 -1
  331. package/dist/api/resources/embeddings/client/requests/EmbeddingsCreateCollectionRequest.d.ts +0 -13
  332. package/dist/api/resources/embeddings/client/requests/EmbeddingsSearchRequest.d.ts +0 -18
  333. package/dist/api/resources/embeddings/client/requests/GetEmbeddingsBasedOnChunkIdsRequest.d.ts +0 -18
  334. package/dist/api/resources/fetch/client/requests/FetchContentRequest.d.ts +0 -18
  335. package/dist/api/resources/search/client/requests/QnARequest.d.ts +0 -47
  336. package/dist/api/resources/sources/client/requests/SourceBodyParams.d.ts +0 -18
  337. package/dist/api/resources/tenant/client/requests/TenantDeleteSubTenantRequest.d.ts +0 -14
  338. package/dist/api/resources/tenant/client/requests/TenantGetSubTenantIdsRequest.d.ts +0 -12
  339. package/dist/api/resources/upload/client/requests/BodyBatchUpdateUploadBatchUpdatePatch.d.ts +0 -37
  340. package/dist/api/resources/upload/client/requests/BodyBatchUploadUploadBatchUploadPost.d.ts +0 -37
  341. package/dist/api/resources/upload/client/requests/BodyUpdateFileUploadUpdateDocumentPatch.d.ts +0 -38
  342. package/dist/api/resources/upload/client/requests/BodyUploadFilesUploadUploadDocumentPost.d.ts +0 -37
  343. package/dist/api/resources/upload/client/requests/EmbeddingsUpdateRequest.d.ts +0 -18
  344. package/dist/api/resources/upload/client/requests/EmbeddingsUploadRequest.d.ts +0 -21
  345. package/dist/api/resources/upload/client/requests/UploadBatchScrapeWebpageRequest.d.ts +0 -22
  346. package/dist/api/resources/upload/client/requests/UploadBatchUploadMarkdownRequest.d.ts +0 -22
  347. package/dist/api/resources/upload/client/requests/UploadBatchUploadTextRequest.d.ts +0 -22
  348. package/dist/api/resources/upload/client/requests/UploadScrapeWebpageRequest.d.ts +0 -25
  349. package/dist/api/resources/upload/client/requests/UploadUpdateMarkdownRequest.d.ts +0 -24
  350. package/dist/api/resources/upload/client/requests/UploadUpdateWebpageRequest.d.ts +0 -25
  351. package/dist/api/resources/upload/client/requests/UploadUploadAppSourcesRequest.d.ts +0 -20
  352. package/dist/api/resources/upload/client/requests/UploadUploadTextRequest.d.ts +0 -21
  353. package/dist/api/resources/user/client/Client.d.ts +0 -60
  354. package/dist/api/resources/user/client/Client.js +0 -152
  355. package/dist/api/resources/user/client/requests/BodyCreateTenantUserCreateTenantPost.d.ts +0 -15
  356. package/dist/api/resources/user/client/requests/index.d.ts +0 -1
  357. package/dist/api/resources/user/client/requests/index.js +0 -2
  358. package/dist/api/resources/user/index.d.ts +0 -1
  359. package/dist/api/resources/user/index.js +0 -17
  360. package/dist/api/resources/userMemory/client/Client.d.ts +0 -150
  361. package/dist/api/resources/userMemory/client/index.d.ts +0 -2
  362. package/dist/api/resources/userMemory/client/index.js +0 -17
  363. package/dist/api/resources/userMemory/client/requests/AddUserMemoryRequest.d.ts +0 -27
  364. package/dist/api/resources/userMemory/client/requests/RetrieveUserMemoryRequest.d.ts +0 -24
  365. package/dist/api/resources/userMemory/client/requests/UserMemoryDeleteUserMemoryRequest.d.ts +0 -19
  366. package/dist/api/resources/userMemory/client/requests/UserMemoryListUserMemoriesRequest.d.ts +0 -16
  367. package/dist/api/resources/userMemory/client/requests/index.d.ts +0 -4
  368. package/dist/api/resources/userMemory/client/requests/index.js +0 -2
  369. package/dist/api/resources/userMemory/index.d.ts +0 -1
  370. package/dist/api/resources/userMemory/index.js +0 -17
  371. package/dist/api/types/AddUserMemoryResponse.d.ts +0 -16
  372. package/dist/api/types/BatchUploadData.d.ts +0 -11
  373. package/dist/api/types/BodyScrapeWebpageUploadScrapeWebpagePost.d.ts +0 -5
  374. package/dist/api/types/BodyUpdateScrapeJobUploadUpdateWebpagePatch.d.ts +0 -5
  375. package/dist/api/types/ChunkGraphRelationsResponse.d.ts +0 -13
  376. package/dist/api/types/DeleteMemoryRequest.d.ts +0 -11
  377. package/dist/api/types/DeleteSources.d.ts +0 -7
  378. package/dist/api/types/DeleteSubTenantData.d.ts +0 -15
  379. package/dist/api/types/EmbeddingsCreateCollectionData.d.ts +0 -13
  380. package/dist/api/types/EmbeddingsDeleteData.d.ts +0 -13
  381. package/dist/api/types/EmbeddingsGetData.d.ts +0 -13
  382. package/dist/api/types/EmbeddingsSearchData.d.ts +0 -13
  383. package/dist/api/types/ExtendedContext.d.ts +0 -5
  384. package/dist/api/types/FetchContentData.d.ts +0 -13
  385. package/dist/api/types/FileUploadResult.d.ts +0 -9
  386. package/dist/api/types/ListSourcesResponse.d.ts +0 -12
  387. package/dist/api/types/ListUserMemoriesResponse.d.ts +0 -13
  388. package/dist/api/types/ListUserMemoriesResponse.js +0 -5
  389. package/dist/api/types/MarkdownUploadRequest.d.ts +0 -22
  390. package/dist/api/types/MarkdownUploadRequest.js +0 -5
  391. package/dist/api/types/RelatedChunk.d.ts +0 -9
  392. package/dist/api/types/RelatedChunk.js +0 -5
  393. package/dist/api/types/Relations.d.ts +0 -9
  394. package/dist/api/types/Relations.js +0 -5
  395. package/dist/api/types/RetrieveResponse.d.ts +0 -12
  396. package/dist/api/types/RetrieveResponse.js +0 -5
  397. package/dist/api/types/RetrieveUserMemoryResponse.d.ts +0 -15
  398. package/dist/api/types/RetrieveUserMemoryResponse.js +0 -5
  399. package/dist/api/types/ScoredTripletResponse.d.ts +0 -17
  400. package/dist/api/types/ScoredTripletResponse.js +0 -5
  401. package/dist/api/types/SearchChunk.js +0 -5
  402. package/dist/api/types/SingleUploadData.d.ts +0 -10
  403. package/dist/api/types/SingleUploadData.js +0 -5
  404. package/dist/api/types/Source.d.ts +0 -19
  405. package/dist/api/types/Source.js +0 -5
  406. package/dist/api/types/SubTenantIdsData.d.ts +0 -17
  407. package/dist/api/types/SubTenantIdsData.js +0 -5
  408. package/dist/api/types/TenantCreateData.d.ts +0 -13
  409. package/dist/api/types/TenantCreateData.js +0 -5
  410. package/dist/api/types/TenantStats.d.ts +0 -15
  411. package/dist/api/types/TenantStats.js +0 -5
  412. package/dist/api/types/TripleWithEvidence.js +0 -5
  413. package/dist/api/types/UserMemory.d.ts +0 -12
  414. package/dist/api/types/UserMemory.js +0 -5
  415. package/dist/api/types/WebpageScrapeRequest.d.ts +0 -9
  416. package/dist/api/types/WebpageScrapeRequest.js +0 -5
package/LICENSE CHANGED
@@ -1,24 +1,24 @@
1
- Copyright (c) 2024 Cortex AI
2
-
3
- All Rights Reserved.
4
-
5
- PROPRIETARY AND CONFIDENTIAL
6
-
7
- This software is the proprietary and confidential property of Cortex AI ("the Company").
8
- Permission is hereby granted to authorized users to install and use this software as part of the Cortex AI service, subject to the terms and conditions of the service agreement entered into with the Company.
9
-
10
- You may not, without the express written permission of the Company:
11
-
12
- Copy, modify, or create derivative works of the software.
13
-
14
- Distribute, sell, rent, lease, sublicense, or otherwise transfer the software to any third party.
15
-
16
- Reverse engineer, decompile, or disassemble the software, except and only to the extent that such activity is expressly permitted by applicable law notwithstanding this limitation.
17
-
18
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
1
+ Copyright (c) 2024 Cortex AI
2
+
3
+ All Rights Reserved.
4
+
5
+ PROPRIETARY AND CONFIDENTIAL
6
+
7
+ This software is the proprietary and confidential property of Cortex AI ("the Company").
8
+ Permission is hereby granted to authorized users to install and use this software as part of the Cortex AI service, subject to the terms and conditions of the service agreement entered into with the Company.
9
+
10
+ You may not, without the express written permission of the Company:
11
+
12
+ Copy, modify, or create derivative works of the software.
13
+
14
+ Distribute, sell, rent, lease, sublicense, or otherwise transfer the software to any third party.
15
+
16
+ Reverse engineer, decompile, or disassemble the software, except and only to the extent that such activity is expressly permitted by applicable law notwithstanding this limitation.
17
+
18
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24
24
  SOFTWARE.
package/README.md CHANGED
@@ -1,141 +1,141 @@
1
- # Cortex AI TypeScript SDK
2
-
3
- The official TypeScript SDK for the Cortex AI platform. Build powerful, context-aware AI applications in your Node.js or TypeScript projects.
4
-
5
- **Cortex** is your plug-and-play memory infrastructure. It powers intelligent, context-aware retrieval for any AI app or agent. Whether you’re building a customer support bot, research copilot, or internal knowledge assistant - Cortex handles all!
6
-
7
- [Learn more about the SDK from our docs](https://docs.usecortex.ai/)
8
-
9
- ## Core features
10
-
11
- * **Dynamic retrieval and querying** that always retrieve the most relevant context
12
- * **Built-in long-term memory** that evolves with every user interaction
13
- * **Personalization hooks** for user preferences, intent, and history
14
- * **Developer-first SDK** with the most flexible APIs and fine-grained controls
15
-
16
- ## Getting started
17
-
18
- ### Installation
19
-
20
- ```
21
- npm i @usecortex_ai/node
22
- # or
23
- yarn add @usecortex_ai/node
24
- # or
25
- pnpm add @usecortex_ai/node
26
- ```
27
-
28
- ### Client setup
29
-
30
- ```ts
31
- import { CortexAIClient } from "@usecortex_ai/node";
32
-
33
- const client = new CortexAIClient({
34
- token: process.env.CORTEX_API_KEY,
35
- });
36
- ```
37
-
38
- ### Create a Tenant
39
-
40
- You can consider a `tenant` as a single database that can have internal isolated collections called `sub-tenants`. [Know more about the concept of tenant here](https://docs.usecortex.ai/essentials/multi-tenant)
41
-
42
- ```ts
43
- async function createTenant() {
44
- const tenantCreationResponse = await client.user.createTenant({
45
- tenant_id: "my-company"
46
- });
47
- return tenantCreationResponse;
48
- }
49
- ```
50
-
51
- ### Index Your Data
52
-
53
- When you index your data, you make it ready for retrieval from Cortex using natural language.
54
-
55
- ```ts
56
- // Upload text content
57
- async function uploadText() {
58
- const res = await client.upload.uploadText({
59
- tenant_id: "my-company",
60
- sub_tenant_id: "engineering",
61
- body: {
62
- content: "Our API rate limits are 1000 requests per minute for premium accounts.",
63
- file_id: "api-docs-rate-limits",
64
- tenant_metadata: { sub_tenant_id: "engineering" }
65
- }
66
- });
67
- return res;
68
- }
69
-
70
- // Upload a document file
71
- async function uploadFile() {
72
- const uploadResult = await client.upload.uploadDocument({
73
- file: fs.readFileSync("company-handbook.pdf"),
74
- tenant_id: "my-company",
75
- sub_tenant_id: "hr",
76
- file_id: "doc_q1_summary"
77
- });
78
- return uploadResult;
79
- }
80
- ```
81
-
82
- > **For a more detailed explanation** of document upload, including supported file formats, processing pipeline, metadata handling, and advanced configuration options, refer to the [Upload Document endpoint documentation](https://docs.usecortex.ai/api-reference/endpoint/upload-document).
83
-
84
- ### Search and retrieval
85
-
86
- ```ts
87
- // Semantic search with retrieval
88
- const results = await client.search.retrieve({
89
- query: "What are the API rate limits?",
90
- tenant_id: "my-company",
91
- sub_tenant_id: "engineering",
92
- max_chunks: 10
93
- });
94
-
95
- // List all sources
96
- const allSources = await client.sources.getAll({
97
- tenant_id: "my-company",
98
- sub_tenant_id: "engineering"
99
- });
100
-
101
- // Get specific sources by ID
102
- const specificSources = await client.sources.getByIds({
103
- tenant_id: "my-company",
104
- sub_tenant_id: "engineering",
105
- source_ids: ["api-docs-rate-limits", "company-handbook"]
106
- });
107
- ```
108
-
109
- > **For a more detailed explanation** of search and retrieval, including query parameters, scoring mechanisms, result structure, and advanced search features, refer to the [Search endpoint documentation](https://docs.usecortex.ai/api-reference/endpoint/search).
110
-
111
- ## SDK Method Structure & Type Safety
112
-
113
- Our SDKs follow a predictable pattern that mirrors the API structure while providing full type safety.
114
-
115
- > **Method Mapping** : `client.<group>.<functionName>` mirrors `api.usecortex.ai/<group>/<function_name>`
116
- >
117
- > For example: `client.upload.uploadText()` corresponds to `POST /upload/upload_text`
118
-
119
- The SDKs provide exact type parity with the API specification:
120
-
121
- - **Request Parameters** : Every field documented in the API reference (required, optional, types, validation rules) is reflected in the SDK method signatures
122
- - **Response Objects** : Return types match the exact JSON schema documented for each endpoint
123
- - **Error Types** : Exception structures mirror the error response formats from the API
124
- - **Nested Objects** : Complex nested parameters and responses maintain their full structure and typing
125
-
126
- > This means you can rely on your IDE’s autocomplete and type checking. If a parameter is optional in the API docs, it’s optional in the SDK. If a response contains a specific field, your IDE will know about it. Our SDKs are built in such a way that your IDE will automatically provide **autocompletion, type-checking, inline documentation with examples, and compile time validation** for each and every method.
127
- >
128
- > Just hit **Cmd+Space/Ctrl+Space!**
129
-
130
- ## Links
131
-
132
- - **Homepage:** [usecortex.ai](https://www.usecortex.ai/)
133
- - **Documentation:** [docs.usecortex.ai](https://docs.usecortex.ai/)
134
-
135
- ## Our docs
136
-
137
- Please refer to our [API reference](https://docs.usecortex.ai/api-reference/introduction) for detailed explanations of every API endpoint, parameter options, and advanced use cases.
138
-
139
- ## Support
140
-
141
- If you have any questions or need help, please reach out to our support team at [founders@usecortex.ai](mailto:founders@usecortex.ai).
1
+ # Cortex AI TypeScript SDK
2
+
3
+ The official TypeScript SDK for the Cortex AI platform. Build powerful, context-aware AI applications in your Node.js or TypeScript projects.
4
+
5
+ **Cortex** is your plug-and-play memory infrastructure. It powers intelligent, context-aware retrieval for any AI app or agent. Whether you’re building a customer support bot, research copilot, or internal knowledge assistant - Cortex handles all!
6
+
7
+ [Learn more about the SDK from our docs](https://docs.usecortex.ai/)
8
+
9
+ ## Core features
10
+
11
+ * **Dynamic retrieval and querying** that always retrieve the most relevant context
12
+ * **Built-in long-term memory** that evolves with every user interaction
13
+ * **Personalization hooks** for user preferences, intent, and history
14
+ * **Developer-first SDK** with the most flexible APIs and fine-grained controls
15
+
16
+ ## Getting started
17
+
18
+ ### Installation
19
+
20
+ ```
21
+ npm i @usecortex_ai/node
22
+ # or
23
+ yarn add @usecortex_ai/node
24
+ # or
25
+ pnpm add @usecortex_ai/node
26
+ ```
27
+
28
+ ### Client setup
29
+
30
+ ```ts
31
+ import { CortexAIClient } from "@usecortex_ai/node";
32
+
33
+ const client = new CortexAIClient({
34
+ token: process.env.CORTEX_API_KEY,
35
+ });
36
+ ```
37
+
38
+ ### Create a Tenant
39
+
40
+ You can consider a `tenant` as a single database that can have internal isolated collections called `sub-tenants`. [Know more about the concept of tenant here](https://docs.usecortex.ai/essentials/multi-tenant)
41
+
42
+ ```ts
43
+ async function createTenant() {
44
+ const tenantCreationResponse = await client.user.createTenant({
45
+ tenant_id: "my-company"
46
+ });
47
+ return tenantCreationResponse;
48
+ }
49
+ ```
50
+
51
+ ### Index Your Data
52
+
53
+ When you index your data, you make it ready for retrieval from Cortex using natural language.
54
+
55
+ ```ts
56
+ // Upload text content
57
+ async function uploadText() {
58
+ const res = await client.upload.uploadText({
59
+ tenant_id: "my-company",
60
+ sub_tenant_id: "engineering",
61
+ body: {
62
+ content: "Our API rate limits are 1000 requests per minute for premium accounts.",
63
+ file_id: "api-docs-rate-limits",
64
+ tenant_metadata: { sub_tenant_id: "engineering" }
65
+ }
66
+ });
67
+ return res;
68
+ }
69
+
70
+ // Upload a document file
71
+ async function uploadFile() {
72
+ const uploadResult = await client.upload.uploadDocument({
73
+ file: fs.readFileSync("company-handbook.pdf"),
74
+ tenant_id: "my-company",
75
+ sub_tenant_id: "hr",
76
+ file_id: "doc_q1_summary"
77
+ });
78
+ return uploadResult;
79
+ }
80
+ ```
81
+
82
+ > **For a more detailed explanation** of document upload, including supported file formats, processing pipeline, metadata handling, and advanced configuration options, refer to the [Upload Document endpoint documentation](https://docs.usecortex.ai/api-reference/endpoint/upload-document).
83
+
84
+ ### Search and retrieval
85
+
86
+ ```ts
87
+ // Semantic search with retrieval
88
+ const results = await client.search.retrieve({
89
+ query: "What are the API rate limits?",
90
+ tenant_id: "my-company",
91
+ sub_tenant_id: "engineering",
92
+ max_chunks: 10
93
+ });
94
+
95
+ // List all sources
96
+ const allSources = await client.sources.getAll({
97
+ tenant_id: "my-company",
98
+ sub_tenant_id: "engineering"
99
+ });
100
+
101
+ // Get specific sources by ID
102
+ const specificSources = await client.sources.getByIds({
103
+ tenant_id: "my-company",
104
+ sub_tenant_id: "engineering",
105
+ source_ids: ["api-docs-rate-limits", "company-handbook"]
106
+ });
107
+ ```
108
+
109
+ > **For a more detailed explanation** of search and retrieval, including query parameters, scoring mechanisms, result structure, and advanced search features, refer to the [Search endpoint documentation](https://docs.usecortex.ai/api-reference/endpoint/search).
110
+
111
+ ## SDK Method Structure & Type Safety
112
+
113
+ Our SDKs follow a predictable pattern that mirrors the API structure while providing full type safety.
114
+
115
+ > **Method Mapping** : `client.<group>.<functionName>` mirrors `api.usecortex.ai/<group>/<function_name>`
116
+ >
117
+ > For example: `client.upload.uploadText()` corresponds to `POST /upload/upload_text`
118
+
119
+ The SDKs provide exact type parity with the API specification:
120
+
121
+ - **Request Parameters** : Every field documented in the API reference (required, optional, types, validation rules) is reflected in the SDK method signatures
122
+ - **Response Objects** : Return types match the exact JSON schema documented for each endpoint
123
+ - **Error Types** : Exception structures mirror the error response formats from the API
124
+ - **Nested Objects** : Complex nested parameters and responses maintain their full structure and typing
125
+
126
+ > This means you can rely on your IDE’s autocomplete and type checking. If a parameter is optional in the API docs, it’s optional in the SDK. If a response contains a specific field, your IDE will know about it. Our SDKs are built in such a way that your IDE will automatically provide **autocompletion, type-checking, inline documentation with examples, and compile time validation** for each and every method.
127
+ >
128
+ > Just hit **Cmd+Space/Ctrl+Space!**
129
+
130
+ ## Links
131
+
132
+ - **Homepage:** [usecortex.ai](https://www.usecortex.ai/)
133
+ - **Documentation:** [docs.usecortex.ai](https://docs.usecortex.ai/)
134
+
135
+ ## Our docs
136
+
137
+ Please refer to our [API reference](https://docs.usecortex.ai/api-reference/introduction) for detailed explanations of every API endpoint, parameter options, and advanced use cases.
138
+
139
+ ## Support
140
+
141
+ If you have any questions or need help, please reach out to our support team at [founders@usecortex.ai](mailto:founders@usecortex.ai).
package/dist/Client.d.ts CHANGED
@@ -3,15 +3,13 @@
3
3
  */
4
4
  import * as environments from "./environments.js";
5
5
  import * as core from "./core/index.js";
6
- import { Search } from "./api/resources/search/client/Client.js";
7
- import { Sources } from "./api/resources/sources/client/Client.js";
8
- import { UserMemory } from "./api/resources/userMemory/client/Client.js";
9
- import { Fetch } from "./api/resources/fetch/client/Client.js";
10
6
  import { Upload } from "./api/resources/upload/client/Client.js";
11
- import { Embeddings } from "./api/resources/embeddings/client/Client.js";
12
- import { User } from "./api/resources/user/client/Client.js";
13
7
  import { Tenant } from "./api/resources/tenant/client/Client.js";
14
- import { Document } from "./api/resources/document/client/Client.js";
8
+ import { Embeddings } from "./api/resources/embeddings/client/Client.js";
9
+ import { Fetch } from "./api/resources/fetch/client/Client.js";
10
+ import { Sources } from "./api/resources/sources/client/Client.js";
11
+ import { Search } from "./api/resources/search/client/Client.js";
12
+ import { Dashboard } from "./api/resources/dashboard/client/Client.js";
15
13
  export declare namespace CortexAIClient {
16
14
  interface Options {
17
15
  environment?: core.Supplier<environments.CortexAIEnvironment | string>;
@@ -36,32 +34,30 @@ export declare namespace CortexAIClient {
36
34
  }
37
35
  export declare class CortexAIClient {
38
36
  protected readonly _options: CortexAIClient.Options;
39
- protected _search: Search | undefined;
40
- protected _sources: Sources | undefined;
41
- protected _userMemory: UserMemory | undefined;
42
- protected _fetch: Fetch | undefined;
43
37
  protected _upload: Upload | undefined;
44
- protected _embeddings: Embeddings | undefined;
45
- protected _user: User | undefined;
46
38
  protected _tenant: Tenant | undefined;
47
- protected _document: Document | undefined;
39
+ protected _embeddings: Embeddings | undefined;
40
+ protected _fetch: Fetch | undefined;
41
+ protected _sources: Sources | undefined;
42
+ protected _search: Search | undefined;
43
+ protected _dashboard: Dashboard | undefined;
48
44
  constructor(_options?: CortexAIClient.Options);
49
- get search(): Search;
50
- get sources(): Sources;
51
- get userMemory(): UserMemory;
52
- get fetch(): Fetch;
53
45
  get upload(): Upload;
54
- get embeddings(): Embeddings;
55
- get user(): User;
56
46
  get tenant(): Tenant;
57
- get document(): Document;
47
+ get embeddings(): Embeddings;
48
+ get fetch(): Fetch;
49
+ get sources(): Sources;
50
+ get search(): Search;
51
+ get dashboard(): Dashboard;
58
52
  /**
53
+ * Endpoint that serves Prometheus metrics.
54
+ *
59
55
  * @param {CortexAIClient.RequestOptions} requestOptions - Request-specific configuration.
60
56
  *
61
57
  * @example
62
- * await client.rootGet()
58
+ * await client.metricsMetricsGet()
63
59
  */
64
- rootGet(requestOptions?: CortexAIClient.RequestOptions): core.HttpResponsePromise<unknown>;
65
- private __rootGet;
60
+ metricsMetricsGet(requestOptions?: CortexAIClient.RequestOptions): core.HttpResponsePromise<unknown>;
61
+ private __metricsMetricsGet;
66
62
  protected _getAuthorizationHeader(): Promise<string | undefined>;
67
63
  }
package/dist/Client.js CHANGED
@@ -31,15 +31,13 @@ const environments = __importStar(require("./environments.js"));
31
31
  const core = __importStar(require("./core/index.js"));
32
32
  const headers_js_1 = require("./core/headers.js");
33
33
  const errors = __importStar(require("./errors/index.js"));
34
- const Client_js_1 = require("./api/resources/search/client/Client.js");
35
- const Client_js_2 = require("./api/resources/sources/client/Client.js");
36
- const Client_js_3 = require("./api/resources/userMemory/client/Client.js");
34
+ const Client_js_1 = require("./api/resources/upload/client/Client.js");
35
+ const Client_js_2 = require("./api/resources/tenant/client/Client.js");
36
+ const Client_js_3 = require("./api/resources/embeddings/client/Client.js");
37
37
  const Client_js_4 = require("./api/resources/fetch/client/Client.js");
38
- const Client_js_5 = require("./api/resources/upload/client/Client.js");
39
- const Client_js_6 = require("./api/resources/embeddings/client/Client.js");
40
- const Client_js_7 = require("./api/resources/user/client/Client.js");
41
- const Client_js_8 = require("./api/resources/tenant/client/Client.js");
42
- const Client_js_9 = require("./api/resources/document/client/Client.js");
38
+ const Client_js_5 = require("./api/resources/sources/client/Client.js");
39
+ const Client_js_6 = require("./api/resources/search/client/Client.js");
40
+ const Client_js_7 = require("./api/resources/dashboard/client/Client.js");
43
41
  class CortexAIClient {
44
42
  constructor(_options = {}) {
45
43
  this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_js_1.mergeHeaders)({
@@ -48,56 +46,50 @@ class CortexAIClient {
48
46
  "X-Fern-Runtime-Version": core.RUNTIME.version,
49
47
  }, _options === null || _options === void 0 ? void 0 : _options.headers) });
50
48
  }
51
- get search() {
49
+ get upload() {
52
50
  var _a;
53
- return ((_a = this._search) !== null && _a !== void 0 ? _a : (this._search = new Client_js_1.Search(this._options)));
51
+ return ((_a = this._upload) !== null && _a !== void 0 ? _a : (this._upload = new Client_js_1.Upload(this._options)));
54
52
  }
55
- get sources() {
53
+ get tenant() {
56
54
  var _a;
57
- return ((_a = this._sources) !== null && _a !== void 0 ? _a : (this._sources = new Client_js_2.Sources(this._options)));
55
+ return ((_a = this._tenant) !== null && _a !== void 0 ? _a : (this._tenant = new Client_js_2.Tenant(this._options)));
58
56
  }
59
- get userMemory() {
57
+ get embeddings() {
60
58
  var _a;
61
- return ((_a = this._userMemory) !== null && _a !== void 0 ? _a : (this._userMemory = new Client_js_3.UserMemory(this._options)));
59
+ return ((_a = this._embeddings) !== null && _a !== void 0 ? _a : (this._embeddings = new Client_js_3.Embeddings(this._options)));
62
60
  }
63
61
  get fetch() {
64
62
  var _a;
65
63
  return ((_a = this._fetch) !== null && _a !== void 0 ? _a : (this._fetch = new Client_js_4.Fetch(this._options)));
66
64
  }
67
- get upload() {
68
- var _a;
69
- return ((_a = this._upload) !== null && _a !== void 0 ? _a : (this._upload = new Client_js_5.Upload(this._options)));
70
- }
71
- get embeddings() {
72
- var _a;
73
- return ((_a = this._embeddings) !== null && _a !== void 0 ? _a : (this._embeddings = new Client_js_6.Embeddings(this._options)));
74
- }
75
- get user() {
65
+ get sources() {
76
66
  var _a;
77
- return ((_a = this._user) !== null && _a !== void 0 ? _a : (this._user = new Client_js_7.User(this._options)));
67
+ return ((_a = this._sources) !== null && _a !== void 0 ? _a : (this._sources = new Client_js_5.Sources(this._options)));
78
68
  }
79
- get tenant() {
69
+ get search() {
80
70
  var _a;
81
- return ((_a = this._tenant) !== null && _a !== void 0 ? _a : (this._tenant = new Client_js_8.Tenant(this._options)));
71
+ return ((_a = this._search) !== null && _a !== void 0 ? _a : (this._search = new Client_js_6.Search(this._options)));
82
72
  }
83
- get document() {
73
+ get dashboard() {
84
74
  var _a;
85
- return ((_a = this._document) !== null && _a !== void 0 ? _a : (this._document = new Client_js_9.Document(this._options)));
75
+ return ((_a = this._dashboard) !== null && _a !== void 0 ? _a : (this._dashboard = new Client_js_7.Dashboard(this._options)));
86
76
  }
87
77
  /**
78
+ * Endpoint that serves Prometheus metrics.
79
+ *
88
80
  * @param {CortexAIClient.RequestOptions} requestOptions - Request-specific configuration.
89
81
  *
90
82
  * @example
91
- * await client.rootGet()
83
+ * await client.metricsMetricsGet()
92
84
  */
93
- rootGet(requestOptions) {
94
- return core.HttpResponsePromise.fromPromise(this.__rootGet(requestOptions));
85
+ metricsMetricsGet(requestOptions) {
86
+ return core.HttpResponsePromise.fromPromise(this.__metricsMetricsGet(requestOptions));
95
87
  }
96
- async __rootGet(requestOptions) {
88
+ async __metricsMetricsGet(requestOptions) {
97
89
  var _a, _b, _c;
98
90
  let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: await this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
99
91
  const _response = await core.fetcher({
100
- url: (_c = (_b = (await core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (await core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CortexAIEnvironment.CortexProd,
92
+ url: core.url.join((_c = (_b = (await core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (await core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CortexAIEnvironment.CortexProd, "metrics"),
101
93
  method: "GET",
102
94
  headers: _headers,
103
95
  queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
@@ -123,7 +115,7 @@ class CortexAIClient {
123
115
  rawResponse: _response.rawResponse,
124
116
  });
125
117
  case "timeout":
126
- throw new errors.CortexAITimeoutError("Timeout exceeded when calling GET /.");
118
+ throw new errors.CortexAITimeoutError("Timeout exceeded when calling GET /metrics.");
127
119
  case "unknown":
128
120
  throw new errors.CortexAIError({
129
121
  message: _response.error.errorMessage,
@@ -2,8 +2,7 @@
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
4
  import * as errors from "../../errors/index.js";
5
- import * as CortexAI from "../index.js";
6
5
  import * as core from "../../core/index.js";
7
6
  export declare class BadRequestError extends errors.CortexAIError {
8
- constructor(body: CortexAI.ActualErrorResponse, rawResponse?: core.RawResponse);
7
+ constructor(body?: unknown, rawResponse?: core.RawResponse);
9
8
  }
File without changes
@@ -2,8 +2,7 @@
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
4
  import * as errors from "../../errors/index.js";
5
- import * as CortexAI from "../index.js";
6
5
  import * as core from "../../core/index.js";
7
6
  export declare class ForbiddenError extends errors.CortexAIError {
8
- constructor(body: CortexAI.ActualErrorResponse, rawResponse?: core.RawResponse);
7
+ constructor(body?: unknown, rawResponse?: core.RawResponse);
9
8
  }
File without changes
@@ -2,8 +2,7 @@
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
4
  import * as errors from "../../errors/index.js";
5
- import * as CortexAI from "../index.js";
6
5
  import * as core from "../../core/index.js";
7
6
  export declare class InternalServerError extends errors.CortexAIError {
8
- constructor(body: CortexAI.ActualErrorResponse, rawResponse?: core.RawResponse);
7
+ constructor(body?: unknown, rawResponse?: core.RawResponse);
9
8
  }
File without changes
@@ -2,8 +2,7 @@
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
4
  import * as errors from "../../errors/index.js";
5
- import * as CortexAI from "../index.js";
6
5
  import * as core from "../../core/index.js";
7
6
  export declare class NotFoundError extends errors.CortexAIError {
8
- constructor(body: CortexAI.ActualErrorResponse, rawResponse?: core.RawResponse);
7
+ constructor(body?: unknown, rawResponse?: core.RawResponse);
9
8
  }
File without changes
@@ -2,8 +2,7 @@
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
4
  import * as errors from "../../errors/index.js";
5
- import * as CortexAI from "../index.js";
6
5
  import * as core from "../../core/index.js";
7
6
  export declare class ServiceUnavailableError extends errors.CortexAIError {
8
- constructor(body: CortexAI.ActualErrorResponse, rawResponse?: core.RawResponse);
7
+ constructor(body?: unknown, rawResponse?: core.RawResponse);
9
8
  }
File without changes
@@ -0,0 +1,9 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as errors from "../../errors/index.js";
5
+ import * as CortexAI from "../index.js";
6
+ import * as core from "../../core/index.js";
7
+ export declare class TooManyRequestsError extends errors.CortexAIError {
8
+ constructor(body: CortexAI.ActualErrorResponse, rawResponse?: core.RawResponse);
9
+ }
@@ -0,0 +1,42 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
6
+ if (k2 === undefined) k2 = k;
7
+ var desc = Object.getOwnPropertyDescriptor(m, k);
8
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
9
+ desc = { enumerable: true, get: function() { return m[k]; } };
10
+ }
11
+ Object.defineProperty(o, k2, desc);
12
+ }) : (function(o, m, k, k2) {
13
+ if (k2 === undefined) k2 = k;
14
+ o[k2] = m[k];
15
+ }));
16
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
17
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
18
+ }) : function(o, v) {
19
+ o["default"] = v;
20
+ });
21
+ var __importStar = (this && this.__importStar) || function (mod) {
22
+ if (mod && mod.__esModule) return mod;
23
+ var result = {};
24
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
25
+ __setModuleDefault(result, mod);
26
+ return result;
27
+ };
28
+ Object.defineProperty(exports, "__esModule", { value: true });
29
+ exports.TooManyRequestsError = void 0;
30
+ const errors = __importStar(require("../../errors/index.js"));
31
+ class TooManyRequestsError extends errors.CortexAIError {
32
+ constructor(body, rawResponse) {
33
+ super({
34
+ message: "TooManyRequestsError",
35
+ statusCode: 429,
36
+ body: body,
37
+ rawResponse: rawResponse,
38
+ });
39
+ Object.setPrototypeOf(this, TooManyRequestsError.prototype);
40
+ }
41
+ }
42
+ exports.TooManyRequestsError = TooManyRequestsError;
@@ -2,8 +2,7 @@
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
4
  import * as errors from "../../errors/index.js";
5
- import * as CortexAI from "../index.js";
6
5
  import * as core from "../../core/index.js";
7
6
  export declare class UnauthorizedError extends errors.CortexAIError {
8
- constructor(body: CortexAI.ActualErrorResponse, rawResponse?: core.RawResponse);
7
+ constructor(body?: unknown, rawResponse?: core.RawResponse);
9
8
  }
File without changes
File without changes
File without changes