Common Parameters
- Pascal Himmel (Unlicensed)
- HelpdeskJV
Both the SOAP and REST web service API share common parameters for extractions models, document types, and target language. REST, in addition, offers the output in different formats. On this page the different common parameters are listed and explained.
Extraction Model
JoinVision currently provides the following semantic extraction models:
Value | Description | Documentation |
|---|---|---|
cvlizer_3_0 | Extracts CVs | |
jobolizer_3_0 | Extracts single job offers | |
cvlizer_hrxml_2_5 | Extracts CVs in HR-XML standard 2.5 | |
jobolizer_hrxml_2_5 | Extracts single job offers in HR-XML standard 2.5 |
Target Language
This parameter defines the preferred language in which the long-values for the extracted abstraction codes (skills, operation areas, education leve, etc.) are returned.
Supported languages are:
Value | Description |
|---|---|
en | English (default) |
de | German |
fr | French |
nativ | Instead of the classified long-value, the original text from the document will be returned |
Output Format (REST interface only)
Output Format defines the format for the response. The following formats are currently supported:
Value | Description |
|---|---|
json | returns a JSON object |
xml | returns an XML object |
Document Type (CVlizer Classifier and Merger only)
The following document types are provided when using Classifier or Merger:
Value | Description |
|---|---|
cv | Curriculum Vitae |
application | Letter of application, covering letter |
schoolreport | School report, report card |
recommendation | Recommendation letter, employment reference |
certificate | (Course-) Certificate |
cover | Cover sheet |
unclassified | Non-classifiable document/page |
Common SOAP Objects
The object types shown here are Java specific. Please consult the documentation of your preferred programming language on how to serialize a similar type.
InputDoc
Property | Type | Description |
|---|---|---|
filename | String | The filename of the document |
data | byte[] | The binary data of the document |
OutputDoc
Property | Type | Description |
|---|---|---|
sourceFilename | String | Filename of the original document |
data | byte[] | The binary data of the document |
documentType | String | The classified document type |
ocr | Boolean | True if document has been OCR converted |
pages | Integer | The amount of pages |
plainText | String | The plaintext of the document |
StringContainer
Property | Type | Description |
|---|---|---|
strings | List<String> | Data transfer object for Strings |