Request Body
DocumentAsBase64Stringrequiredstring
A Base64 encoded string of the job order file bytes. This should use the standard 'base64' encoding as defined in RFC 4648 Section 4 (not the 'base64url' variant). .NET users can use the
Convert.ToBase64String(byte[]) method.SkillsSettingsoptionalobject
Enable skills normalization and specify the version of the skills taxonomy for this parsing transaction.
SkillsSettings.Normalizeoptionalbool
When true:
- Raw skills will be normalized. These will be output under
Value.JobData.Skills.Normalized. Read more about the benefits of using a skills taxonomy. - When
TaxonomyVersion(see below) is set to (or defaults to)V2, additional charges apply.
TaxonomyVersion is set to (or defaults to) V1.SkillsSettings.TaxonomyVersionoptionalstring
Specifies the version of the skills taxonomy to use. One of:
V1- Deprecated This is the default for old accounts. Will be removed in a future release.V2- This is the default for new accounts, and must be explicitly set if you have access to V1 and V2.
- 2x larger skills taxonomy, updated frequently based on real-world data.
- 15-40% higher accuracy of extracted skills.
- Better clustering of skill synonyms.
- Distinguish skill types (IT / Professional / Soft).
- Compatibility with the taxonomy used in Textkernel's Data Enrichment APIs and Jobfeed, enabling standardization of taxonomies across all of your data and benchmarking against jobs posted online.
ProfessionsSettingsoptionalobject
Enable normalization of job titles using our proprietary taxonomy and international standards.
ProfessionsSettings.Normalizeoptionalstring
When true, the job title will be normalized. This includes a proprietary value from our profession taxonomy, plus ONET and ISCO mappings. Read more about the benefits of using a professions taxonomy.
When enabling professions normalization, additional charges apply.
The following languages are supported: English, Chinese (Simplified), Dutch, French, German, Italian, Polish, Portuguese, and Spanish. For documents in other languages, no normalized values will be returned.
For Sovren AI Matching, normalized professions are automatically indexed and used when profession normalization is enabled during parsing (through IndexingOptions). To leverage profession normalization for user-created searches, enable profession normalization at query time.
The profession taxonomy and the mappings are compatible with the taxonomies used in Textkernel's Data Enrichment APIs and Jobfeed, enabling standardization of taxonomies across all of your data and benchmarking against jobs posted online.
When enabling professions normalization, additional charges apply.
The following languages are supported: English, Chinese (Simplified), Dutch, French, German, Italian, Polish, Portuguese, and Spanish. For documents in other languages, no normalized values will be returned.
For Sovren AI Matching, normalized professions are automatically indexed and used when profession normalization is enabled during parsing (through IndexingOptions). To leverage profession normalization for user-created searches, enable profession normalization at query time.
The profession taxonomy and the mappings are compatible with the taxonomies used in Textkernel's Data Enrichment APIs and Jobfeed, enabling standardization of taxonomies across all of your data and benchmarking against jobs posted online.
ProfessionsSettings.Versionoptionalobject
Specifies the versions to use when normalizing professions if more than one is available for a taxonomy.
ProfessionsSettings.Version.ONEToptionalstring
The ONET Version to use when normalizing professions. One of:
- 2010
- 2019
DocumentLastModifiedrequiredstring
Mandatorydate, in YYYY-MM-DD format, representing the "current" or "as of" date used during parsing. This is useful when parsing older documents. Read more about this here.
OutputHtmloptionalboolean
When true, the original file is converted to HTML and stored in the Html property.
OutputRtfoptionalboolean
When true, the original file is converted to RTF and stored in the Rtf property.
OutputPdfoptionalboolean
When true, the original file is converted to PDF and stored in the Pdf property as a byte array.
Configurationoptionalobject
Options that influence parser behavior.
Configuration.CountryCodeoptionalstring
A 2-letter ISO 3166 code (or comma-delimited list of such codes) indicating the country to be assumed in cases where the location cannot be automatically detected. If multiple codes are specified, the first one is given the highest priority.
Configuration.Languageoptionalstring
An ISO 639-1 two letter language code indicating the language to be assumed in cases where the language cannot be automatically detected.
Configuration.KnownTypeoptionalstring
Optionally specify a known type to enable special processing. Possible values include:
- Indeed
- Stride
- JOB_SUBMISSION_REPLY_TO_CANDIDATE
Configuration.IncludeRecruitingTermsoptionalboolean
Recruiting terms in skills and job titles are ignored by default, because these terms often appear in job orders that are unrelated to recruiting. If this job order is for a recruiting or human resources position, then set this to true.
Configuration.IncludeSupplementalTextoptionalboolean
The parser defaults to extracting data from only the text that precedes the place in job orders where they transition from describing the job itself to describing the company, hiring policies, background checks, benefits, etc. This division of text normally works well, but in some job orders it can occur in the wrong place. Set this to true to allow the parser to extract data from all of the text.
Configuration.PreferShorterJobTitlesoptionalboolean
The parser defaults to returning full job titles. Setting this option to true will shorten job titles by excluding trailing phrases that do not include job words, so that "Vice President" would be returned instead of "Vice President, Information Systems".
SkillsDataoptionalstring[]
Unavailable except in special cases. Please reach out tosupport@sovren.com.String[] of your custom skills list names and the Sovren "builtin" skills list. If no list is provided the Sovren builtin skills list will be used. The parser automatically detects language and looks for a corresponding skills list in that language, if no match is found this list is ignored.
GeocodeOptionsoptionalobject
Get or insert geocode coordinate values (latitude/longitude) during the parse transaction.
GeocodeOptions.IncludeGeocodingoptionalbool
When set to true we will automatically geocode the address that is parsed out leveraging an api call to our
/geocodeendpoint,and thus will be charged accordingly. This parameter defaults to false.GeocodeOptions.Provideroptionalstring
The Provider you wish to use to geocode the postal address (current options are "Google", "Bing", or "None"). If not specified, we will default to Google. If you are just trying to update the postal address in the document, please set this to "None".
If passing "Google" or "Bing", ProviderKey is requried.
If passing "Google" or "Bing", ProviderKey is requried.
GeocodeOptions.ProviderKeyoptionalstring
The Provider Key for the specified Provider. If using Bing you must specify your own provider key.
GeocodeOptions.PostalAddressoptionalobject
The postal address you wish to geocode. For best results, specify as many of the PostalAddress fields as possible. If provided, this address will be used to get the geocode coordinates instead of the address included in the ParsedDocument (if present), however, the address in the ParsedDocument will not be modified.
GeocodeOptions.PostalAddress.CountryCodeoptionalstring
The ISO 3166-1 alpha-2 code indicating the country for the postal address.
GeocodeOptions.PostalAddress.PostalCodeoptionalstring
The postal code (or zip code) for the postal address
GeocodeOptions.PostalAddress.Regionoptionalstring
The region (i.e. State for U.S. addresses) for the postal address.
GeocodeOptions.PostalAddress.Municipalityoptionalstring
The municipality (i.e. City for U.S. addresses) for the postal address
GeocodeOptions.PostalAddress.AddressLineoptionalstring
The address line (i.e. Street address for U.S. address) for the postal address
GeocodeOptions.GeoCoordinatesoptionalobject
The geographic coordinates (latitude/longitude) for your postal address. Use this if you already have latitude/longitude coordinates and simply wish to add them to your parsed document. If provided, these values will be inserted into your ParsedDocument and the address included in the ParsedDocument (if present), will not be modified.
GeocodeOptions.GeoCoordinates.Latitudeoptionalfloat
The latitude coordinate value.
GeocodeOptions.GeoCoordinates.Longitudeoptionalfloat
The longitude coordinate value.
IndexingOptionsoptionalobject
When your account is enabled for Matching/Searching you can automatically index documents during the parse transactions.
Skills Normalization must be included to index documents using V2 Skills Taxonomy. These algorithms ignore raw skills and only consider the normalized skill concepts for skills category scoring. This leads to improved scoring and ranking because normalization produces less false negatives than simple exact keyword matching.
Skills Normalization must be included to index documents using V2 Skills Taxonomy. These algorithms ignore raw skills and only consider the normalized skill concepts for skills category scoring. This leads to improved scoring and ranking because normalization produces less false negatives than simple exact keyword matching.
IndexingOptions.IndexIdoptionalstring
When your account is enabled for Matching/Searching you can automatically index documents during the parse transactions. This determines what index to place the parsed document in. This is case-insensitive.
IndexingOptions.DocumentIdoptionalstring
When your account is enabled for Matching/Searching you can automatically index documents during the parse transactions. This determines what id to give to the parsed document. This is restricted to alphanumeric with dashes and underscores. All values will be converted to lower-case.
IndexingOptions.UserDefinedTagsoptionalstring[]
The user-defined tags you want the document to have.