Add DocSplitterClient and GenericUnstractClient support #5
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds support for two new API patterns to the apihub-python-client:
New Features
🔧 DocSplitterClient
upload()
,get_job_status()
,download_result()
,wait_for_completion()
job_id
for tracking operations🚀 GenericUnstractClient
process()
,get_result()
,wait_for_completion()
,check_status()
execution_id
for tracking operationsImplementation Details
ApiHubClientException
API Examples
DocSplitterClient Usage
GenericUnstractClient Usage
Files Changed
New Files:
src/apihub_client/doc_splitter.py
- DocSplitterClient implementationsrc/apihub_client/generic_client.py
- GenericUnstractClient implementationtest/test_doc_splitter.py
- DocSplitterClient tests (21 tests)test/test_generic_client.py
- GenericUnstractClient tests (34 tests)Modified Files:
src/apihub_client/__init__.py
- Export new clientsREADME.md
- Add usage examples and API documentationTesting
Backwards Compatibility
This PR is fully backwards compatible. Existing
ApiHubClient
functionality remains unchanged, and new clients are additive.Summary
The client now supports all three API patterns:
file_hash
trackingjob_id
trackingexecution_id
trackingAll functionality is production-ready with comprehensive testing and documentation.