affinda 1.7.0

Client library for the Affinda API

Python Client Library for Affinda Resume Parser API

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 for additional information.

Installation

pip install affinda

Quickstart

If you don't have an API token, obtain one from affinda.com.

from affinda import AffindaAPI, TokenCredential

credential = TokenCredential(token="YOUR_API_TOKEN")
client = AffindaAPI(credential=credential)

with open("PATH_TO_FILE", "rb") as f:
    resume = client.create_resume(file=f)

Samples

Samples for all operations using the client can be found here.

API reference

• API operations can be found here
• API models and objects
• Exceptions

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]

[1.7.0] - 2023-01-10

Added

• Add rectangles to Annotation, add position to referee, add actions to JobDescriptionSearchConfig

[1.6.0] - 2023-01-09

Fixed

• Bump version to force new release

[1.5.1] - 2023-01-08

Changed

• Allowing a few more fields in ResumeData to be null

[1.5.0] - 2022-11-17

Fixed

• Document meta pages without images should be nullable
• Small fixes for accreditiation and education return objects
• Various nullable fields in the API spec

Security

• Bumped package versions for patch reasons

Added

• Add reject_duplicates to document upload endpoint
• XML 404 response schema
• CustomData to resume search spec
• suggest skills and job titles endpoints

Changed

• Update spec to allow XML content-type return from resumes, make totalYearsExperience nullable
• Allow additonalproperties for custom data upload (resumes) and search

[1.4.2] - 2022-09-23

Changed

• Update API spec to match API response.

[1.4.1] - 2022-09-23

Added

• Add job description search config and embed endpoints
• Update index endpoint with document type parameter

Fixed

• Fix casing of some properties to match API response.

[1.4.0] - 2022-08-25

Changed

• Update modelerfour version to latest
• Update types of objects for some endpoints using AllOf attributes for better client library generation
• Changed and updated tag order to better match documentation needs
• Updated autorest client version

Deprecated

• Depreciated resume_formats and reformatted_resumes endpoints

Added

• Reverse match functionality - search job descriptions with a resume, or with a set of parameters.

[1.3.1] - 2022-08-10

Added

• Add search expression to 1v1 match

[1.3.0] - 2022-07-27

Added

• Add ability to find other candidates that have similar attributes to a resume
• Add an endpoint to get the matching score between a resume and a job description

[1.2.0] - 2022-07-04

Added

• add "tables" property to InvoiceData

[1.1.0] - 2022-07-03

Added

• Ability to update resume data in the search system
• New endpoint for creating and managing users within a master account

[1.0.2] - 2022-05-07

Fixed

• Make expiry time native date time

[1.0.1] - 2022-05-01

Added

• Add review URL in the invoice response that allows embedding of the Affinda Invoice Review UI

[1.0.0] - 2022-04-28

Added

• added confidence

Changed

• changed strings to objects

[0.4.1] - 2022-04-19

Fixed

• Fixes bug in create_invoice when URL is not specified

[0.4.0] - 2022-04-13

Changed

• Update autorest depedencies

[0.3.0] - 2022-04-06

Added

• Resume search

[0.2.2] - 2022-03-25

Added

• Add iso 3166 country code to locations

[0.2.1] - 2021-12-09

Added

• Bump version

[0.2.0] - 2021-10-06

Added

• Invoices endpoint

Removed

• Removed 'url' format from url strings in api spec

[0.1.13] - 2021-10-05

Changed

• Pin azure-core to 1.18.0

[0.1.12] - 2021-10-05

Changed

• Pin azure-core

[0.1.11] - 2021-10-05

Changed

• Pinning azure-core dependency due to incompatible changes in 1.19

[0.1.10] - 2021-09-30

Added

• Adding LinkedIn to ResumeData

Changed

• Reformatted code with black
• Minor changes
• Very minor formatting changes

[0.1.9] - 2021-09-08

Added

• Profession in ResumeData model
• Unified Error models

[0.1.8] - 2021-09-06

Fixed

• wait=true in API spec

[0.1.7] - 2021-09-05

Fixed

• Code samples naming conversion

[0.1.6] - 2021-09-05

Changed

• Description of some endpoints to match updats in API spec
• Moved samples to their own ./docs/samples_python.md file

[0.1.5] - 2021-08-25

Added

• Added flake, editorconfig, tox.ini etc files to match best practices for existing Draftable/Affinda projects (thanks
• @ralish!)

[0.1.4] - 2021-08-18

Fixed

• Update README.md to fix install instructions

[0.1.3] - 2021-08-18

Fixed

• Update README.md to hard link to github hosted logo to fix display on PyPi

[0.1.2] - 2021-08-18

• Initial release

The MIT License (MIT)

Copyright (c) Affinda

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.