Resume V1
Sample Code:
- class ResumeV1(raw_prediction)
Resume API version 1 inference prediction.
- static get_endpoint_info(klass)
Retrives the endpoint information for an Inference.
Should never retrieve info for CustomV1, as a custom endpoint should be created to use CustomV1.
- Parameters:
klass (
Type[Inference]) – product subclass to access endpoint information.- Return type:
Dict[str,str]
- endpoint_name: Optional[str] = 'resume'
Name of the endpoint.
- endpoint_version: Optional[str] = '1'
Version of the endpoint.
- is_rotation_applied: Optional[bool]
Whether the document has had any rotation applied to it.
- page_id: Optional[int]
Optional page id for page-level predictions.
-
pages:
List[Page[ResumeV1Document]] Page-level prediction(s).
-
prediction:
ResumeV1Document Document-level prediction.
- product: Product
Name and version of a given product, as sent back by the API.
- class ResumeV1Document(raw_prediction, page_id=None)
Resume API version 1.1 document data.
- Parameters:
raw_prediction (Dict[str, Any]) –
page_id (Optional[int]) –
-
address:
StringField The location information of the candidate, including city, state, and country.
-
certificates:
List[ResumeV1Certificate] The list of certificates obtained by the candidate.
-
document_language:
StringField The ISO 639 code of the language in which the document is written.
-
document_type:
ClassificationField The type of the document sent.
-
education:
List[ResumeV1Education] The list of the candidate’s educational background.
-
email_address:
StringField The email address of the candidate.
-
given_names:
List[StringField] The candidate’s first or given names.
-
hard_skills:
List[StringField] The list of the candidate’s technical abilities and knowledge.
-
job_applied:
StringField The position that the candidate is applying for.
-
languages:
List[ResumeV1Language] The list of languages that the candidate is proficient in.
-
nationality:
StringField The ISO 3166 code for the country of citizenship of the candidate.
-
phone_number:
StringField The phone number of the candidate.
-
profession:
StringField The candidate’s current profession.
-
professional_experiences:
List[ResumeV1ProfessionalExperience] The list of the candidate’s professional experiences.
-
social_networks_urls:
List[ResumeV1SocialNetworksUrl] The list of social network profiles of the candidate.
-
soft_skills:
List[StringField] The list of the candidate’s interpersonal and communication abilities.
-
surnames:
List[StringField] The candidate’s last names.
- class ResumeV1SocialNetworksUrl(raw_prediction, page_id=None)
The list of social network profiles of the candidate.
- Parameters:
raw_prediction (Dict[str, Any]) –
page_id (Optional[int]) –
- to_table_line()
Output in a format suitable for inclusion in an rST table.
- Return type:
str
- bounding_box: Optional[Quadrilateral]
A right rectangle containing the word in the document.
- confidence: float
The confidence score.
-
name:
Optional[str] The name of the social network.
-
page_n:
int The document page on which the information was found.
- polygon: Polygon
A polygon containing the word in the document.
-
url:
Optional[str] The URL of the social network.
- class ResumeV1Language(raw_prediction, page_id=None)
The list of languages that the candidate is proficient in.
- Parameters:
raw_prediction (Dict[str, Any]) –
page_id (Optional[int]) –
- to_table_line()
Output in a format suitable for inclusion in an rST table.
- Return type:
str
- bounding_box: Optional[Quadrilateral]
A right rectangle containing the word in the document.
- confidence: float
The confidence score.
-
language:
Optional[str] The language’s ISO 639 code.
-
level:
Optional[str] The candidate’s level for the language.
-
page_n:
int The document page on which the information was found.
- polygon: Polygon
A polygon containing the word in the document.
- class ResumeV1Education(raw_prediction, page_id=None)
The list of the candidate’s educational background.
- Parameters:
raw_prediction (Dict[str, Any]) –
page_id (Optional[int]) –
- to_table_line()
Output in a format suitable for inclusion in an rST table.
- Return type:
str
- bounding_box: Optional[Quadrilateral]
A right rectangle containing the word in the document.
- confidence: float
The confidence score.
-
degree_domain:
Optional[str] The area of study or specialization.
-
degree_type:
Optional[str] The type of degree obtained, such as Bachelor’s, Master’s, or Doctorate.
-
end_month:
Optional[str] The month when the education program or course was completed.
-
end_year:
Optional[str] The year when the education program or course was completed.
-
page_n:
int The document page on which the information was found.
- polygon: Polygon
A polygon containing the word in the document.
-
school:
Optional[str] The name of the school.
-
start_month:
Optional[str] The month when the education program or course began.
-
start_year:
Optional[str] The year when the education program or course began.
- class ResumeV1ProfessionalExperience(raw_prediction, page_id=None)
The list of the candidate’s professional experiences.
- Parameters:
raw_prediction (Dict[str, Any]) –
page_id (Optional[int]) –
- to_table_line()
Output in a format suitable for inclusion in an rST table.
- Return type:
str
- bounding_box: Optional[Quadrilateral]
A right rectangle containing the word in the document.
- confidence: float
The confidence score.
-
contract_type:
Optional[str] The type of contract for the professional experience.
-
department:
Optional[str] The specific department or division within the company.
-
description:
Optional[str] The description of the professional experience as written in the document.
-
employer:
Optional[str] The name of the company or organization.
-
end_month:
Optional[str] The month when the professional experience ended.
-
end_year:
Optional[str] The year when the professional experience ended.
-
page_n:
int The document page on which the information was found.
- polygon: Polygon
A polygon containing the word in the document.
-
role:
Optional[str] The position or job title held by the candidate.
-
start_month:
Optional[str] The month when the professional experience began.
-
start_year:
Optional[str] The year when the professional experience began.
- class ResumeV1Certificate(raw_prediction, page_id=None)
The list of certificates obtained by the candidate.
- Parameters:
raw_prediction (Dict[str, Any]) –
page_id (Optional[int]) –
- to_table_line()
Output in a format suitable for inclusion in an rST table.
- Return type:
str
- bounding_box: Optional[Quadrilateral]
A right rectangle containing the word in the document.
- confidence: float
The confidence score.
-
grade:
Optional[str] The grade obtained for the certificate.
-
name:
Optional[str] The name of certification.
-
page_n:
int The document page on which the information was found.
- polygon: Polygon
A polygon containing the word in the document.
-
provider:
Optional[str] The organization or institution that issued the certificate.
-
year:
Optional[str] The year when a certificate was issued or received.