| Package | Description |
|---|---|
| com.textkernel.tx.exceptions | |
| com.textkernel.tx.services |
| Modifier and Type | Class and Description |
|---|---|
class |
TxGeocodeJobException
This exception is thrown when an error happens during geocoding, but the service was still able to produce a usable Job object (see the
Response property) |
class |
TxGeocodeResumeException
This exception is thrown when an error happens during geocoding, but the service was still able to produce a usable Resume object (see the
Response property) |
class |
TxIndexJobException
This exception is thrown when an error happens during indexing, but the service was still able to produce a usable Job object (see the
Response property) |
class |
TxIndexResumeException
This exception is thrown when an error happens during indexing, but the service was still able to produce a usable Resume object (see the
Response property) |
class |
TxProfessionNormalizationJobException
This exception is thrown when an error happens during indexing, but the service was still able to produce a usable Job object (see the
Response property) |
class |
TxProfessionNormalizationResumeException
This exception is thrown when an error happens during indexing, but the service was still able to produce a usable Resume object (see the
Response property) |
class |
TxUsableJobException
This exception is thrown when an error happens, but the service was still able to produce a usable Resume object (see the
Response property) |
class |
TxUsableResumeException
This exception is thrown when an error happens, but the service was still able to produce a usable Resume object (see the
Response property) |
| Modifier and Type | Method and Description |
|---|---|
AddCandidateResponse |
MatchV2Service.addCandidate(String documentId,
ParsedResume resume,
List<String> roles,
boolean anonymize,
Map<String,String> customFields)
Upload a candidates CV to the search and match V2 environment.
|
AddJobResponse |
MatchV2Service.addJob(String documentId,
ParsedJob job,
List<String> roles,
Map<String,String> customFields)
Upload a job to the search and match V2 environment.
|
AutocompleteResponse |
MatchV2Service.autocompleteCandidates(AutocompleteCandidatesField field,
String input,
String... languages)
Returns a list of suggested Completions.
|
AutocompleteResponse |
MatchV2Service.autocompleteJobs(AutocompleteJobsField field,
String input,
String... languages)
Returns a list of suggested Completions.
|
ProfessionsAutoCompleteResponse |
SkillsIntelligenceService.autocompleteProfession(String prefix)
Returns normalized professions that begin with a given prefix, based on the default language of english.
|
ProfessionsAutoCompleteResponse |
SkillsIntelligenceService.autocompleteProfession(String prefix,
List<String> languages,
String outputLanguage,
int limit)
Returns normalized professions that begin with a given prefix, based on the chosen language(s).
|
AutoCompleteSkillsResponse |
SkillsIntelligenceService.autocompleteSkill(String prefix)
Returns normalized skills that begin with a given prefix, based on the chosen language(s).
|
AutoCompleteSkillsResponse |
SkillsIntelligenceService.autocompleteSkill(String prefix,
List<String> languages,
String outputLanguage,
List<String> types,
int limit)
Returns normalized skills that begin with a given prefix, based on the chosen language(s).
|
<TTarget extends IParsedDocWithId> |
SearchMatchService.bimetricScore(ParsedJobWithId sourceJob,
List<TTarget> targetDocuments,
CategoryWeights preferredWeights,
SearchMatchSettings settings)
Score one or more target documents against a source job
|
<TTarget extends IParsedDocWithId> |
SearchMatchService.bimetricScore(ParsedResumeWithId sourceResume,
List<TTarget> targetDocuments,
CategoryWeights preferredWeights,
SearchMatchSettings settings)
Score one or more target documents against a source resume
|
CompareProfessionsResponse |
SkillsIntelligenceService.compareProfessions(int profession1,
int profession2,
String outputLanguage)
Compare two professions based on the skills associated with each.
|
CompareSkillsToProfessionResponse |
SkillsIntelligenceService.compareSkillsToProfessions(int professionCodeId,
String outputLanguage,
List<SkillScore> skills)
Compare a given set of skills to the skills related to a given profession.
|
CompareSkillsToProfessionResponse |
SkillsIntelligenceService.compareSkillsToProfessions(ParsedResume resume,
int professionCodeId,
String outputLanguage,
boolean weightSkillsByExperience)
Compare the skills of a candidate to the skills related to a job using the Ontology API.
|
CreateIndexResponse |
SearchMatchService.createIndex(IndexType type,
String indexId)
Create a new index
|
DeleteDocumentsResponse |
MatchV2Service.deleteCandidates(List<String> documentIds)
Delete candidate documents from environment
|
DeleteDocumentResponse |
SearchMatchService.deleteDocument(String indexId,
String documentId)
Delete an existing document from an index
|
DeleteIndexResponse |
SearchMatchService.deleteIndex(String indexId)
Delete an existing index.
|
DeleteDocumentsResponse |
MatchV2Service.deleteJobs(List<String> documentIds)
Delete job documents from environment
|
DeleteMultipleDocumentsResponse |
SearchMatchService.deleteMultipleDocuments(String indexId,
List<String> documentIds)
Delete a group of existing documents from an index
|
ExtractSkillsResponse |
SkillsIntelligenceService.extractSkills(String text)
Extracts known skills from the given text.
|
ExtractSkillsResponse |
SkillsIntelligenceService.extractSkills(String text,
String language,
String outputLanguage,
float threshold)
Extracts known skills from the given text.
|
FormatResumeResponse |
FormatterService.formatResume(FormatResumeRequest request)
Format a resume into a standardized template that you provide
|
GenerateJobResponse |
SkillsIntelligenceService.generateJobDescription(GenerateJobRequest request)
Generates a job description based on specified parameters.
|
GeocodeJobResponse |
GeocoderService.geocode(ParsedJob job,
Address address,
GeocodeCredentials geocodeCredentials)
Use this if you would like to provide an address for geocoding instead of using the one in the parsed
job.
|
GeocodeJobResponse |
GeocoderService.geocode(ParsedJob job,
GeocodeCredentials geocodeCredentials)
Uses the address in the job (if present) to look up geocoordinates and add them into the ParsedJob object.
|
GeocodeResumeResponse |
GeocoderService.geocode(ParsedResume resume,
Address address,
GeocodeCredentials geocodeCredentials)
Use this if you would like to provide an address for geocoding instead of using the one in the parsed
resume.
|
GeocodeResumeResponse |
GeocoderService.geocode(ParsedResume resume,
GeocodeCredentials geocodeCredentials)
Uses the address in the resume (if present) to look up geocoordinates and add them into the ParsedResume object.
|
GeocodeAndIndexJobResponse |
GeocoderService.geocodeAndIndex(ParsedJob job,
IndexingOptionsGeneric indexingOptions,
Address address,
boolean indexIfGeocodeFails,
GeocodeCredentials geocodeCredentials)
Use this if you would like to provide an address for geocoding instead of using the one in the parsed
rjobesume.
|
GeocodeAndIndexJobResponse |
GeocoderService.geocodeAndIndex(ParsedJob job,
IndexingOptionsGeneric indexingOptions,
boolean indexIfGeocodeFails,
GeocodeCredentials geocodeCredentials)
Uses the address in the job (if present) to look up geocoordinates and add them into the ParsedJob object.
|
GeocodeAndIndexJobResponse |
GeocoderService.geocodeAndIndex(ParsedJob job,
IndexingOptionsGeneric indexingOptions,
GeoCoordinates coordinates,
boolean indexIfGeocodeFails,
GeocodeCredentials geocodeCredentials)
Use this if you already have latitude/longitude coordinates and simply wish to add them to your parsed job.
|
GeocodeAndIndexResumeResponse |
GeocoderService.geocodeAndIndex(ParsedResume resume,
IndexingOptionsGeneric indexingOptions,
Address address,
boolean indexIfGeocodeFails,
GeocodeCredentials geocodeCredentials)
Use this if you would like to provide an address for geocoding instead of using the one in the parsed
resume.
|
GeocodeAndIndexResumeResponse |
GeocoderService.geocodeAndIndex(ParsedResume resume,
IndexingOptionsGeneric indexingOptions,
boolean indexIfGeocodeFails,
GeocodeCredentials geocodeCredentials)
Uses the address in the resume (if present) to look up geocoordinates and add them into the ParsedResume object.
|
GeocodeAndIndexResumeResponse |
GeocoderService.geocodeAndIndex(ParsedResume resume,
IndexingOptionsGeneric indexingOptions,
GeoCoordinates coordinates,
boolean indexIfGeocodeFails,
GeocodeCredentials geocodeCredentials)
Use this if you already have latitude/longitude coordinates and simply wish to add them to your parsed resume.
|
GetAccountInfoResponse |
AccountService.getAccountInfo()
Get the account info (remaining credits, max concurrency, etc).
|
GetAllIndexesResponse |
SearchMatchService.getAllIndexes()
Get all existing indexes
|
GetJobResponse |
SearchMatchService.getJob(String indexId,
String documentId)
Retrieve an existing job from an index
|
GetProfessionsTaxonomyResponse |
SkillsIntelligenceService.getProfessionsTaxonomy()
Get all professions in the taxonomy with associated IDs and descriptions in all supported languages.
|
GetProfessionsTaxonomyResponse |
SkillsIntelligenceService.getProfessionsTaxonomy(String language,
TaxonomyFormat format)
Get all professions in the taxonomy with associated IDs and descriptions in all supported languages.
|
GetMetadataResponse |
SkillsIntelligenceService.getProfessionsTaxonomyMetadata()
Get metadata about the professions taxonomy/service.
|
GetResumeResponse |
SearchMatchService.getResume(String indexId,
String documentId)
Retrieve an existing resume from an index
|
GetSkillsTaxonomyResponse |
SkillsIntelligenceService.getSkillsTaxonomy()
Get all skills in the taxonomy with associated IDs and descriptions in all supported languages.
|
GetSkillsTaxonomyResponse |
SkillsIntelligenceService.getSkillsTaxonomy(TaxonomyFormat format)
Get all skills in the taxonomy with associated IDs and descriptions in all supported languages.
|
GetMetadataResponse |
SkillsIntelligenceService.getSkillsTaxonomyMetadata()
Get metadata about the skills taxonomy/service.
|
IndexDocumentResponse |
SearchMatchService.indexDocument(ParsedJob job,
String indexId,
String documentId,
List<String> userDefinedTags)
Add a job to an existing index
|
IndexDocumentResponse |
SearchMatchService.indexDocument(ParsedResume resume,
String indexId,
String documentId,
List<String> userDefinedTags)
Add a resume to an existing index
|
IndexMultipleDocumentsResponse |
SearchMatchService.indexMultipleJobs(List<IndexJobInfo> jobs,
String indexId)
Add several jobs to an existing index
|
IndexMultipleDocumentsResponse |
SearchMatchService.indexMultipleResumes(List<IndexResumeInfo> resumes,
String indexId)
Add several resumes to an existing index
|
LookupProfessionCodesResponse |
SkillsIntelligenceService.lookupProfessions(List<Integer> codeIds)
Get details for the given professions in the taxonomy.
|
LookupProfessionCodesResponse |
SkillsIntelligenceService.lookupProfessions(List<Integer> codeIds,
String outputLanguage)
Get details for the given professions in the taxonomy.
|
LookupSkillCodesResponse |
SkillsIntelligenceService.lookupSkills(List<String> skillIds)
Get the details associated with given skills in the taxonomy.
|
LookupSkillCodesResponse |
SkillsIntelligenceService.lookupSkills(List<String> skillIds,
String outputLanguage)
Get the details associated with given skills in the taxonomy.
|
MatchResponse |
SearchMatchService.match(ParsedJob job,
List<String> indexesToQuery,
CategoryWeights preferredWeights,
FilterCriteria filters,
SearchMatchSettings settings,
int numResults)
Find matches for a non-indexed job.
|
MatchResponse |
SearchMatchService.match(ParsedResume resume,
List<String> indexesToQuery,
CategoryWeights preferredWeights,
FilterCriteria filters,
SearchMatchSettings settings,
int numResults)
Find matches for a non-indexed resume.
|
MatchResponse |
SearchMatchService.match(String indexId,
String documentId,
List<String> indexesToQuery,
CategoryWeights preferredWeights,
FilterCriteria filters,
SearchMatchSettings settings,
int numResults)
Find matches for a resume or job that is already indexed
|
SearchResponse |
MatchV2Service.matchCandidates(DocumentSource sourceDocument,
Options options,
SearchQuery query)
Match an existing candidate document with filters provided.
|
SearchResponse |
MatchV2Service.matchJobs(DocumentSource sourceDocument,
Options options,
SearchQuery query)
Match an existing job document with filters provided.
|
NormalizeProfessionsResponse |
SkillsIntelligenceService.normalizeProfessions(List<String> jobTitles)
Normalize the given job titles to the most closely-related professions in the taxonomy.
|
NormalizeProfessionsResponse |
SkillsIntelligenceService.normalizeProfessions(List<String> jobTitles,
String language,
String outputLanguage)
Normalize the given job titles to the most closely-related professions in the taxonomy.
|
NormalizeSkillsResponse |
SkillsIntelligenceService.normalizeSkills(List<String> skills)
Normalize the given skills to the most closely-related skills in the taxonomy.
|
NormalizeSkillsResponse |
SkillsIntelligenceService.normalizeSkills(List<String> skills,
String language,
String outputLanguage)
Normalize the given skills to the most closely-related skills in the taxonomy.
|
ParseJobResponse |
ParserService.parseJob(ParseRequest request)
Parse a job
|
ParseResumeResponse |
ParserService.parseResume(ParseRequest request)
Parse a resume
|
SearchResponse |
SearchMatchService.search(List<String> indexesToQuery,
FilterCriteria query,
SearchMatchSettings settings,
PaginationSettings pagination)
Search for resumes or jobs that meet specific criteria
|
SearchResponse |
MatchV2Service.searchCandidates(SearchQuery query,
Options options)
Search for a candidate based on the query provided.
|
SearchResponse |
MatchV2Service.searchJobs(SearchQuery query,
Options options)
Search for a job based on the query provided.
|
SkillsSimilarityScoreResponse |
SkillsIntelligenceService.skillsSimilarityScore(List<SkillScore> skillSetA,
List<SkillScore> skillSetB)
Determines how closely related one set of skills is to another.
|
SuggestProfessionsResponse |
SkillsIntelligenceService.suggestProfessionsFromSkills(List<SkillScore> skills,
int limit,
boolean returnMissingSkills,
String outputLanguage)
Suggest professions based on a given set of skills.
|
SuggestProfessionsResponse |
SkillsIntelligenceService.suggestProfessionsFromSkills(List<String> skillIds,
String outputLanguage)
Suggest professions based on a given set of skill IDs.
|
SuggestProfessionsResponse |
SkillsIntelligenceService.suggestProfessionsFromSkills(ParsedJob job)
Suggest professions based on the skills within a given job.
|
SuggestProfessionsResponse |
SkillsIntelligenceService.suggestProfessionsFromSkills(ParsedJob job,
int limit,
boolean returnMissingSkills,
String outputLanguage)
Suggest professions based on the skills within a given job.
|
SuggestProfessionsResponse |
SkillsIntelligenceService.suggestProfessionsFromSkills(ParsedJob job,
String outputLanguage)
Suggest professions based on the skills within a given job.
|
SuggestProfessionsResponse |
SkillsIntelligenceService.suggestProfessionsFromSkills(ParsedResume resume)
Suggest professions based on the skills within a given resume.
|
SuggestProfessionsResponse |
SkillsIntelligenceService.suggestProfessionsFromSkills(ParsedResume resume,
int limit,
boolean returnMissingSkills,
String outputLanguage,
boolean weightSkillsByExperience)
Suggest professions based on the skills within a given resume.
|
SuggestProfessionsResponse |
SkillsIntelligenceService.suggestProfessionsFromSkills(ParsedResume resume,
String outputLanguage)
Suggest professions based on the skills within a given resume.
|
SuggestSkillsFromJobTitleResponse |
SkillsIntelligenceService.suggestSkillsFromJobTitle(String jobTitle)
Takes a job title and suggests relevant skills.
|
SuggestSkillsFromJobTitleResponse |
SkillsIntelligenceService.suggestSkillsFromJobTitle(String jobTitle,
String language,
Integer limit)
Takes a job title and suggests relevant skills.
|
SuggestSkillsResponse |
SkillsIntelligenceService.suggestSkillsFromProfessions(List<Integer> professionCodeIds,
int limit,
String outputLanguage)
Suggests skills related to given professions.
|
SuggestSkillsResponse |
SkillsIntelligenceService.suggestSkillsFromProfessions(List<Integer> professionCodeIds,
String outputLanguage)
Suggests skills related to given professions.
|
SuggestSkillsResponse |
SkillsIntelligenceService.suggestSkillsFromProfessions(ParsedJob job)
Suggests skills related to a job based on the profession title in the job.
|
SuggestSkillsResponse |
SkillsIntelligenceService.suggestSkillsFromProfessions(ParsedJob job,
String outputLanguage)
Suggests skills related to a job based on the profession title in the job.
|
SuggestSkillsResponse |
SkillsIntelligenceService.suggestSkillsFromProfessions(ParsedResume resume)
Suggests skills related to a resume based on the recent professions in the resume.
|
SuggestSkillsResponse |
SkillsIntelligenceService.suggestSkillsFromProfessions(ParsedResume resume,
String outputLanguage)
Suggests skills related to a resume based on the recent professions in the resume.
|
SuggestSkillsResponse |
SkillsIntelligenceService.suggestSkillsFromSkills(List<SkillScore> skills,
int limit,
String outputLanguage)
Returns skills related to a given skill or set of skills.
|
SuggestSkillsResponse |
SkillsIntelligenceService.suggestSkillsFromSkills(List<String> skillIds,
String outputLanguage)
Returns skills related to a given skill or set of skills.
|
SuggestSkillsResponse |
SkillsIntelligenceService.suggestSkillsFromSkills(ParsedJob job,
int limit,
String outputLanguage)
Suggests skills related to a job (but not in the job) based on the skills in the job.
|
SuggestSkillsResponse |
SkillsIntelligenceService.suggestSkillsFromSkills(ParsedJob job,
String outputLanguage)
Suggests skills related to a job (but not in the job) based on the skills in the job.
|
SuggestSkillsResponse |
SkillsIntelligenceService.suggestSkillsFromSkills(ParsedResume resume,
int limit,
String outputLanguage,
boolean weightSkillsByExperience)
Suggests skills related to a resume (but not in the resume) based on the skills in the resume.
|
SuggestSkillsResponse |
SkillsIntelligenceService.suggestSkillsFromSkills(ParsedResume resume,
String outputLanguage)
Suggests skills related to a resume (but not in the resume) based on the skills in the resume.
|
UpdateUserDefinedTagsResponse |
SearchMatchService.updateJobUserDefinedTags(String indexId,
String documentId,
List<String> userDefinedTags,
UserDefinedTagsMethod method)
Updates the user-defined tags for a job
|
UpdateUserDefinedTagsResponse |
SearchMatchService.updateResumeUserDefinedTags(String indexId,
String documentId,
List<String> userDefinedTags,
UserDefinedTagsMethod method)
Updates the user-defined tags for a resume
|
Copyright © 2025. All rights reserved.