https://github.com/affinda/affinda-python
Python client library for the Affinda API
https://github.com/affinda/affinda-python
affinda api python
Last synced: 8 months ago
JSON representation
Python client library for the Affinda API
- Host: GitHub
- URL: https://github.com/affinda/affinda-python
- Owner: affinda
- License: mit
- Created: 2021-08-09T04:41:55.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2025-03-31T03:59:01.000Z (over 1 year ago)
- Last Synced: 2025-03-31T04:28:07.528Z (over 1 year ago)
- Topics: affinda, api, python
- Language: Python
- Homepage: https://affinda.com
- Size: 2.88 MB
- Stars: 9
- Watchers: 5
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Python Client Library for Affinda Document Parser API
[](https://pypi.org/project/affinda/)
[](https://pypi.org/affinda/)
[](https://pypi.org/project/affinda/)
[](https://choosealicense.com/licenses/mit/)
[](https://github.com/psf/black)
[](https://open.vscode.dev/affinda/affinda-python)
This is a python client for the Affinda document parsing API which wraps all available endpoints
and handles authentication and signing. You may also want to refer to the full
[API documentation](https://api.affinda.com/docs) for additional information.
## Installation
```shell
pip install affinda
```
## API Version Compatibility
The Affinda API is currently on `v3`, with breaking changes meant the release of new versions of the client library.
Please see below for which versions are compatible with which API version.
| Affinda API version | `affinda-python` versions |
| ------------------- | ------------------------- |
| v2 | 0.1.0 - 3.x.x |
| v3 | \>= 4.x.x |
## Quickstart
Before using the API, you need to create an account, setup a workspace, and obtain an API key.
Follow the steps in our [documentation](https://docs.affinda.com/docs/getting-started-with-affinda).
```python
from pathlib import Path
from affinda import AffindaAPI, TokenCredential
API_KEY = "YOUR_API_KEY" # replace with your actual key
WORKSPACE_ID = "YOUR_WORKSPACE_IDENTIFIER" # e.g. "vBAdDBer"
FILE_PATH = Path("resume.pdf") # path to the résumé you want to parse
# Set up the client
credential = TokenCredential(token=API_KEY)
client = AffindaAPI(credential=credential)
# Upload the document and wait until processing finishes
with FILE_PATH.open("rb") as f:
doc = client.create_document(
file=f,
workspace=WORKSPACE_ID,
)
# Access parsed data
print(doc.data)
```
## Pydantic models
You can generate pydantic models to help with validating and consuming the API response in a type-safe way.
Use the `generate_models` command to auto-generate pydantic models from your document type configuration.
For example, this will generate pydantic models for your "Resume Parser" document type:
```bash
# Assuming your Resume Parser document type ID is "rLERIsHk"
python -m affinda generate_models --document-type-id=rLERIsHk
```
You will be prompted for your API key, unless you already have the `AFFINDA_API_KEY` environment variable set.
The generated pydantic model(s) will be in `./affinda_models` by default.
For all the options you can use, run:
```bash
python -m affinda generate_models --help
```
Example of using the generated pydantic models:
```python
from pathlib import Path
from affinda import AffindaAPI, TokenCredential
from affinda_models.resume_parser import ResumeParser
API_KEY = "YOUR_API_KEY" # replace with your actual key
WORKSPACE_ID = "YOUR_WORKSPACE_IDENTIFIER" # e.g. "vBAdDBer"
FILE_PATH = Path("resume.pdf") # path to the résumé you want to parse
# Set up the client
credential = TokenCredential(token=API_KEY)
client = AffindaAPI(credential=credential)
# This will raise `pydantic_core.ValidationError` if the API response does not validate against ResumeParser
with FILE_PATH.open("rb") as f:
doc = client.create_document(
file=f,
workspace=WORKSPACE_ID,
data_model=ResumeParser,
)
# Access parsed data
print(doc.parsed) # This is a ResumeParser instance
print(doc.data) # This is the raw JSON response
# This will NOT raise `pydantic_core.ValidationError` if the API response does not validate against ResumeParser.
# Instead `parsed` will be None if the API response is not compatible.
with FILE_PATH.open("rb") as f:
doc = client.create_document(
file=f,
workspace=WORKSPACE_ID,
data_model=ResumeParser,
ignore_validation_errors=True,
)
if doc.parsed:
print("API response is valid.")
print(doc.parsed)
else:
print("API response is invalid.")
print(doc.data) # The raw JSON response is still available
```
## Samples
Samples for all operations using the client can be [found here.](./docs/samples_python.md)
## API reference
- [API operations can be found here](./docs/sync_operations.md)
- [API models and objects](./docs/models.md)
- [Exceptions](./docs/exceptions.md)