@nestbox-ai/doc-processing-api 0.0.1 → 1.0.62

package/docs/DocumentsApi.md

@@ -0,0 +1,186 @@
+# DocumentsApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**documentsControllerCreateDocument**](#documentscontrollercreatedocument) | **POST** /documents | Create document processing job|
+|[**documentsControllerGetDocument**](#documentscontrollergetdocument) | **GET** /documents/{documentId} | Read document|
+|[**documentsControllerListDocuments**](#documentscontrollerlistdocuments) | **GET** /documents | List documents|
+
+# **documentsControllerCreateDocument**
+> DocumentCreateResponseDto documentsControllerCreateDocument()
+
+Upload a document file (pdf/md/html/docx/etc) via multipart form to start processing.
+
+### Example
+
+```typescript
+import {
+    DocumentsApi,
+    Configuration
+} from '@nestbox-ai/doc-processing-api';
+
+const configuration = new Configuration();
+const apiInstance = new DocumentsApi(configuration);
+
+let profileId: string; //Profile/config ID to use for processing (maps to CLI --config). (default to undefined)
+let file: File; //Document file to process (pdf/md/html/docx/etc). (default to undefined)
+let stages: string; //Comma-separated stages to run (e.g., docling,chunking,graphrag). If omitted, auto-detected by server. (optional) (default to undefined)
+let priority: string; // (optional) (default to 'normal')
+let visualize: boolean; //Whether to generate graph visualization artifacts. (optional) (default to false)
+
+const { status, data } = await apiInstance.documentsControllerCreateDocument(
+    profileId,
+    file,
+    stages,
+    priority,
+    visualize
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **profileId** | [**string**] | Profile/config ID to use for processing (maps to CLI --config). | defaults to undefined|
+| **file** | [**File**] | Document file to process (pdf/md/html/docx/etc). | defaults to undefined|
+| **stages** | [**string**] | Comma-separated stages to run (e.g., docling,chunking,graphrag). If omitted, auto-detected by server. | (optional) defaults to undefined|
+| **priority** | [**string**]**Array<&#39;low&#39; &#124; &#39;normal&#39; &#124; &#39;high&#39;>** |  | (optional) defaults to 'normal'|
+| **visualize** | [**boolean**] | Whether to generate graph visualization artifacts. | (optional) defaults to false|
+
+
+### Return type
+
+**DocumentCreateResponseDto**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Document accepted/created. Processing typically runs as a background job. |  -  |
+|**400** | Bad request |  -  |
+|**401** | Unauthorized |  -  |
+|**422** | Validation error |  -  |
+
+[[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)
+
+# **documentsControllerGetDocument**
+> DocumentDto documentsControllerGetDocument()
+
+
+### Example
+
+```typescript
+import {
+    DocumentsApi,
+    Configuration
+} from '@nestbox-ai/doc-processing-api';
+
+const configuration = new Configuration();
+const apiInstance = new DocumentsApi(configuration);
+
+let documentId: string; //Document ID. (default to undefined)
+
+const { status, data } = await apiInstance.documentsControllerGetDocument(
+    documentId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **documentId** | [**string**] | Document ID. | defaults to undefined|
+
+
+### Return type
+
+**DocumentDto**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Document details |  -  |
+|**401** | Unauthorized |  -  |
+|**404** | Not found |  -  |
+
+[[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)
+
+# **documentsControllerListDocuments**
+> PaginatedDocumentsDto documentsControllerListDocuments()
+
+List processed documents. Supports filtering by profileId.
+
+### Example
+
+```typescript
+import {
+    DocumentsApi,
+    Configuration
+} from '@nestbox-ai/doc-processing-api';
+
+const configuration = new Configuration();
+const apiInstance = new DocumentsApi(configuration);
+
+let page: number; //1-based page number. (optional) (default to 1)
+let limit: number; //Page size. (optional) (default to 10)
+let profileId: string; //Filter documents by profile/config ID. (optional) (default to undefined)
+
+const { status, data } = await apiInstance.documentsControllerListDocuments(
+    page,
+    limit,
+    profileId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **page** | [**number**] | 1-based page number. | (optional) defaults to 1|
+| **limit** | [**number**] | Page size. | (optional) defaults to 10|
+| **profileId** | [**string**] | Filter documents by profile/config ID. | (optional) defaults to undefined|
+
+
+### Return type
+
+**PaginatedDocumentsDto**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Paginated list of documents |  -  |
+|**401** | Unauthorized |  -  |
+
+[[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/ErrorDto.md

@@ -0,0 +1,26 @@
+# ErrorDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | **string** | Error type | [default to undefined]
+**message** | **string** | Error message | [default to undefined]
+**requestId** | **string** | Request ID for tracking | [optional] [default to undefined]
+**details** | **{ [key: string]: any; }** | Additional error details | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ErrorDto } from '@nestbox-ai/doc-processing-api';
+
+const instance: ErrorDto = {
+    error,
+    message,
+    requestId,
+    details,
+};
+```
+
+[[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/EvalCreateResponseDto.md

@@ -0,0 +1,22 @@
+# EvalCreateResponseDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**eval** | [**EvalDto**](EvalDto.md) | Created evaluation | [default to undefined]
+**job** | [**JobDto**](JobDto.md) | Processing job | [default to undefined]
+
+## Example
+
+```typescript
+import { EvalCreateResponseDto } from '@nestbox-ai/doc-processing-api';
+
+const instance: EvalCreateResponseDto = {
+    eval,
+    job,
+};
+```
+
+[[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/EvalDto.md

@@ -0,0 +1,36 @@
+# EvalDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Evaluation ID | [default to undefined]
+**documentId** | **string** | Associated document ID | [default to undefined]
+**status** | **string** | Evaluation status | [default to undefined]
+**createdAt** | **string** | Evaluation creation timestamp | [default to undefined]
+**updatedAt** | **string** | Evaluation last update timestamp | [optional] [default to undefined]
+**latestJobId** | **string** | Latest job ID associated with this evaluation | [optional] [default to undefined]
+**yamlFileName** | **string** | YAML file name | [optional] [default to undefined]
+**summary** | **{ [key: string]: any; }** | Optional aggregated metrics (e.g., similarity scores) | [optional] [default to undefined]
+**report** | **{ [key: string]: any; }** | Optional detailed report (if stored) | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { EvalDto } from '@nestbox-ai/doc-processing-api';
+
+const instance: EvalDto = {
+    id,
+    documentId,
+    status,
+    createdAt,
+    updatedAt,
+    latestJobId,
+    yamlFileName,
+    summary,
+    report,
+};
+```
+
+[[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/EvalsApi.md

@@ -0,0 +1,243 @@
+# EvalsApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**evalsControllerCreateEval**](#evalscontrollercreateeval) | **POST** /documents/{documentId}/evals | Create an eval from YAML|
+|[**evalsControllerGetEval**](#evalscontrollergeteval) | **GET** /documents/{documentId}/evals/{evalId} | Read eval|
+|[**evalsControllerListEvals**](#evalscontrollerlistevals) | **GET** /documents/{documentId}/evals | List evals for a document|
+|[**evalsControllerValidateEvalYaml**](#evalscontrollervalidateevalyaml) | **POST** /documents/{documentId}/evals/validate | Validate eval YAML|
+
+# **evalsControllerCreateEval**
+> EvalCreateResponseDto evalsControllerCreateEval()
+
+Uploads an eval YAML (test cases) to run against a document.
+
+### Example
+
+```typescript
+import {
+    EvalsApi,
+    Configuration
+} from '@nestbox-ai/doc-processing-api';
+
+const configuration = new Configuration();
+const apiInstance = new EvalsApi(configuration);
+
+let documentId: string; //Document ID. (default to undefined)
+let yaml: File; //Eval YAML file (test cases). (default to undefined)
+let watch: boolean; //If true, server may keep the request open longer (optional); most clients should poll job status instead. (optional) (default to false)
+
+const { status, data } = await apiInstance.evalsControllerCreateEval(
+    documentId,
+    yaml,
+    watch
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **documentId** | [**string**] | Document ID. | defaults to undefined|
+| **yaml** | [**File**] | Eval YAML file (test cases). | defaults to undefined|
+| **watch** | [**boolean**] | If true, server may keep the request open longer (optional); most clients should poll job status instead. | (optional) defaults to false|
+
+
+### Return type
+
+**EvalCreateResponseDto**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Eval created (often schedules a job) |  -  |
+|**400** | Bad request |  -  |
+|**401** | Unauthorized |  -  |
+|**404** | Not found |  -  |
+|**422** | Validation error |  -  |
+
+[[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)
+
+# **evalsControllerGetEval**
+> EvalDto evalsControllerGetEval()
+
+
+### Example
+
+```typescript
+import {
+    EvalsApi,
+    Configuration
+} from '@nestbox-ai/doc-processing-api';
+
+const configuration = new Configuration();
+const apiInstance = new EvalsApi(configuration);
+
+let documentId: string; //Document ID. (default to undefined)
+let evalId: string; //Evaluation ID. (default to undefined)
+
+const { status, data } = await apiInstance.evalsControllerGetEval(
+    documentId,
+    evalId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **documentId** | [**string**] | Document ID. | defaults to undefined|
+| **evalId** | [**string**] | Evaluation ID. | defaults to undefined|
+
+
+### Return type
+
+**EvalDto**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Eval details |  -  |
+|**401** | Unauthorized |  -  |
+|**404** | Not found |  -  |
+
+[[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)
+
+# **evalsControllerListEvals**
+> PaginatedEvalsDto evalsControllerListEvals()
+
+
+### Example
+
+```typescript
+import {
+    EvalsApi,
+    Configuration
+} from '@nestbox-ai/doc-processing-api';
+
+const configuration = new Configuration();
+const apiInstance = new EvalsApi(configuration);
+
+let documentId: string; //Document ID. (default to undefined)
+let limit: any; //Page size. (optional) (default to undefined)
+let page: any; //1-based page number. (optional) (default to undefined)
+
+const { status, data } = await apiInstance.evalsControllerListEvals(
+    documentId,
+    limit,
+    page
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **documentId** | [**string**] | Document ID. | defaults to undefined|
+| **limit** | **any** | Page size. | (optional) defaults to undefined|
+| **page** | **any** | 1-based page number. | (optional) defaults to undefined|
+
+
+### Return type
+
+**PaginatedEvalsDto**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Paginated list of evaluations |  -  |
+|**401** | Unauthorized |  -  |
+|**404** | Not found |  -  |
+
+[[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)
+
+# **evalsControllerValidateEvalYaml**
+> ValidationResultDto evalsControllerValidateEvalYaml()
+
+Validates an uploaded eval YAML without creating an eval.
+
+### Example
+
+```typescript
+import {
+    EvalsApi,
+    Configuration
+} from '@nestbox-ai/doc-processing-api';
+
+const configuration = new Configuration();
+const apiInstance = new EvalsApi(configuration);
+
+let documentId: string; //Document ID. (default to undefined)
+let yaml: File; //YAML file to validate. (default to undefined)
+
+const { status, data } = await apiInstance.evalsControllerValidateEvalYaml(
+    documentId,
+    yaml
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **documentId** | [**string**] | Document ID. | defaults to undefined|
+| **yaml** | [**File**] | YAML file to validate. | defaults to undefined|
+
+
+### Return type
+
+**ValidationResultDto**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Validation result |  -  |
+|**400** | Bad request |  -  |
+|**401** | Unauthorized |  -  |
+|**404** | Not found |  -  |
+|**422** | Validation error |  -  |
+
+[[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/GpuDeviceDto.md

@@ -0,0 +1,28 @@
+# GpuDeviceDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**index** | **number** | GPU device index | [default to undefined]
+**name** | **string** | GPU device name | [default to undefined]
+**memoryTotalMB** | **number** | Total GPU memory in MB | [default to undefined]
+**memoryUsedMB** | **number** | Used GPU memory in MB | [optional] [default to undefined]
+**utilizationPct** | **number** | GPU utilization percentage | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GpuDeviceDto } from '@nestbox-ai/doc-processing-api';
+
+const instance: GpuDeviceDto = {
+    index,
+    name,
+    memoryTotalMB,
+    memoryUsedMB,
+    utilizationPct,
+};
+```
+
+[[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/GpuHealthCheckDto.md

@@ -0,0 +1,26 @@
+# GpuHealthCheckDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** | GPU health status | [default to undefined]
+**deviceCount** | **number** | Number of GPU devices | [optional] [default to undefined]
+**devices** | [**Array<GpuDeviceDto>**](GpuDeviceDto.md) | GPU devices information | [optional] [default to undefined]
+**message** | **string** | GPU status message | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { GpuHealthCheckDto } from '@nestbox-ai/doc-processing-api';
+
+const instance: GpuHealthCheckDto = {
+    status,
+    deviceCount,
+    devices,
+    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/HealthApi.md

@@ -0,0 +1,53 @@
+# HealthApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**healthControllerGetHealth**](#healthcontrollergethealth) | **GET** /health | Get system health|
+
+# **healthControllerGetHealth**
+> HealthResponseDto healthControllerGetHealth()
+
+Returns service health including Redis, database, and GPU status.
+
+### Example
+
+```typescript
+import {
+    HealthApi,
+    Configuration
+} from '@nestbox-ai/doc-processing-api';
+
+const configuration = new Configuration();
+const apiInstance = new HealthApi(configuration);
+
+const { status, data } = await apiInstance.healthControllerGetHealth();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**HealthResponseDto**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Health status |  -  |
+|**401** | Unauthorized |  -  |
+
+[[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/HealthCheckItemDto.md

@@ -0,0 +1,26 @@
+# HealthCheckItemDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** | Health check status | [default to undefined]
+**latencyMs** | **number** | Latency in milliseconds | [optional] [default to undefined]
+**message** | **string** | Status message | [optional] [default to undefined]
+**details** | **{ [key: string]: any; }** | Additional details | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { HealthCheckItemDto } from '@nestbox-ai/doc-processing-api';
+
+const instance: HealthCheckItemDto = {
+    status,
+    latencyMs,
+    message,
+    details,
+};
+```
+
+[[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/HealthChecksDto.md

@@ -0,0 +1,24 @@
+# HealthChecksDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**redis** | [**HealthCheckItemDto**](HealthCheckItemDto.md) | Redis health check | [default to undefined]
+**db** | [**HealthCheckItemDto**](HealthCheckItemDto.md) | Database health check | [default to undefined]
+**gpu** | [**GpuHealthCheckDto**](GpuHealthCheckDto.md) | GPU health check | [default to undefined]
+
+## Example
+
+```typescript
+import { HealthChecksDto } from '@nestbox-ai/doc-processing-api';
+
+const instance: HealthChecksDto = {
+    redis,
+    db,
+    gpu,
+};
+```
+
+[[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/HealthResponseDto.md

@@ -0,0 +1,24 @@
+# HealthResponseDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** | Overall system health status | [default to undefined]
+**timestamp** | **string** | Health check timestamp | [default to undefined]
+**checks** | [**HealthChecksDto**](HealthChecksDto.md) | Health check results | [default to undefined]
+
+## Example
+
+```typescript
+import { HealthResponseDto } from '@nestbox-ai/doc-processing-api';
+
+const instance: HealthResponseDto = {
+    status,
+    timestamp,
+    checks,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)