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

package/docs/QueriesApi.md

@@ -0,0 +1,232 @@
+# QueriesApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**queriesControllerCreateQuery**](#queriescontrollercreatequery) | **POST** /query | Create batch query from YAML|
+|[**queriesControllerGetQuery**](#queriescontrollergetquery) | **GET** /query/{queryId} | Read batch query|
+|[**queriesControllerListQueries**](#queriescontrollerlistqueries) | **GET** /query | List batch queries|
+|[**queriesControllerValidateQueryYaml**](#queriescontrollervalidatequeryyaml) | **POST** /query/validate | Validate batch query YAML|
+
+# **queriesControllerCreateQuery**
+> QueryCreateResponseDto queriesControllerCreateQuery()
+
+Uploads a batch queries YAML (multipart form). Typically schedules a job.
+
+### Example
+
+```typescript
+import {
+    QueriesApi,
+    Configuration
+} from '@nestbox-ai/doc-processing-api';
+
+const configuration = new Configuration();
+const apiInstance = new QueriesApi(configuration);
+
+let yaml: File; //Batch queries YAML file. (default to undefined)
+let watch: boolean; // (optional) (default to false)
+
+const { status, data } = await apiInstance.queriesControllerCreateQuery(
+    yaml,
+    watch
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **yaml** | [**File**] | Batch queries YAML file. | defaults to undefined|
+| **watch** | [**boolean**] |  | (optional) defaults to false|
+
+
+### Return type
+
+**QueryCreateResponseDto**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Batch query 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)
+
+# **queriesControllerGetQuery**
+> BatchQueryDto queriesControllerGetQuery()
+
+
+### Example
+
+```typescript
+import {
+    QueriesApi,
+    Configuration
+} from '@nestbox-ai/doc-processing-api';
+
+const configuration = new Configuration();
+const apiInstance = new QueriesApi(configuration);
+
+let queryId: string; //Batch query ID. (default to undefined)
+
+const { status, data } = await apiInstance.queriesControllerGetQuery(
+    queryId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **queryId** | [**string**] | Batch query ID. | defaults to undefined|
+
+
+### Return type
+
+**BatchQueryDto**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Batch query 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)
+
+# **queriesControllerListQueries**
+> PaginatedQueriesDto queriesControllerListQueries()
+
+Lists batch query runs (submitted via YAML).
+
+### Example
+
+```typescript
+import {
+    QueriesApi,
+    Configuration
+} from '@nestbox-ai/doc-processing-api';
+
+const configuration = new Configuration();
+const apiInstance = new QueriesApi(configuration);
+
+let page: number; //1-based page number. (optional) (default to 1)
+let limit: number; //Page size. (optional) (default to 10)
+let documentId: string; //Filter by document ID. (optional) (default to undefined)
+
+const { status, data } = await apiInstance.queriesControllerListQueries(
+    page,
+    limit,
+    documentId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **page** | [**number**] | 1-based page number. | (optional) defaults to 1|
+| **limit** | [**number**] | Page size. | (optional) defaults to 10|
+| **documentId** | [**string**] | Filter by document ID. | (optional) defaults to undefined|
+
+
+### Return type
+
+**PaginatedQueriesDto**
+
+### 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 batch queries |  -  |
+|**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)
+
+# **queriesControllerValidateQueryYaml**
+> ValidationResultDto queriesControllerValidateQueryYaml()
+
+Validates an uploaded batch queries YAML without creating a query.
+
+### Example
+
+```typescript
+import {
+    QueriesApi,
+    Configuration
+} from '@nestbox-ai/doc-processing-api';
+
+const configuration = new Configuration();
+const apiInstance = new QueriesApi(configuration);
+
+let yaml: File; //YAML file to validate. (default to undefined)
+
+const { status, data } = await apiInstance.queriesControllerValidateQueryYaml(
+    yaml
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **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 |  -  |
+|**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/QueryCreateResponseDto.md

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

@@ -0,0 +1,32 @@
+# SourceItemDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Source ID | [default to undefined]
+**documentId** | **string** | Associated document ID | [default to undefined]
+**jobId** | **string** | Associated job ID | [optional] [default to undefined]
+**chunkId** | **string** | Chunk ID | [optional] [default to undefined]
+**page** | **number** | Page number | [optional] [default to undefined]
+**text** | **string** | Source text content | [default to undefined]
+**metadata** | **{ [key: string]: any; }** | Additional metadata | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SourceItemDto } from '@nestbox-ai/doc-processing-api';
+
+const instance: SourceItemDto = {
+    id,
+    documentId,
+    jobId,
+    chunkId,
+    page,
+    text,
+    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/SourcesApi.md

@@ -0,0 +1,67 @@
+# SourcesApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**sourcesControllerGetDocumentSources**](#sourcescontrollergetdocumentsources) | **GET** /documents/{documentId}/sources | Read document sources|
+
+# **sourcesControllerGetDocumentSources**
+> DocumentSourcesResponseDto sourcesControllerGetDocumentSources()
+
+Returns source data used to produce answers/results. If sourceId is provided, returns the matching source. Otherwise returns a list.
+
+### Example
+
+```typescript
+import {
+    SourcesApi,
+    Configuration
+} from '@nestbox-ai/doc-processing-api';
+
+const configuration = new Configuration();
+const apiInstance = new SourcesApi(configuration);
+
+let documentId: string; //Document ID. (default to undefined)
+let jobId: any; //Optional job ID to scope sources to a specific query job. (optional) (default to undefined)
+let sourceId: any; //Optional source ID (full or partial) to retrieve a specific source. (optional) (default to undefined)
+
+const { status, data } = await apiInstance.sourcesControllerGetDocumentSources(
+    documentId,
+    jobId,
+    sourceId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **documentId** | [**string**] | Document ID. | defaults to undefined|
+| **jobId** | **any** | Optional job ID to scope sources to a specific query job. | (optional) defaults to undefined|
+| **sourceId** | **any** | Optional source ID (full or partial) to retrieve a specific source. | (optional) defaults to undefined|
+
+
+### Return type
+
+**DocumentSourcesResponseDto**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Source data |  -  |
+|**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)
+

package/docs/UpdateWebhookBodyInputDto.md

@@ -0,0 +1,20 @@
+# UpdateWebhookBodyInputDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **string** | Updated webhook target URL | [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateWebhookBodyInputDto } from '@nestbox-ai/doc-processing-api';
+
+const instance: UpdateWebhookBodyInputDto = {
+    url,
+};
+```
+
+[[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/ValidationErrorDto.md

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

@@ -0,0 +1,24 @@
+# ValidationIssueDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**path** | **string** | JSON pointer-like path into the YAML document | [default to undefined]
+**message** | **string** | Validation issue message | [default to undefined]
+**severity** | **string** | Issue severity | [optional] [default to SeverityEnum_Error]
+
+## Example
+
+```typescript
+import { ValidationIssueDto } from '@nestbox-ai/doc-processing-api';
+
+const instance: ValidationIssueDto = {
+    path,
+    message,
+    severity,
+};
+```
+
+[[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/ValidationResultDto.md

@@ -0,0 +1,24 @@
+# ValidationResultDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**valid** | **boolean** | Whether the validation passed | [default to undefined]
+**warnings** | [**Array<ValidationIssueDto>**](ValidationIssueDto.md) | Non-fatal issues | [optional] [default to undefined]
+**normalized** | **{ [key: string]: any; }** | Optional normalized representation (if available) | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ValidationResultDto } from '@nestbox-ai/doc-processing-api';
+
+const instance: ValidationResultDto = {
+    valid,
+    warnings,
+    normalized,
+};
+```
+
+[[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/WebhookDto.md

@@ -0,0 +1,26 @@
+# WebhookDto
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Webhook ID | [default to undefined]
+**url** | **string** | Webhook target URL | [default to undefined]
+**createdAt** | **string** | Webhook creation timestamp | [default to undefined]
+**updatedAt** | **string** | Webhook last update timestamp | [default to undefined]
+
+## Example
+
+```typescript
+import { WebhookDto } from '@nestbox-ai/doc-processing-api';
+
+const instance: WebhookDto = {
+    id,
+    url,
+    createdAt,
+    updatedAt,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)