# yfkm3-services-parse-client
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 
- Package version: 1.0.1
- Generator version: 7.21.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python 3.9+

## Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:

```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)

Then import the package:
```python
import yfkm3_services_parse_client
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import yfkm3_services_parse_client
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import yfkm3_services_parse_client
from yfkm3_services_parse_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = yfkm3_services_parse_client.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: APIKeyAuth
configuration.api_key['APIKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['APIKeyAuth'] = 'Bearer'


# Enter a context with an instance of the API client
async with yfkm3_services_parse_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = yfkm3_services_parse_client.ClearApi(api_client)

    try:
        # Clear Converters
        api_response = await api_instance.get_clear_converters()
        print("The response of ClearApi->get_clear_converters:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ClearApi->get_clear_converters: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *http://localhost*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ClearApi* | [**get_clear_converters**](docs/ClearApi.md#get_clear_converters) | **GET** /v1/clear/converters | Clear Converters
*ClearApi* | [**get_clear_results**](docs/ClearApi.md#get_clear_results) | **GET** /v1/clear/results | Clear Results
*ConvertApi* | [**post_convert_file**](docs/ConvertApi.md#post_convert_file) | **POST** /v1/convert/file | Process File
*ConvertApi* | [**post_convert_file_async**](docs/ConvertApi.md#post_convert_file_async) | **POST** /v1/convert/file/async | Process File Async
*ConvertApi* | [**post_convert_source**](docs/ConvertApi.md#post_convert_source) | **POST** /v1/convert/source | Process Url
*ConvertApi* | [**post_convert_source_async**](docs/ConvertApi.md#post_convert_source_async) | **POST** /v1/convert/source/async | Process Url Async
*DefaultApi* | [**get3_0_json**](docs/DefaultApi.md#get3_0_json) | **GET** /openapi-3.0.json | Openapi 30
*HealthApi* | [**get_health**](docs/HealthApi.md#get_health) | **GET** /health | Health
*HealthApi* | [**get_ready**](docs/HealthApi.md#get_ready) | **GET** /ready | Readiness
*HealthApi* | [**get_version**](docs/HealthApi.md#get_version) | **GET** /version | Version Info
*ManagementApi* | [**get_memory_counts**](docs/ManagementApi.md#get_memory_counts) | **GET** /v1/memory/counts | Memory Counts
*ManagementApi* | [**get_memory_stats**](docs/ManagementApi.md#get_memory_stats) | **GET** /v1/memory/stats | Memory Stats
*TasksApi* | [**get_result**](docs/TasksApi.md#get_result) | **GET** /v1/result/{task_id} | Task Result
*TasksApi* | [**get_status_poll**](docs/TasksApi.md#get_status_poll) | **GET** /v1/status/poll/{task_id} | Task Status Poll


## Documentation For Models

 - [ApiModelConfig](docs/ApiModelConfig.md)
 - [BaseMeta](docs/BaseMeta.md)
 - [BaseVlmEngineOptions](docs/BaseVlmEngineOptions.md)
 - [BoundingBox](docs/BoundingBox.md)
 - [ChartBar](docs/ChartBar.md)
 - [ChartLine](docs/ChartLine.md)
 - [ChartPoint](docs/ChartPoint.md)
 - [ChartSlice](docs/ChartSlice.md)
 - [ChartStackedBar](docs/ChartStackedBar.md)
 - [ChunkDocumentResponse](docs/ChunkDocumentResponse.md)
 - [ChunkedDocumentResultItem](docs/ChunkedDocumentResultItem.md)
 - [ClearResponse](docs/ClearResponse.md)
 - [CodeFormulaCustomConfig](docs/CodeFormulaCustomConfig.md)
 - [CodeFormulaVlmOptions](docs/CodeFormulaVlmOptions.md)
 - [CodeLanguageLabel](docs/CodeLanguageLabel.md)
 - [CodeMetaField](docs/CodeMetaField.md)
 - [ContentLayer](docs/ContentLayer.md)
 - [ConversionStatus](docs/ConversionStatus.md)
 - [ConvertDocumentResponse](docs/ConvertDocumentResponse.md)
 - [ConvertDocumentsRequest](docs/ConvertDocumentsRequest.md)
 - [ConvertDocumentsRequestOptions](docs/ConvertDocumentsRequestOptions.md)
 - [CoordOrigin](docs/CoordOrigin.md)
 - [DescriptionAnnotation](docs/DescriptionAnnotation.md)
 - [DescriptionMetaField](docs/DescriptionMetaField.md)
 - [DoclingComponentType](docs/DoclingComponentType.md)
 - [DocumentOrigin](docs/DocumentOrigin.md)
 - [EngineModelConfig](docs/EngineModelConfig.md)
 - [ErrorItem](docs/ErrorItem.md)
 - [ExportDocumentResponse](docs/ExportDocumentResponse.md)
 - [ExportResult](docs/ExportResult.md)
 - [FileSourceRequest](docs/FileSourceRequest.md)
 - [FineRef](docs/FineRef.md)
 - [FloatingMeta](docs/FloatingMeta.md)
 - [Formatting](docs/Formatting.md)
 - [GraphCell](docs/GraphCell.md)
 - [GraphCellLabel](docs/GraphCellLabel.md)
 - [GraphData](docs/GraphData.md)
 - [GraphLink](docs/GraphLink.md)
 - [GraphLinkLabel](docs/GraphLinkLabel.md)
 - [GroupItem](docs/GroupItem.md)
 - [GroupLabel](docs/GroupLabel.md)
 - [HTTPValidationError](docs/HTTPValidationError.md)
 - [HealthCheckResponse](docs/HealthCheckResponse.md)
 - [HttpSourceRequest](docs/HttpSourceRequest.md)
 - [ImageRef](docs/ImageRef.md)
 - [ImageRefMode](docs/ImageRefMode.md)
 - [InBodyTarget](docs/InBodyTarget.md)
 - [InferenceFramework](docs/InferenceFramework.md)
 - [InlineGroup](docs/InlineGroup.md)
 - [InputFormat](docs/InputFormat.md)
 - [ListGroup](docs/ListGroup.md)
 - [LocationInner](docs/LocationInner.md)
 - [MiscAnnotation](docs/MiscAnnotation.md)
 - [MoleculeMetaField](docs/MoleculeMetaField.md)
 - [OcrEnginesEnum](docs/OcrEnginesEnum.md)
 - [OutputFormat](docs/OutputFormat.md)
 - [PageItem](docs/PageItem.md)
 - [PdfBackend](docs/PdfBackend.md)
 - [PictureBarChartData](docs/PictureBarChartData.md)
 - [PictureClassificationClass](docs/PictureClassificationClass.md)
 - [PictureClassificationData](docs/PictureClassificationData.md)
 - [PictureClassificationLabel](docs/PictureClassificationLabel.md)
 - [PictureClassificationMetaField](docs/PictureClassificationMetaField.md)
 - [PictureClassificationPrediction](docs/PictureClassificationPrediction.md)
 - [PictureDescriptionApi](docs/PictureDescriptionApi.md)
 - [PictureDescriptionCustomConfig](docs/PictureDescriptionCustomConfig.md)
 - [PictureDescriptionLocal](docs/PictureDescriptionLocal.md)
 - [PictureDescriptionVlmEngineOptions](docs/PictureDescriptionVlmEngineOptions.md)
 - [PictureLineChartData](docs/PictureLineChartData.md)
 - [PictureMeta](docs/PictureMeta.md)
 - [PictureMoleculeData](docs/PictureMoleculeData.md)
 - [PicturePieChartData](docs/PicturePieChartData.md)
 - [PictureScatterChartData](docs/PictureScatterChartData.md)
 - [PictureStackedBarChartData](docs/PictureStackedBarChartData.md)
 - [PictureTabularChartData](docs/PictureTabularChartData.md)
 - [PresignedUrlConvertDocumentResponse](docs/PresignedUrlConvertDocumentResponse.md)
 - [ProcessingPipeline](docs/ProcessingPipeline.md)
 - [ProfilingItem](docs/ProfilingItem.md)
 - [ProfilingScope](docs/ProfilingScope.md)
 - [ProvenanceItem](docs/ProvenanceItem.md)
 - [ProviderKind](docs/ProviderKind.md)
 - [PutTarget](docs/PutTarget.md)
 - [ReadinessResponse](docs/ReadinessResponse.md)
 - [RefItem](docs/RefItem.md)
 - [ResponseFormat](docs/ResponseFormat.md)
 - [ResponseProcessFileV1ConvertFilePost](docs/ResponseProcessFileV1ConvertFilePost.md)
 - [ResponseProcessUrlV1ConvertSourcePost](docs/ResponseProcessUrlV1ConvertSourcePost.md)
 - [ResponseTaskResultV1ResultTaskIdGet](docs/ResponseTaskResultV1ResultTaskIdGet.md)
 - [RichTableCell](docs/RichTableCell.md)
 - [S3SourceRequest](docs/S3SourceRequest.md)
 - [S3Target](docs/S3Target.md)
 - [Script](docs/Script.md)
 - [Size](docs/Size.md)
 - [SourcesInner](docs/SourcesInner.md)
 - [SummaryMetaField](docs/SummaryMetaField.md)
 - [TableCell](docs/TableCell.md)
 - [TableCellsInner](docs/TableCellsInner.md)
 - [TableData](docs/TableData.md)
 - [TableFormerMode](docs/TableFormerMode.md)
 - [TabularChartMetaField](docs/TabularChartMetaField.md)
 - [Target](docs/Target.md)
 - [TargetName](docs/TargetName.md)
 - [TaskProcessingMeta](docs/TaskProcessingMeta.md)
 - [TaskStatusResponse](docs/TaskStatusResponse.md)
 - [TaskType](docs/TaskType.md)
 - [TrackSource](docs/TrackSource.md)
 - [TransformersModelType](docs/TransformersModelType.md)
 - [Uri](docs/Uri.md)
 - [ValidationError](docs/ValidationError.md)
 - [VlmConvertOptions](docs/VlmConvertOptions.md)
 - [VlmEngineType](docs/VlmEngineType.md)
 - [VlmModelApi](docs/VlmModelApi.md)
 - [VlmModelLocal](docs/VlmModelLocal.md)
 - [VlmModelSpec](docs/VlmModelSpec.md)
 - [VlmModelType](docs/VlmModelType.md)
 - [VlmPipelineCustomConfig](docs/VlmPipelineCustomConfig.md)
 - [ZipTarget](docs/ZipTarget.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="APIKeyAuth"></a>
### APIKeyAuth

- **Type**: API key
- **API key parameter name**: X-Api-Key
- **Location**: HTTP header


## Author




