@nestbox-ai/documents 1.0.39 → 1.0.47

package/.openapi-generator/FILES

@@ -5,6 +5,19 @@ api.ts
 base.ts
 common.ts
 configuration.ts
+docs/AppApi.md
+docs/BadRequestExceptionResponse.md
+docs/ChunkFileRequestDTO.md
+docs/CollectionApi.md
+docs/CreateCollectionRequestDTO.md
+docs/CreateDocumentRequestDTO.md
+docs/FatalErrorExceptionResponse.md
+docs/ForbiddenExceptionResponse.md
+docs/MessageResponseDTO.md
+docs/NotFoundExceptionResponse.md
+docs/SimilaritySearchQueryDTO.md
+docs/UnauthorizedExceptionResponse.md
+docs/UpdateDocumentRequestDTO.md
 git_push.sh
 index.ts
 package.json

package/.openapi-generator/VERSION

@@ -1 +1 @@
-7.12.0
+7.14.0

package/README.md

@@ -1,4 +1,4 @@
-## @nestbox-ai/documents@1.0.39
+## @nestbox-ai/documents@1.0.47
 
 This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @nestbox-ai/documents@1.0.39 --save
+npm install @nestbox-ai/documents@1.0.47 --save
 ```
 
 _unPublished (not recommended):_
@@ -44,3 +44,45 @@ _unPublished (not recommended):_
 ```
 npm install PATH_TO_GENERATED_PACKAGE --save
 ```
+
+### Documentation for API Endpoints
+
+All URIs are relative to *http://localhost*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*AppApi* | [**appControllerGetHello**](docs/AppApi.md#appcontrollergethello) | **GET** / | 
+*CollectionApi* | [**collectionControllerAddDocToCollection**](docs/CollectionApi.md#collectioncontrolleradddoctocollection) | **POST** /collections/{collection_id}/docs | Add a new doc
+*CollectionApi* | [**collectionControllerChunkFileToCollection**](docs/CollectionApi.md#collectioncontrollerchunkfiletocollection) | **POST** /collections/{collection_id}/docs/file | Use a file to chunk and add to collection
+*CollectionApi* | [**collectionControllerCreateCollection**](docs/CollectionApi.md#collectioncontrollercreatecollection) | **POST** /collections | Create a new collection
+*CollectionApi* | [**collectionControllerDeleteCollection**](docs/CollectionApi.md#collectioncontrollerdeletecollection) | **DELETE** /collections/{collection_id} | Delete a collection
+*CollectionApi* | [**collectionControllerDeleteDoc**](docs/CollectionApi.md#collectioncontrollerdeletedoc) | **DELETE** /collections/{collection_id}/docs/{doc_id} | Delete doc by ID
+*CollectionApi* | [**collectionControllerDeleteDocsByMetadata**](docs/CollectionApi.md#collectioncontrollerdeletedocsbymetadata) | **DELETE** /collections/{collection_id}/docs | Delete docs based on metadata filter
+*CollectionApi* | [**collectionControllerGetCollection**](docs/CollectionApi.md#collectioncontrollergetcollection) | **GET** /collections/{collection_id} | Get a collection info
+*CollectionApi* | [**collectionControllerGetCollections**](docs/CollectionApi.md#collectioncontrollergetcollections) | **GET** /collections | List all collections
+*CollectionApi* | [**collectionControllerGetDocById**](docs/CollectionApi.md#collectioncontrollergetdocbyid) | **GET** /collections/{collection_id}/docs/{doc_id} | Retrieve doc by ID
+*CollectionApi* | [**collectionControllerSimilaritySearch**](docs/CollectionApi.md#collectioncontrollersimilaritysearch) | **POST** /collections/{collection_id}/query | Similarity search query
+*CollectionApi* | [**collectionControllerUpdateCollection**](docs/CollectionApi.md#collectioncontrollerupdatecollection) | **PUT** /collections/{collection_id} | Updates a collection
+*CollectionApi* | [**collectionControllerUpdateDoc**](docs/CollectionApi.md#collectioncontrollerupdatedoc) | **PUT** /collections/{collection_id}/docs/{doc_id} | Update or upsert doc
+
+
+### Documentation For Models
+
+ - [BadRequestExceptionResponse](docs/BadRequestExceptionResponse.md)
+ - [ChunkFileRequestDTO](docs/ChunkFileRequestDTO.md)
+ - [CreateCollectionRequestDTO](docs/CreateCollectionRequestDTO.md)
+ - [CreateDocumentRequestDTO](docs/CreateDocumentRequestDTO.md)
+ - [FatalErrorExceptionResponse](docs/FatalErrorExceptionResponse.md)
+ - [ForbiddenExceptionResponse](docs/ForbiddenExceptionResponse.md)
+ - [MessageResponseDTO](docs/MessageResponseDTO.md)
+ - [NotFoundExceptionResponse](docs/NotFoundExceptionResponse.md)
+ - [SimilaritySearchQueryDTO](docs/SimilaritySearchQueryDTO.md)
+ - [UnauthorizedExceptionResponse](docs/UnauthorizedExceptionResponse.md)
+ - [UpdateDocumentRequestDTO](docs/UpdateDocumentRequestDTO.md)
+
+
+<a id="documentation-for-authorization"></a>
+## Documentation For Authorization
+
+Endpoints do not require authorization.
+

package/common.ts

@@ -89,17 +89,17 @@ function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: an
     if (typeof parameter === "object") {
         if (Array.isArray(parameter)) {
             (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key));
-        } 
+        }
         else {
-            Object.keys(parameter).forEach(currentKey => 
+            Object.keys(parameter).forEach(currentKey =>
                 setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`)
             );
         }
-    } 
+    }
     else {
         if (urlSearchParams.has(key)) {
             urlSearchParams.append(key, parameter);
-        } 
+        }
         else {
             urlSearchParams.set(key, parameter);
         }

package/docs/AppApi.md

@@ -0,0 +1,51 @@
+# AppApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**appControllerGetHello**](#appcontrollergethello) | **GET** / | |
+
+# **appControllerGetHello**
+> appControllerGetHello()
+
+
+### Example
+
+```typescript
+import {
+    AppApi,
+    Configuration
+} from '@nestbox-ai/documents';
+
+const configuration = new Configuration();
+const apiInstance = new AppApi(configuration);
+
+const { status, data } = await apiInstance.appControllerGetHello();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

package/docs/BadRequestExceptionResponse.md

@@ -0,0 +1,22 @@
+# BadRequestExceptionResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** |  | [default to 'Bad Request. Check Input']
+**errors** | **object** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { BadRequestExceptionResponse } from '@nestbox-ai/documents';
+
+const instance: BadRequestExceptionResponse = {
+    message,
+    errors,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ChunkFileRequestDTO.md

@@ -0,0 +1,24 @@
+# ChunkFileRequestDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **string** |  | [default to undefined]
+**url** | **string** |  | [default to undefined]
+**_options** | **object** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ChunkFileRequestDTO } from '@nestbox-ai/documents';
+
+const instance: ChunkFileRequestDTO = {
+    type,
+    url,
+    _options,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/CollectionApi.md

@@ -0,0 +1,705 @@
+# CollectionApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**collectionControllerAddDocToCollection**](#collectioncontrolleradddoctocollection) | **POST** /collections/{collection_id}/docs | Add a new doc|
+|[**collectionControllerChunkFileToCollection**](#collectioncontrollerchunkfiletocollection) | **POST** /collections/{collection_id}/docs/file | Use a file to chunk and add to collection|
+|[**collectionControllerCreateCollection**](#collectioncontrollercreatecollection) | **POST** /collections | Create a new collection|
+|[**collectionControllerDeleteCollection**](#collectioncontrollerdeletecollection) | **DELETE** /collections/{collection_id} | Delete a collection|
+|[**collectionControllerDeleteDoc**](#collectioncontrollerdeletedoc) | **DELETE** /collections/{collection_id}/docs/{doc_id} | Delete doc by ID|
+|[**collectionControllerDeleteDocsByMetadata**](#collectioncontrollerdeletedocsbymetadata) | **DELETE** /collections/{collection_id}/docs | Delete docs based on metadata filter|
+|[**collectionControllerGetCollection**](#collectioncontrollergetcollection) | **GET** /collections/{collection_id} | Get a collection info|
+|[**collectionControllerGetCollections**](#collectioncontrollergetcollections) | **GET** /collections | List all collections|
+|[**collectionControllerGetDocById**](#collectioncontrollergetdocbyid) | **GET** /collections/{collection_id}/docs/{doc_id} | Retrieve doc by ID|
+|[**collectionControllerSimilaritySearch**](#collectioncontrollersimilaritysearch) | **POST** /collections/{collection_id}/query | Similarity search query|
+|[**collectionControllerUpdateCollection**](#collectioncontrollerupdatecollection) | **PUT** /collections/{collection_id} | Updates a collection|
+|[**collectionControllerUpdateDoc**](#collectioncontrollerupdatedoc) | **PUT** /collections/{collection_id}/docs/{doc_id} | Update or upsert doc|
+
+# **collectionControllerAddDocToCollection**
+> MessageResponseDTO collectionControllerAddDocToCollection(createDocumentRequestDTO)
+
+
+### Example
+
+```typescript
+import {
+    CollectionApi,
+    Configuration,
+    CreateDocumentRequestDTO
+} from '@nestbox-ai/documents';
+
+const configuration = new Configuration();
+const apiInstance = new CollectionApi(configuration);
+
+let collectionId: string; // (default to undefined)
+let createDocumentRequestDTO: CreateDocumentRequestDTO; //
+
+const { status, data } = await apiInstance.collectionControllerAddDocToCollection(
+    collectionId,
+    createDocumentRequestDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createDocumentRequestDTO** | **CreateDocumentRequestDTO**|  | |
+| **collectionId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**MessageResponseDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+|**400** |  |  -  |
+|**401** |  |  -  |
+|**403** |  |  -  |
+|**404** |  |  -  |
+|**500** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **collectionControllerChunkFileToCollection**
+> MessageResponseDTO collectionControllerChunkFileToCollection(chunkFileRequestDTO)
+
+
+### Example
+
+```typescript
+import {
+    CollectionApi,
+    Configuration,
+    ChunkFileRequestDTO
+} from '@nestbox-ai/documents';
+
+const configuration = new Configuration();
+const apiInstance = new CollectionApi(configuration);
+
+let collectionId: string; // (default to undefined)
+let chunkFileRequestDTO: ChunkFileRequestDTO; //
+
+const { status, data } = await apiInstance.collectionControllerChunkFileToCollection(
+    collectionId,
+    chunkFileRequestDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **chunkFileRequestDTO** | **ChunkFileRequestDTO**|  | |
+| **collectionId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**MessageResponseDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+|**400** |  |  -  |
+|**401** |  |  -  |
+|**403** |  |  -  |
+|**404** |  |  -  |
+|**500** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **collectionControllerCreateCollection**
+> MessageResponseDTO collectionControllerCreateCollection(createCollectionRequestDTO)
+
+
+### Example
+
+```typescript
+import {
+    CollectionApi,
+    Configuration,
+    CreateCollectionRequestDTO
+} from '@nestbox-ai/documents';
+
+const configuration = new Configuration();
+const apiInstance = new CollectionApi(configuration);
+
+let createCollectionRequestDTO: CreateCollectionRequestDTO; //
+
+const { status, data } = await apiInstance.collectionControllerCreateCollection(
+    createCollectionRequestDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createCollectionRequestDTO** | **CreateCollectionRequestDTO**|  | |
+
+
+### Return type
+
+**MessageResponseDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+|**400** |  |  -  |
+|**401** |  |  -  |
+|**403** |  |  -  |
+|**404** |  |  -  |
+|**500** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **collectionControllerDeleteCollection**
+> MessageResponseDTO collectionControllerDeleteCollection()
+
+
+### Example
+
+```typescript
+import {
+    CollectionApi,
+    Configuration
+} from '@nestbox-ai/documents';
+
+const configuration = new Configuration();
+const apiInstance = new CollectionApi(configuration);
+
+let collectionId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.collectionControllerDeleteCollection(
+    collectionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **collectionId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**MessageResponseDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+|**400** |  |  -  |
+|**401** |  |  -  |
+|**403** |  |  -  |
+|**404** |  |  -  |
+|**500** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **collectionControllerDeleteDoc**
+> MessageResponseDTO collectionControllerDeleteDoc()
+
+
+### Example
+
+```typescript
+import {
+    CollectionApi,
+    Configuration
+} from '@nestbox-ai/documents';
+
+const configuration = new Configuration();
+const apiInstance = new CollectionApi(configuration);
+
+let collectionId: string; // (default to undefined)
+let docId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.collectionControllerDeleteDoc(
+    collectionId,
+    docId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **collectionId** | [**string**] |  | defaults to undefined|
+| **docId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**MessageResponseDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+|**400** |  |  -  |
+|**401** |  |  -  |
+|**403** |  |  -  |
+|**404** |  |  -  |
+|**500** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **collectionControllerDeleteDocsByMetadata**
+> MessageResponseDTO collectionControllerDeleteDocsByMetadata()
+
+
+### Example
+
+```typescript
+import {
+    CollectionApi,
+    Configuration
+} from '@nestbox-ai/documents';
+
+const configuration = new Configuration();
+const apiInstance = new CollectionApi(configuration);
+
+let collectionId: string; // (default to undefined)
+let filter: string; // (default to undefined)
+
+const { status, data } = await apiInstance.collectionControllerDeleteDocsByMetadata(
+    collectionId,
+    filter
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **collectionId** | [**string**] |  | defaults to undefined|
+| **filter** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**MessageResponseDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+|**400** |  |  -  |
+|**401** |  |  -  |
+|**403** |  |  -  |
+|**404** |  |  -  |
+|**500** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **collectionControllerGetCollection**
+> MessageResponseDTO collectionControllerGetCollection()
+
+
+### Example
+
+```typescript
+import {
+    CollectionApi,
+    Configuration
+} from '@nestbox-ai/documents';
+
+const configuration = new Configuration();
+const apiInstance = new CollectionApi(configuration);
+
+let collectionId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.collectionControllerGetCollection(
+    collectionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **collectionId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**MessageResponseDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+|**400** |  |  -  |
+|**401** |  |  -  |
+|**403** |  |  -  |
+|**404** |  |  -  |
+|**500** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **collectionControllerGetCollections**
+> MessageResponseDTO collectionControllerGetCollections()
+
+
+### Example
+
+```typescript
+import {
+    CollectionApi,
+    Configuration
+} from '@nestbox-ai/documents';
+
+const configuration = new Configuration();
+const apiInstance = new CollectionApi(configuration);
+
+const { status, data } = await apiInstance.collectionControllerGetCollections();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**MessageResponseDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+|**400** |  |  -  |
+|**401** |  |  -  |
+|**403** |  |  -  |
+|**404** |  |  -  |
+|**500** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **collectionControllerGetDocById**
+> MessageResponseDTO collectionControllerGetDocById()
+
+
+### Example
+
+```typescript
+import {
+    CollectionApi,
+    Configuration
+} from '@nestbox-ai/documents';
+
+const configuration = new Configuration();
+const apiInstance = new CollectionApi(configuration);
+
+let collectionId: string; // (default to undefined)
+let docId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.collectionControllerGetDocById(
+    collectionId,
+    docId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **collectionId** | [**string**] |  | defaults to undefined|
+| **docId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**MessageResponseDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+|**400** |  |  -  |
+|**401** |  |  -  |
+|**403** |  |  -  |
+|**404** |  |  -  |
+|**500** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **collectionControllerSimilaritySearch**
+> MessageResponseDTO collectionControllerSimilaritySearch(similaritySearchQueryDTO)
+
+
+### Example
+
+```typescript
+import {
+    CollectionApi,
+    Configuration,
+    SimilaritySearchQueryDTO
+} from '@nestbox-ai/documents';
+
+const configuration = new Configuration();
+const apiInstance = new CollectionApi(configuration);
+
+let collectionId: string; // (default to undefined)
+let similaritySearchQueryDTO: SimilaritySearchQueryDTO; //
+
+const { status, data } = await apiInstance.collectionControllerSimilaritySearch(
+    collectionId,
+    similaritySearchQueryDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **similaritySearchQueryDTO** | **SimilaritySearchQueryDTO**|  | |
+| **collectionId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**MessageResponseDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+|**400** |  |  -  |
+|**401** |  |  -  |
+|**403** |  |  -  |
+|**404** |  |  -  |
+|**500** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **collectionControllerUpdateCollection**
+> MessageResponseDTO collectionControllerUpdateCollection(createCollectionRequestDTO)
+
+
+### Example
+
+```typescript
+import {
+    CollectionApi,
+    Configuration,
+    CreateCollectionRequestDTO
+} from '@nestbox-ai/documents';
+
+const configuration = new Configuration();
+const apiInstance = new CollectionApi(configuration);
+
+let collectionId: string; // (default to undefined)
+let createCollectionRequestDTO: CreateCollectionRequestDTO; //
+
+const { status, data } = await apiInstance.collectionControllerUpdateCollection(
+    collectionId,
+    createCollectionRequestDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createCollectionRequestDTO** | **CreateCollectionRequestDTO**|  | |
+| **collectionId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**MessageResponseDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+|**400** |  |  -  |
+|**401** |  |  -  |
+|**403** |  |  -  |
+|**404** |  |  -  |
+|**500** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **collectionControllerUpdateDoc**
+> MessageResponseDTO collectionControllerUpdateDoc(updateDocumentRequestDTO)
+
+
+### Example
+
+```typescript
+import {
+    CollectionApi,
+    Configuration,
+    UpdateDocumentRequestDTO
+} from '@nestbox-ai/documents';
+
+const configuration = new Configuration();
+const apiInstance = new CollectionApi(configuration);
+
+let collectionId: string; // (default to undefined)
+let docId: string; // (default to undefined)
+let updateDocumentRequestDTO: UpdateDocumentRequestDTO; //
+
+const { status, data } = await apiInstance.collectionControllerUpdateDoc(
+    collectionId,
+    docId,
+    updateDocumentRequestDTO
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateDocumentRequestDTO** | **UpdateDocumentRequestDTO**|  | |
+| **collectionId** | [**string**] |  | defaults to undefined|
+| **docId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**MessageResponseDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+|**400** |  |  -  |
+|**401** |  |  -  |
+|**403** |  |  -  |
+|**404** |  |  -  |
+|**500** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

package/docs/CreateCollectionRequestDTO.md

@@ -0,0 +1,22 @@
+# CreateCollectionRequestDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [default to undefined]
+**metadata** | **object** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { CreateCollectionRequestDTO } from '@nestbox-ai/documents';
+
+const instance: CreateCollectionRequestDTO = {
+    name,
+    metadata,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/CreateDocumentRequestDTO.md

@@ -0,0 +1,24 @@
+# CreateDocumentRequestDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**document** | **string** |  | [default to undefined]
+**metadata** | **object** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { CreateDocumentRequestDTO } from '@nestbox-ai/documents';
+
+const instance: CreateDocumentRequestDTO = {
+    id,
+    document,
+    metadata,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/FatalErrorExceptionResponse.md

@@ -0,0 +1,20 @@
+# FatalErrorExceptionResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** |  | [default to 'Something Went Wrong']
+
+## Example
+
+```typescript
+import { FatalErrorExceptionResponse } from '@nestbox-ai/documents';
+
+const instance: FatalErrorExceptionResponse = {
+    message,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ForbiddenExceptionResponse.md

@@ -0,0 +1,20 @@
+# ForbiddenExceptionResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** |  | [default to 'Access Not Allowed']
+
+## Example
+
+```typescript
+import { ForbiddenExceptionResponse } from '@nestbox-ai/documents';
+
+const instance: ForbiddenExceptionResponse = {
+    message,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/MessageResponseDTO.md

@@ -0,0 +1,20 @@
+# MessageResponseDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { MessageResponseDTO } from '@nestbox-ai/documents';
+
+const instance: MessageResponseDTO = {
+    message,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/NotFoundExceptionResponse.md

@@ -0,0 +1,20 @@
+# NotFoundExceptionResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** |  | [default to 'Not Found']
+
+## Example
+
+```typescript
+import { NotFoundExceptionResponse } from '@nestbox-ai/documents';
+
+const instance: NotFoundExceptionResponse = {
+    message,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/SimilaritySearchQueryDTO.md

@@ -0,0 +1,26 @@
+# SimilaritySearchQueryDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**query** | **string** |  | [default to undefined]
+**params** | **object** |  | [default to undefined]
+**filter** | **object** |  | [default to undefined]
+**include** | **Array<string>** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { SimilaritySearchQueryDTO } from '@nestbox-ai/documents';
+
+const instance: SimilaritySearchQueryDTO = {
+    query,
+    params,
+    filter,
+    include,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/UnauthorizedExceptionResponse.md

@@ -0,0 +1,20 @@
+# UnauthorizedExceptionResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** |  | [default to 'Not Authorized']
+
+## Example
+
+```typescript
+import { UnauthorizedExceptionResponse } from '@nestbox-ai/documents';
+
+const instance: UnauthorizedExceptionResponse = {
+    message,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/UpdateDocumentRequestDTO.md

@@ -0,0 +1,22 @@
+# UpdateDocumentRequestDTO
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**document** | **string** |  | [default to undefined]
+**metadata** | **object** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateDocumentRequestDTO } from '@nestbox-ai/documents';
+
+const instance: UpdateDocumentRequestDTO = {
+    document,
+    metadata,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nestbox-ai/documents",
-  "version": "1.0.39",
+  "version": "1.0.47",
   "description": "OpenAPI client for @nestbox-ai/documents",
   "author": "OpenAPI-Generator Contributors",
   "repository": {