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

package/docs/JobDto.md

@@ -0,0 +1,48 @@
+# JobDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Job ID | [default to undefined]
+**type** | **string** | Job type | [default to undefined]
+**state** | **string** | Job state | [default to undefined]
+**createdAt** | **string** | Job creation timestamp | [default to undefined]
+**updatedAt** | **string** | Job last update timestamp | [optional] [default to undefined]
+**profileId** | **string** | Associated profile ID | [optional] [default to undefined]
+**documentId** | **string** | Associated document ID | [optional] [default to undefined]
+**evalId** | **string** | Associated evaluation ID | [optional] [default to undefined]
+**queryId** | **string** | Associated query ID | [optional] [default to undefined]
+**progress** | **number** | 0..1 progress fraction | [optional] [default to undefined]
+**stage** | **string** | Current pipeline stage | [optional] [default to undefined]
+**message** | **string** | Current job message | [optional] [default to undefined]
+**error** | **string** | Error message if failed | [optional] [default to undefined]
+**links** | [**JobLinksDto**](JobLinksDto.md) | Job-related links | [optional] [default to undefined]
+**metadata** | **{ [key: string]: any; }** | Additional job metadata | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { JobDto } from '@nestbox-ai/doc-processing-api';
+
+const instance: JobDto = {
+    id,
+    type,
+    state,
+    createdAt,
+    updatedAt,
+    profileId,
+    documentId,
+    evalId,
+    queryId,
+    progress,
+    stage,
+    message,
+    error,
+    links,
+    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/JobLinksDto.md

@@ -0,0 +1,22 @@
+# JobLinksDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** | Job status URI | [optional] [default to undefined]
+**resource** | **string** | Resource URI | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { JobLinksDto } from '@nestbox-ai/doc-processing-api';
+
+const instance: JobLinksDto = {
+    status,
+    resource,
+};
+```
+
+[[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/JobStatusDto.md

@@ -0,0 +1,32 @@
+# JobStatusDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Job ID | [default to undefined]
+**state** | **string** | Job state | [default to undefined]
+**updatedAt** | **string** | Job last update timestamp | [default to undefined]
+**progress** | **number** | 0..1 progress fraction | [optional] [default to undefined]
+**stage** | **string** | Current pipeline stage | [optional] [default to undefined]
+**message** | **string** | Current job message | [optional] [default to undefined]
+**error** | **string** | Error message if failed | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { JobStatusDto } from '@nestbox-ai/doc-processing-api';
+
+const instance: JobStatusDto = {
+    id,
+    state,
+    updatedAt,
+    progress,
+    stage,
+    message,
+    error,
+};
+```
+
+[[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/JobsApi.md

@@ -0,0 +1,170 @@
+# JobsApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**jobsControllerGetJob**](#jobscontrollergetjob) | **GET** /jobs/{jobId} | Read job|
+|[**jobsControllerGetJobStatus**](#jobscontrollergetjobstatus) | **GET** /jobs/{jobId}/status | Get job status|
+|[**jobsControllerListJobs**](#jobscontrollerlistjobs) | **GET** /jobs | List jobs|
+
+# **jobsControllerGetJob**
+> JobDto jobsControllerGetJob()
+
+
+### Example
+
+```typescript
+import {
+    JobsApi,
+    Configuration
+} from '@nestbox-ai/doc-processing-api';
+
+const configuration = new Configuration();
+const apiInstance = new JobsApi(configuration);
+
+let jobId: string; //Job ID. (default to undefined)
+
+const { status, data } = await apiInstance.jobsControllerGetJob(
+    jobId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **jobId** | [**string**] | Job ID. | defaults to undefined|
+
+
+### Return type
+
+**JobDto**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Job 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)
+
+# **jobsControllerGetJobStatus**
+> JobStatusDto jobsControllerGetJobStatus()
+
+Returns a lightweight status payload suitable for polling.
+
+### Example
+
+```typescript
+import {
+    JobsApi,
+    Configuration
+} from '@nestbox-ai/doc-processing-api';
+
+const configuration = new Configuration();
+const apiInstance = new JobsApi(configuration);
+
+let jobId: string; //Job ID. (default to undefined)
+
+const { status, data } = await apiInstance.jobsControllerGetJobStatus(
+    jobId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **jobId** | [**string**] | Job ID. | defaults to undefined|
+
+
+### Return type
+
+**JobStatusDto**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Job status |  -  |
+|**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)
+
+# **jobsControllerListJobs**
+> PaginatedJobsDto jobsControllerListJobs()
+
+Lists jobs for document processing, evaluations, and query jobs.
+
+### Example
+
+```typescript
+import {
+    JobsApi,
+    Configuration
+} from '@nestbox-ai/doc-processing-api';
+
+const configuration = new Configuration();
+const apiInstance = new JobsApi(configuration);
+
+let page: number; //1-based page number. (optional) (default to 1)
+let limit: number; //Page size. (optional) (default to 10)
+
+const { status, data } = await apiInstance.jobsControllerListJobs(
+    page,
+    limit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **page** | [**number**] | 1-based page number. | (optional) defaults to 1|
+| **limit** | [**number**] | Page size. | (optional) defaults to 10|
+
+
+### Return type
+
+**PaginatedJobsDto**
+
+### 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 jobs |  -  |
+|**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/PaginatedDocumentsDto.md

@@ -0,0 +1,22 @@
+# PaginatedDocumentsDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<DocumentDto>**](DocumentDto.md) | Document data | [default to undefined]
+**pagination** | [**PaginationDto**](PaginationDto.md) | Pagination information | [default to undefined]
+
+## Example
+
+```typescript
+import { PaginatedDocumentsDto } from '@nestbox-ai/doc-processing-api';
+
+const instance: PaginatedDocumentsDto = {
+    data,
+    pagination,
+};
+```
+
+[[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/PaginatedEvalsDto.md

@@ -0,0 +1,22 @@
+# PaginatedEvalsDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<EvalDto>**](EvalDto.md) | Evaluation data | [default to undefined]
+**pagination** | [**PaginationDto**](PaginationDto.md) | Pagination information | [default to undefined]
+
+## Example
+
+```typescript
+import { PaginatedEvalsDto } from '@nestbox-ai/doc-processing-api';
+
+const instance: PaginatedEvalsDto = {
+    data,
+    pagination,
+};
+```
+
+[[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/PaginatedJobsDto.md

@@ -0,0 +1,22 @@
+# PaginatedJobsDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<JobDto>**](JobDto.md) | Job data | [default to undefined]
+**pagination** | [**PaginationDto**](PaginationDto.md) | Pagination information | [default to undefined]
+
+## Example
+
+```typescript
+import { PaginatedJobsDto } from '@nestbox-ai/doc-processing-api';
+
+const instance: PaginatedJobsDto = {
+    data,
+    pagination,
+};
+```
+
+[[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/PaginatedProfilesDto.md

@@ -0,0 +1,22 @@
+# PaginatedProfilesDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<ProfileDto>**](ProfileDto.md) | Profile data | [default to undefined]
+**pagination** | [**PaginationDto**](PaginationDto.md) | Pagination information | [default to undefined]
+
+## Example
+
+```typescript
+import { PaginatedProfilesDto } from '@nestbox-ai/doc-processing-api';
+
+const instance: PaginatedProfilesDto = {
+    data,
+    pagination,
+};
+```
+
+[[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/PaginatedQueriesDto.md

@@ -0,0 +1,22 @@
+# PaginatedQueriesDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<BatchQueryDto>**](BatchQueryDto.md) | Batch query data | [default to undefined]
+**pagination** | [**PaginationDto**](PaginationDto.md) | Pagination information | [default to undefined]
+
+## Example
+
+```typescript
+import { PaginatedQueriesDto } from '@nestbox-ai/doc-processing-api';
+
+const instance: PaginatedQueriesDto = {
+    data,
+    pagination,
+};
+```
+
+[[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/PaginatedWebhooksDto.md

@@ -0,0 +1,22 @@
+# PaginatedWebhooksDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<WebhookDto>**](WebhookDto.md) | Webhook data | [default to undefined]
+**pagination** | [**PaginationDto**](PaginationDto.md) | Pagination information | [default to undefined]
+
+## Example
+
+```typescript
+import { PaginatedWebhooksDto } from '@nestbox-ai/doc-processing-api';
+
+const instance: PaginatedWebhooksDto = {
+    data,
+    pagination,
+};
+```
+
+[[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/PaginationDto.md

@@ -0,0 +1,24 @@
+# PaginationDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**page** | **number** | Current page number | [default to undefined]
+**limit** | **number** | Page size limit | [default to undefined]
+**total** | **number** | Total number of items | [default to undefined]
+
+## Example
+
+```typescript
+import { PaginationDto } from '@nestbox-ai/doc-processing-api';
+
+const instance: PaginationDto = {
+    page,
+    limit,
+    total,
+};
+```
+
+[[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/ProfileDto.md

@@ -0,0 +1,32 @@
+# ProfileDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Profile ID | [default to undefined]
+**name** | **string** | Profile name | [default to undefined]
+**description** | **string** | Profile description | [optional] [default to undefined]
+**createdAt** | **string** | Profile creation timestamp | [default to undefined]
+**updatedAt** | **string** | Profile last update timestamp | [optional] [default to undefined]
+**yamlFileName** | **string** | YAML file name | [optional] [default to undefined]
+**yamlSha256** | **string** | Optional checksum of the uploaded YAML file | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ProfileDto } from '@nestbox-ai/doc-processing-api';
+
+const instance: ProfileDto = {
+    id,
+    name,
+    description,
+    createdAt,
+    updatedAt,
+    yamlFileName,
+    yamlSha256,
+};
+```
+
+[[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/ProfilesApi.md

@@ -0,0 +1,220 @@
+# ProfilesApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**profilesControllerCreateProfile**](#profilescontrollercreateprofile) | **POST** /profiles | Create profile from YAML|
+|[**profilesControllerGetProfile**](#profilescontrollergetprofile) | **GET** /profiles/{profileId} | Read profile|
+|[**profilesControllerGetProfileSchema**](#profilescontrollergetprofileschema) | **GET** /profiles/schema | Get profile schema|
+|[**profilesControllerListProfiles**](#profilescontrollerlistprofiles) | **GET** /profiles | List profiles|
+
+# **profilesControllerCreateProfile**
+> ProfileDto profilesControllerCreateProfile()
+
+Upload a YAML config file (multipart form). Do not inline YAML parameters in JSON.
+
+### Example
+
+```typescript
+import {
+    ProfilesApi,
+    Configuration
+} from '@nestbox-ai/doc-processing-api';
+
+const configuration = new Configuration();
+const apiInstance = new ProfilesApi(configuration);
+
+let yaml: File; //YAML file containing the profile/config. (default to undefined)
+let name: string; //Optional override for profile name (otherwise derived from YAML). (optional) (default to undefined)
+
+const { status, data } = await apiInstance.profilesControllerCreateProfile(
+    yaml,
+    name
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **yaml** | [**File**] | YAML file containing the profile/config. | defaults to undefined|
+| **name** | [**string**] | Optional override for profile name (otherwise derived from YAML). | (optional) defaults to undefined|
+
+
+### Return type
+
+**ProfileDto**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Profile created |  -  |
+|**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)
+
+# **profilesControllerGetProfile**
+> ProfileDto profilesControllerGetProfile()
+
+
+### Example
+
+```typescript
+import {
+    ProfilesApi,
+    Configuration
+} from '@nestbox-ai/doc-processing-api';
+
+const configuration = new Configuration();
+const apiInstance = new ProfilesApi(configuration);
+
+let profileId: string; //Profile/config ID. (default to undefined)
+
+const { status, data } = await apiInstance.profilesControllerGetProfile(
+    profileId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **profileId** | [**string**] | Profile/config ID. | defaults to undefined|
+
+
+### Return type
+
+**ProfileDto**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Profile 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)
+
+# **profilesControllerGetProfileSchema**
+> { [key: string]: any; } profilesControllerGetProfileSchema()
+
+Returns the JSON schema for profile YAML configuration files.
+
+### Example
+
+```typescript
+import {
+    ProfilesApi,
+    Configuration
+} from '@nestbox-ai/doc-processing-api';
+
+const configuration = new Configuration();
+const apiInstance = new ProfilesApi(configuration);
+
+const { status, data } = await apiInstance.profilesControllerGetProfileSchema();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**{ [key: string]: any; }**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Profile schema in JSON format |  -  |
+|**401** | Unauthorized |  -  |
+|**500** | Internal server 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)
+
+# **profilesControllerListProfiles**
+> PaginatedProfilesDto profilesControllerListProfiles()
+
+
+### Example
+
+```typescript
+import {
+    ProfilesApi,
+    Configuration
+} from '@nestbox-ai/doc-processing-api';
+
+const configuration = new Configuration();
+const apiInstance = new ProfilesApi(configuration);
+
+let page: number; //1-based page number. (optional) (default to 1)
+let limit: number; //Page size. (optional) (default to 10)
+
+const { status, data } = await apiInstance.profilesControllerListProfiles(
+    page,
+    limit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **page** | [**number**] | 1-based page number. | (optional) defaults to 1|
+| **limit** | [**number**] | Page size. | (optional) defaults to 10|
+
+
+### Return type
+
+**PaginatedProfilesDto**
+
+### 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 profiles |  -  |
+|**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)
+