diff --git a/README.md b/README.md index d87541f28..76cb828c3 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ The official Java SDK for the Textkernel Tx v10 API for resume/CV and job parsin ### Gradle Users Add this dependency to your project's build file: ``` -implementation "com.textkernel:tx-java:2.3.4" +implementation "com.textkernel:tx-java:3.0.0" ``` ### Maven Users @@ -22,13 +22,13 @@ Add this dependency to your project's POM: com.textkernel tx-java - 2.3.4 + 3.0.0 ``` ### Others You'll need to manually install the following JARs: -- The Textkernel Tx JAR from https://repo1.maven.org/maven2/com/textkernel/tx-java/2.3.4/tx-java-2.3.4.jar +- The Textkernel Tx JAR from https://repo1.maven.org/maven2/com/textkernel/tx-java/3.0.0/tx-java-3.0.0.jar - [Google Gson][gson_url] from https://repo1.maven.org/maven2/com/google/code/gson/gson/2.9.0/gson-2.9.0.jar - [Square OkHttp][okhttp_url] from https://repo1.maven.org/maven2/com/squareup/okhttp3/okhttp/4.12.0/okhttp-4.12.0.jar @@ -46,32 +46,36 @@ For full code examples, see [here][examples]. ### Creating a `TxClient` This is the object that you will use to perform API calls. You create it with your account credentials and the `TxClient` makes the raw API calls for you. These credentials can be found in the [Tx Console][portal]. Be sure to select the correct `DataCenter` for your account. ```java -TxClient client = new TxClient("12345678", "abcdefghijklmnopqrstuvwxyz", DataCenter.US); +TxClientSettings settings = new TxClientSettings(); +settings.AccountId = "12345678"; +settings.ServiceKey = "abcdefghijklmnopqrstuvwxyz"; +settings.DataCenter = DataCenter.US; +TxClient client = new TxClient(settings); ``` For self-hosted customers, you can create a `DataCenter` object with your custom URL using the constructor provided on that class. -### Handling errors and the `TxException` -Every call to any of the methods in the `TxClient` should be wrapped in a `try/catch` block. Any 4xx/5xx level errors will cause a `TxException` to be thrown. Sometimes these are a normal and expected part of the Tx API. For example, if you have a website where users upload resumes, sometimes a user will upload a scanned image as their resume. Textkernel does not process these, and will return a `422 Unprocessable Entity` response which will throw a `TxException`. You should handle any `TxException` in a way that makes sense in your application. +### Using the various `TxClient` services +The `TxClient` has the following services available: +- `parser()` +- `geocoder()` +- `formatter()` +- `skillsIntelligence()` +- `searchMatchV1()` +- `searchMatchV2()` -Additionally, there are `TxUsableResumeException` and `TxUsableJobException` which are thrown when some error/issue occurs in the API, but the response still contains a usable resume/job. For example, if you are geocoding while parsing and there is a geocoding error (which happens after parsing is done), the `ParsedResume` might still be usable in your application. +Each service exposes certain API functionality via its methods. For example, to parse a resume you would do something like: +```java +TxClient client;//created or injected however +ParseResumeResponse parseResponse = client.parser().parseResume(...); +``` -### How to create a Matching UI session -You may be wondering, "where are the Matching UI endpoints/methods?". We have made the difference between a normal API call (such as `Search`) and its equivalent Matching UI call extremely trivial. See the following example: +For the complete list of methods on each service and their method signatures, check out our [online Javadoc][javadoc_url]. -```java -TxClient client = new TxClient("12345678", "abcdefghijklmnopqrstuvwxyz", DataCenter.US); -List indexesToSearch = ...; -FilterCriteria searchQuery = ...; +### Handling errors and the `TxException` +Every call to any of the methods in the `TxClient` should be wrapped in a `try/catch` block. Any 4xx/5xx level errors will cause a `TxException` to be thrown. Sometimes these are a normal and expected part of the Tx API. For example, if you have a website where users upload resumes, sometimes a user will upload a scanned image as their resume. Textkernel does not process these, and will return a `422 Unprocessable Entity` response which will throw a `TxException`. You should handle any `TxException` in a way that makes sense in your application. -SearchResponse searchResponse = client.search(indexesToSearch, searchQuery, null, null); -``` -To generate a Matching UI session with the above Search query, you simply need to call the `ui(...)` method on the `TxClient` object, pass in any UI settings, and then make the same call as above: -```java -MatchUISettings uiSettings = ...; -GenerateUIResponse uiResponse = client.ui(uiSettings).search(indexesToSearch, searchQuery, null, null); -``` -For every relevant method in the `TxClient`, you can create a Matching UI session for that query by doing the same as above. +Additionally, there are `TxUsableResumeException` and `TxUsableJobException` which are thrown when some error/issue occurs in the API, but the response still contains a usable resume/job. For example, if you are geocoding while parsing and there is a geocoding error (which happens after parsing is done), the `ParsedResume` might still be usable in your application. [javadoc_url]: https://textkernel.github.io/tx-java/ [gson_url]: https://github.com/google/gson diff --git a/docs/allclasses-frame.html b/docs/allclasses-frame.html deleted file mode 100644 index 0802849fd..000000000 --- a/docs/allclasses-frame.html +++ /dev/null @@ -1,332 +0,0 @@ - - - - - - -All Classes (Textkernel Tx Java SDK 2.3.3 API) - - - - - -

All Classes

-
- -
- - diff --git a/docs/allclasses-noframe.html b/docs/allclasses-noframe.html deleted file mode 100644 index e4c042973..000000000 --- a/docs/allclasses-noframe.html +++ /dev/null @@ -1,332 +0,0 @@ - - - - - - -All Classes (Textkernel Tx Java SDK 2.3.3 API) - - - - - -

All Classes

-
- -
- - diff --git a/docs/com/textkernel/tx/DataCenter.html b/docs/com/textkernel/tx/DataCenter.html deleted file mode 100644 index 6788d9eb6..000000000 --- a/docs/com/textkernel/tx/DataCenter.html +++ /dev/null @@ -1,337 +0,0 @@ - - - - - - -DataCenter (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx
-

Class DataCenter

-
-
- -
-
    -
  • -
    -
    -
    public class DataCenter
-extends Object
    -
    Use either US or EU
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        US

        -
        public static DataCenter US
        -
        Represents the US datacenter. You can find out which datacenter your account is in at https://cloud.textkernel.com/tx/console
        -
        • -
      - - - -
        -
      • -

        EU

        -
        public static DataCenter EU
        -
        Represents the EU datacenter. You can find out which datacenter your account is in at https://cloud.textkernel.com/tx/console
        -
        • -
      - - - -
        -
      • -

        AU

        -
        public static DataCenter AU
        -
        Represents the AU datacenter. You can find out which datacenter your account is in at https://cloud.textkernel.com/tx/console
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        DataCenter

        -
        protected DataCenter(String root,
-                     String version,
-                     boolean isSaaS)
        -
        • -
      - - - -
        -
      • -

        DataCenter

        -
        public DataCenter(String endpoint)
        -
        Create a DataCenter for a self-hosted instance
        -
        -
        Parameters:
        -
        endpoint - The URL of your self-hosted instance
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/TxClient.html b/docs/com/textkernel/tx/TxClient.html deleted file mode 100644 index bce03daeb..000000000 --- a/docs/com/textkernel/tx/TxClient.html +++ /dev/null @@ -1,3748 +0,0 @@ - - - - - - -TxClient (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx
-

Class TxClient

-
-
- -
-
    -
  • -
    -
    -
    public class TxClient
-extends Object
    -
    The SDK client to perform Tx API calls.
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        ShowFullRequestBodyInExceptions

        -
        public boolean ShowFullRequestBodyInExceptions
        -
        Set to true for debugging API errors. It will show the full JSON request body in TxException.RequestBody -
        NOTE: do not set this to true in your production system, as it increases the memory footprint
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        TxClient

        -
        public TxClient(String accountId,
-                String serviceKey,
-                DataCenter dataCenter)
        -
        Create an SDK client to perform Tx API calls with the account information found at https://cloud.textkernel.com/tx/console
        -
        -
        Parameters:
        -
        accountId - - The account id for your account
        -
        serviceKey - - The service key for your account
        -
        dataCenter - - The Data Center for your account. Either DataCenter.US, DataCenter.EU, or DataCenter.AU
        -
        Throws:
        -
        IllegalArgumentException - if the accountId, serviceKey, or dataCenter are null/empty
        -
        -
        • -
      - - - -
        -
      • -

        TxClient

        -
        public TxClient(String accountId,
-                String serviceKey,
-                DataCenter dataCenter,
-                List<String> trackingTags)
        -
        Create an SDK client to perform Tx API calls with the account information found at https://cloud.textkernel.com/tx/console
        -
        -
        Parameters:
        -
        accountId - - The account id for your account
        -
        serviceKey - - The service key for your account
        -
        dataCenter - - The Data Center for your account. Either DataCenter.US, DataCenter.EU, or DataCenter.AU
        -
        trackingTags - - Optional tags to use to track API usage for your account
        -
        Throws:
        -
        IllegalArgumentException - if the accountId, serviceKey, or dataCenter are null/empty
        -
        -
        • -
      - - - -
        -
      • -

        TxClient

        -
        public TxClient(String accountId,
-                String serviceKey,
-                DataCenter dataCenter,
-                List<String> trackingTags,
-                long httpTimeoutSecs)
        -
        Create an SDK client to perform Tx API calls with the account information found at https://cloud.textkernel.com/tx/console
        -
        -
        Parameters:
        -
        accountId - - The account id for your account
        -
        serviceKey - - The service key for your account
        -
        dataCenter - - The Data Center for your account. Either DataCenter.US, DataCenter.EU, or DataCenter.AU
        -
        trackingTags - - Optional tags to use to track API usage for your account
        -
        httpTimeoutSecs - - Optional override for the OkHttp client read timeout (write and connect are 10 seconds, read is 30 seconds by default)
        -
        Throws:
        -
        IllegalArgumentException - if the accountId, serviceKey, or dataCenter are null/empty
        -
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getAccountInfo

        -
        public GetAccountInfoResponse getAccountInfo()
-                                      throws TxException
        -
        Get the account info (remaining credits, max concurrency, etc).
        -
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        formatResume

        -
        public FormatResumeResponse formatResume(FormatResumeRequest request)
-                                  throws TxException
        -
        Format a resume into a standardized template that you provide
        -
        -
        Parameters:
        -
        request - The request body
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - - - - - - - - - -
        -
      • -

        createIndex

        -
        public CreateIndexResponse createIndex(IndexType type,
-                                       String indexId)
-                                throws TxException
        -
        Create a new index
        -
        -
        Parameters:
        -
        type - The type of documents stored in this index. Either 'Resume' or 'Job'
        -
        indexId - The ID to assign to the new index. This is restricted to alphanumeric with dashes - and underscores. All values will be converted to lower-case.
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - - - - - -
        -
      • -

        deleteIndex

        -
        public DeleteIndexResponse deleteIndex(String indexId)
-                                throws TxException
        -
        Delete an existing index. Note that this is a destructive action and cannot be undone. - All the documents in this index will be deleted.
        -
        -
        Parameters:
        -
        indexId - The index to delete (case-insensitive).
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        indexDocument

        -
        public IndexDocumentResponse indexDocument(ParsedResume resume,
-                                           String indexId,
-                                           String documentId,
-                                           List<String> userDefinedTags)
-                                    throws TxException
        -
        Add a resume to an existing index
        -
        -
        Parameters:
        -
        resume - A resume generated by the Resume Parser
        -
        indexId - The index the document should be added into (case-insensitive).
        -
        documentId - The ID to assign to the new document. This is restricted to alphanumeric - with dashes and underscores. All values will be converted to lower-case.
        -
        userDefinedTags - The user-defined tags that the resume should have, or null
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        indexDocument

        -
        public IndexDocumentResponse indexDocument(ParsedJob job,
-                                           String indexId,
-                                           String documentId,
-                                           List<String> userDefinedTags)
-                                    throws TxException
        -
        Add a job to an existing index
        -
        -
        Parameters:
        -
        job - A job generated by the Job Parser
        -
        indexId - The index the document should be added into (case-insensitive).
        -
        documentId - The ID to assign to the new document. This is restricted to alphanumeric - with dashes and underscores. All values will be converted to lower-case.
        -
        userDefinedTags - The user-defined tags that the resume should have, or null
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        indexMultipleResumes

        -
        public IndexMultipleDocumentsResponse indexMultipleResumes(List<IndexResumeInfo> resumes,
-                                                           String indexId)
-                                                    throws TxException
        -
        Add several resumes to an existing index
        -
        -
        Parameters:
        -
        resumes - The resumes generated by the Resume Parser paired with their DocumentIds
        -
        indexId - The index the documents should be added into (case-insensitive).
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        indexMultipleJobs

        -
        public IndexMultipleDocumentsResponse indexMultipleJobs(List<IndexJobInfo> jobs,
-                                                        String indexId)
-                                                 throws TxException
        -
        Add several jobs to an existing index
        -
        -
        Parameters:
        -
        jobs - The jobs generated by the Job Parser paired with their DocumentIds
        -
        indexId - The index the documents should be added into (case-insensitive).
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        deleteDocument

        -
        public DeleteDocumentResponse deleteDocument(String indexId,
-                                             String documentId)
-                                      throws TxException
        -
        Delete an existing document from an index
        -
        -
        Parameters:
        -
        indexId - The index containing the document
        -
        documentId - The ID of the document to delete
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        deleteMultipleDocuments

        -
        public DeleteMultipleDocumentsResponse deleteMultipleDocuments(String indexId,
-                                                               List<String> documentIds)
-                                                        throws TxException
        -
        Delete a group of existing documents from an index
        -
        -
        Parameters:
        -
        indexId - The index containing the documents
        -
        documentIds - The IDs of the documents to delete
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        getResume

        -
        public GetResumeResponse getResume(String indexId,
-                                   String documentId)
-                            throws TxException
        -
        Retrieve an existing resume from an index
        -
        -
        Parameters:
        -
        indexId - The index containing the resume
        -
        documentId - The ID of the resume to retrieve
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        getJob

        -
        public GetJobResponse getJob(String indexId,
-                             String documentId)
-                      throws TxException
        -
        Retrieve an existing job from an index
        -
        -
        Parameters:
        -
        indexId - The index containing the job
        -
        documentId - The ID of the job to retrieve
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        updateResumeUserDefinedTags

        -
        public UpdateUserDefinedTagsResponse updateResumeUserDefinedTags(String indexId,
-                                                                 String documentId,
-                                                                 List<String> userDefinedTags,
-                                                                 UserDefinedTagsMethod method)
-                                                          throws TxException
        -
        Updates the user-defined tags for a resume
        -
        -
        Parameters:
        -
        indexId - The index containing the resume
        -
        documentId - The ID of the resume to update
        -
        userDefinedTags - The user-defined tags to add/delete/etc
        -
        method - Which method to use for the specified user-defined tags
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        updateJobUserDefinedTags

        -
        public UpdateUserDefinedTagsResponse updateJobUserDefinedTags(String indexId,
-                                                              String documentId,
-                                                              List<String> userDefinedTags,
-                                                              UserDefinedTagsMethod method)
-                                                       throws TxException
        -
        Updates the user-defined tags for a job
        -
        -
        Parameters:
        -
        indexId - The index containing the job
        -
        documentId - The ID of the job to update
        -
        userDefinedTags - The user-defined tags to add/delete/etc
        -
        method - Which method to use for the specified user-defined tags
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        match

        -
        public MatchResponse match(ParsedResume resume,
-                           List<String> indexesToQuery,
-                           CategoryWeights preferredWeights,
-                           FilterCriteria filters,
-                           SearchMatchSettings settings,
-                           int numResults)
-                    throws TxException
        -
        Find matches for a non-indexed resume.
        -
        -
        Parameters:
        -
        resume - The resume (generated by the Resume Parser) to use as the source for a match query
        -
        indexesToQuery - The indexes to find results in. These must all be of the same type (resumes or jobs)
        -
        preferredWeights - The preferred category weights for scoring the results. If null, - The best values will be determined based on the source resume
        -
        filters - Any filters to apply prior to the match (a result must satisfy all the filters), or null
        -
        settings - The settings for this match request. Use null for defaults.
        -
        numResults - The number of results to show. Use 0 for the default.
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        match

        -
        public MatchResponse match(ParsedJob job,
-                           List<String> indexesToQuery,
-                           CategoryWeights preferredWeights,
-                           FilterCriteria filters,
-                           SearchMatchSettings settings,
-                           int numResults)
-                    throws TxException
        -
        Find matches for a non-indexed job.
        -
        -
        Parameters:
        -
        job - The job (generated by the Job Parser) to use as the source for a match query
        -
        indexesToQuery - The indexes to find results in. These must all be of the same type (resumes or jobs)
        -
        preferredWeights - The preferred category weights for scoring the results. If null, - The best values will be determined based on the source job
        -
        filters - Any filters to apply prior to the match (a result must satisfy all the filters), or null
        -
        settings - The settings for this match request. Use null for defaults.
        -
        numResults - The number of results to show. Use 0 for the default.
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        match

        -
        public MatchResponse match(String indexId,
-                           String documentId,
-                           List<String> indexesToQuery,
-                           CategoryWeights preferredWeights,
-                           FilterCriteria filters,
-                           SearchMatchSettings settings,
-                           int numResults)
-                    throws TxException
        -
        Find matches for a resume or job that is already indexed
        -
        -
        Parameters:
        -
        indexId - The index containing the document you want to match
        -
        documentId - The ID of the document to match
        -
        indexesToQuery - The indexes to find results in. These must all be of the same type (resumes or jobs)
        -
        preferredWeights - The preferred category weights for scoring the results. If null, - The best values will be determined based on the source resume/job
        -
        filters - Any filters to apply prior to the match (a result must satisfy all the filters), or null
        -
        settings - The settings for this match request. Use null for defaults.
        -
        numResults - The number of results to show. Use 0 for the default.
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        search

        -
        public SearchResponse search(List<String> indexesToQuery,
-                             FilterCriteria query,
-                             SearchMatchSettings settings,
-                             PaginationSettings pagination)
-                      throws TxException
        -
        Search for resumes or jobs that meet specific criteria
        -
        -
        Parameters:
        -
        indexesToQuery - The indexes to find results in. These must all be of the same type (resumes or jobs)
        -
        query - The search query. A result must satisfy all of these criteria
        -
        settings - The settings for this search request. Use null for defaults.
        -
        pagination - Pagination settings. Use null for defaults.
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        bimetricScore

        -
        public <TTarget extends IParsedDocWithId> BimetricScoreResponse bimetricScore(ParsedResumeWithId sourceResume,
-                                                                              List<TTarget> targetDocuments,
-                                                                              CategoryWeights preferredWeights,
-                                                                              SearchMatchSettings settings)
-                                                                       throws TxException
        -
        Score one or more target documents against a source resume
        -
        -
        Type Parameters:
        -
        TTarget - Either ParsedResumeWithId or ParsedJobWithId
        -
        Parameters:
        -
        sourceResume - The source resume
        -
        targetDocuments - The target resumes/jobs
        -
        preferredWeights - The preferred category weights for scoring the results. If null, - The best values will be determined based on the source resume.
        -
        settings - The settings for this search request. Use null for defaults.
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        bimetricScore

        -
        public <TTarget extends IParsedDocWithId> BimetricScoreResponse bimetricScore(ParsedJobWithId sourceJob,
-                                                                              List<TTarget> targetDocuments,
-                                                                              CategoryWeights preferredWeights,
-                                                                              SearchMatchSettings settings)
-                                                                       throws TxException
        -
        Score one or more target documents against a source job
        -
        -
        Type Parameters:
        -
        TTarget - Either ParsedResumeWithId or ParsedJobWithId
        -
        Parameters:
        -
        sourceJob - The source job
        -
        targetDocuments - The target resumes/jobs
        -
        preferredWeights - The preferred category weights for scoring the results. If null, - The best values will be determined based on the source job.
        -
        settings - The settings for this search request. Use null for defaults.
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        geocode

        -
        public GeocodeResumeResponse geocode(ParsedResume resume,
-                                     GeocodeCredentials geocodeCredentials)
-                              throws TxException
        -
        Uses the address in the resume (if present) to look up geocoordinates and add them into the ParsedResume object. - These coordinates are used by the AI Searching/Matching engine.
        -
        -
        Parameters:
        -
        resume - The resume to insert the geocoordinates (from the address) into
        -
        geocodeCredentials - - The credentials you want to use for geocoding (use null for built-in credentials)
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurred
        -
        -
        • -
      - - - -
        -
      • -

        geocode

        -
        public GeocodeResumeResponse geocode(ParsedResume resume,
-                                     Address address,
-                                     GeocodeCredentials geocodeCredentials)
-                              throws TxException
        -
        Use this if you would like to provide an address for geocoding instead of using the one in the parsed - resume. The address included in the parsed resume (if present) will not be modified.
        -
        -
        Parameters:
        -
        resume - The resume to insert the geocoordinates (from the address) into
        -
        address - The address to use to retrieve geocoordinates
        -
        geocodeCredentials - - The credentials you want to use for geocoding (use null for built-in credentials)
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurred
        -
        -
        • -
      - - - -
        -
      • -

        geocode

        -
        public GeocodeJobResponse geocode(ParsedJob job,
-                                  GeocodeCredentials geocodeCredentials)
-                           throws TxException
        -
        Uses the address in the job (if present) to look up geocoordinates and add them into the ParsedJob object. - These coordinates are used by the AI Searching/Matching engine.
        -
        -
        Parameters:
        -
        job - The job to insert the geocoordinates (from the address) into
        -
        geocodeCredentials - - The credentials you want to use for geocoding (use null for built-in credentials)
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurred
        -
        -
        • -
      - - - -
        -
      • -

        geocode

        -
        public GeocodeJobResponse geocode(ParsedJob job,
-                                  Address address,
-                                  GeocodeCredentials geocodeCredentials)
-                           throws TxException
        -
        Use this if you would like to provide an address for geocoding instead of using the one in the parsed - job. The address included in the parsed job (if present) will not be modified.
        -
        -
        Parameters:
        -
        job - The job to insert the geocoordinates (from the address) into
        -
        address - The address to use to retrieve geocoordinates
        -
        geocodeCredentials - - The credentials you want to use for geocoding (use null for built-in credentials)
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurred
        -
        -
        • -
      - - - -
        -
      • -

        geocodeAndIndex

        -
        public GeocodeAndIndexResumeResponse geocodeAndIndex(ParsedResume resume,
-                                                     IndexSingleDocumentInfo indexingOptions,
-                                                     boolean indexIfGeocodeFails,
-                                                     GeocodeCredentials geocodeCredentials)
-                                              throws TxException
        -
        Uses the address in the resume (if present) to look up geocoordinates and add them into the ParsedResume object. - These coordinates are used by the AI Searching/Matching engine.
        -
        -
        Parameters:
        -
        resume - The resume to geocode
        -
        indexingOptions - What index/document id to use to index the document after geocoding
        -
        indexIfGeocodeFails - Indicates whether or not the document should still be added to the index if the geocode request fails.
        -
        geocodeCredentials - - The credentials you want to use for geocoding (use null for built-in credentials)
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurred
        -
        -
        • -
      - - - -
        -
      • -

        geocodeAndIndex

        -
        public GeocodeAndIndexResumeResponse geocodeAndIndex(ParsedResume resume,
-                                                     IndexSingleDocumentInfo indexingOptions,
-                                                     Address address,
-                                                     boolean indexIfGeocodeFails,
-                                                     GeocodeCredentials geocodeCredentials)
-                                              throws TxException
        -
        Use this if you would like to provide an address for geocoding instead of using the one in the parsed - resume. The address included in the parsed resume (if present) will not be modified.
        -
        -
        Parameters:
        -
        resume - The resume to insert the geocoordinates (from the address) into
        -
        indexingOptions - What index/document id to use to index the document after geocoding
        -
        address - The address to use to retrieve geocoordinates
        -
        indexIfGeocodeFails - Indicates whether or not the document should still be added to the index if the geocode request fails.
        -
        geocodeCredentials - - The credentials you want to use for geocoding (use null for built-in credentials)
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurred
        -
        -
        • -
      - - - -
        -
      • -

        geocodeAndIndex

        -
        public GeocodeAndIndexResumeResponse geocodeAndIndex(ParsedResume resume,
-                                                     IndexSingleDocumentInfo indexingOptions,
-                                                     GeoCoordinates coordinates,
-                                                     boolean indexIfGeocodeFails,
-                                                     GeocodeCredentials geocodeCredentials)
-                                              throws TxException
        -
        Use this if you already have latitude/longitude coordinates and simply wish to add them to your parsed resume. - The coordinates will be inserted into your parsed resume, and the address included in the - parsed resume (if present) will not be modified.
        -
        -
        Parameters:
        -
        resume - The resume to insert the geocoordinates into
        -
        indexingOptions - What index/document id to use to index the document after geocoding
        -
        coordinates - The geocoordinates to use
        -
        indexIfGeocodeFails - Indicates whether or not the document should still be added to the index if the geocode request fails.
        -
        geocodeCredentials - - The credentials you want to use for geocoding (use null for built-in credentials)
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurred
        -
        -
        • -
      - - - -
        -
      • -

        geocodeAndIndex

        -
        public GeocodeAndIndexJobResponse geocodeAndIndex(ParsedJob job,
-                                                  IndexSingleDocumentInfo indexingOptions,
-                                                  boolean indexIfGeocodeFails,
-                                                  GeocodeCredentials geocodeCredentials)
-                                           throws TxException
        -
        Uses the address in the job (if present) to look up geocoordinates and add them into the ParsedJob object. - These coordinates are used by the AI Searching/Matching engine.
        -
        -
        Parameters:
        -
        job - The job to geocode
        -
        indexingOptions - What index/document id to use to index the document after geocoding
        -
        indexIfGeocodeFails - Indicates whether or not the document should still be added to the index if the geocode request fails.
        -
        geocodeCredentials - - The credentials you want to use for geocoding (use null for built-in credentials)
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurred
        -
        -
        • -
      - - - -
        -
      • -

        geocodeAndIndex

        -
        public GeocodeAndIndexJobResponse geocodeAndIndex(ParsedJob job,
-                                                  IndexSingleDocumentInfo indexingOptions,
-                                                  Address address,
-                                                  boolean indexIfGeocodeFails,
-                                                  GeocodeCredentials geocodeCredentials)
-                                           throws TxException
        -
        Use this if you would like to provide an address for geocoding instead of using the one in the parsed - rjobesume. The address included in the parsed job (if present) will not be modified.
        -
        -
        Parameters:
        -
        job - The job to insert the geocoordinates (from the address) into
        -
        indexingOptions - What index/document id to use to index the document after geocoding
        -
        address - The address to use to retrieve geocoordinates
        -
        indexIfGeocodeFails - Indicates whether or not the document should still be added to the index if the geocode request fails.
        -
        geocodeCredentials - - The credentials you want to use for geocoding (use null for built-in credentials)
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurred
        -
        -
        • -
      - - - -
        -
      • -

        geocodeAndIndex

        -
        public GeocodeAndIndexJobResponse geocodeAndIndex(ParsedJob job,
-                                                  IndexSingleDocumentInfo indexingOptions,
-                                                  GeoCoordinates coordinates,
-                                                  boolean indexIfGeocodeFails,
-                                                  GeocodeCredentials geocodeCredentials)
-                                           throws TxException
        -
        Use this if you already have latitude/longitude coordinates and simply wish to add them to your parsed job. - The coordinates will be inserted into your parsed job, and the address included in the - parsed job (if present) will not be modified.
        -
        -
        Parameters:
        -
        job - The job to insert the geocoordinates into
        -
        indexingOptions - What index/document id to use to index the document after geocoding
        -
        coordinates - The geocoordinates to use
        -
        indexIfGeocodeFails - Indicates whether or not the document should still be added to the index if the geocode request fails.
        -
        geocodeCredentials - - The credentials you want to use for geocoding (use null for built-in credentials)
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurred
        -
        -
        • -
      - - - -
        -
      • -

        ui

        -
        public TxUIClient ui(MatchUISettings uiOptions)
        -
        Access methods for generating Matching UI sessions. For example: txClient.UI(options).search(...)
        -
        -
        Parameters:
        -
        uiOptions - Options/settings for the Matching UI. -
        NOTE: if you do not provide a UIOptions.Username (in MatchUISettings.UIOptions), - the user will be prompted to login as soon as the Matching UI session is loaded
        -
        Returns:
        -
        The client for making Matching UI API calls
        -
        -
        • -
      - - - - - - - -
        -
      • -

        getSkillsTaxonomy

        -
        public GetSkillsTaxonomyResponse getSkillsTaxonomy()
-                                            throws TxException
        -
        Get all skills in the taxonomy with associated IDs and descriptions in all supported languages.
        -
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        getSkillsTaxonomyMetadata

        -
        public GetMetadataResponse getSkillsTaxonomyMetadata()
-                                              throws TxException
        -
        Get metadata about the skills taxonomy/service.
        -
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        autocompleteSkill

        -
        public AutoCompleteSkillsResponse autocompleteSkill(String prefix,
-                                                    List<String> languages,
-                                                    String outputLanguage,
-                                                    List<String> types,
-                                                    int limit)
-                                             throws TxException
        -
        Returns normalized skills that begin with a given prefix, based on the chosen language(s). Each skill is associated with multiple descriptions. If any of the descriptions are a good completion of the given prefix, the skill is included in the results.
        -
        -
        Parameters:
        -
        prefix - The skill prefix to be completed. Must contain at least 1 character.
        -
        languages - The language(s) used to search for matching skills (the language of the provided Prefix). A maximum of 5 languages can be provided. Must be one of the supported ISO codes.
        Default is 'en' only.
        -
        outputLanguage - The language to ouput the found skill descriptions in (default is 'en'). Must be one of the supported ISO codes.
        -
        types - If specified, only these types of skills will be returned. The following values are acceptable: Professional, IT, Language, Soft, All.
        -
        limit - The maximum number of returned skills. The default is 10 and the maximum is 100.
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        autocompleteSkill

        -
        public AutoCompleteSkillsResponse autocompleteSkill(String prefix)
-                                             throws TxException
        -
        Returns normalized skills that begin with a given prefix, based on the chosen language(s). Each skill is associated with multiple descriptions. If any of the descriptions are a good completion of the given prefix, the skill is included in the results.
        -
        -
        Parameters:
        -
        prefix - The skill prefix to be completed. Must contain at least 1 character.
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        lookupSkills

        -
        public LookupSkillCodesResponse lookupSkills(List<String> skillIds,
-                                             String outputLanguage)
-                                      throws TxException
        -
        Get the details associated with given skills in the taxonomy.
        -
        -
        Parameters:
        -
        skillIds - The IDs of the skills to get details about. A maximum of 100 IDs can be requested.
        -
        outputLanguage - The language to use for the output skill descriptions. If not provided, defaults to en. If specified, must be one of the supported ISO codes.
        Default is 'en'.
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        lookupSkills

        -
        public LookupSkillCodesResponse lookupSkills(List<String> skillIds)
-                                      throws TxException
        -
        Get the details associated with given skills in the taxonomy.
        -
        -
        Parameters:
        -
        skillIds - The IDs of the skills to get details about. A maximum of 100 IDs can be requested.
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        normalizeSkills

        -
        public NormalizeSkillsResponse normalizeSkills(List<String> skills,
-                                               String language,
-                                               String outputLanguage)
-                                        throws TxException
        -
        Normalize the given skills to the most closely-related skills in the taxonomy.
        -
        -
        Parameters:
        -
        skills - The list of skills to normalize (up to 50 skills, each skill may not exceed 100 characters).
        -
        language - The language of the given skills. Must be one of the supported ISO codes.
        Default is 'en'.
        -
        outputLanguage - The language to use for the output skill descriptions. Must be one of the supported ISO codes.
        Defaults to whatever is used for the 'language' parameter.
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        normalizeSkills

        -
        public NormalizeSkillsResponse normalizeSkills(List<String> skills)
-                                        throws TxException
        -
        Normalize the given skills to the most closely-related skills in the taxonomy.
        -
        -
        Parameters:
        -
        skills - The list of skills to normalize (up to 50 skills, each skill may not exceed 100 characters).
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        extractSkills

        -
        public ExtractSkillsResponse extractSkills(String text,
-                                           String language,
-                                           String outputLanguage,
-                                           float threshold)
-                                    throws TxException
        -
        Extracts known skills from the given text.
        -
        -
        Parameters:
        -
        text - The text to extract skills from. There is a 24,000 character limit.
        -
        language - The language of the input text. Must be one of the supported ISO codes.
        Default is 'en'.
        -
        outputLanguage - The language to use for the output skill descriptions. If not provided, defaults to the input language. Must be one of the supported ISO codes.
        -
        threshold - A value from [0 - 1] for the minimum confidence threshold for extracted skills. Lower values will return more skills, but also increase the likelihood of ambiguity-related errors. The recommended and default value is 0.5.
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        extractSkills

        -
        public ExtractSkillsResponse extractSkills(String text)
-                                    throws TxException
        -
        Extracts known skills from the given text.
        -
        -
        Parameters:
        -
        text - The text to extract skills from. There is a 24,000 character limit.
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - - - - - -
        -
      • -

        getSkillsTaxonomyV2

        -
        public GetSkillsTaxonomyResponse getSkillsTaxonomyV2()
-                                              throws TxException
        -
        Get all skills in the taxonomy with associated IDs and descriptions in all supported languages.
        -
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        getSkillsTaxonomyMetadataV2

        -
        public GetMetadataResponse getSkillsTaxonomyMetadataV2()
-                                                throws TxException
        -
        Get metadata about the skills taxonomy/service.
        -
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        autocompleteSkillV2

        -
        public AutoCompleteSkillsResponse autocompleteSkillV2(String prefix,
-                                                      List<String> languages,
-                                                      String outputLanguage,
-                                                      List<String> types,
-                                                      int limit)
-                                               throws TxException
        -
        Returns normalized skills that begin with a given prefix, based on the chosen language(s). Each skill is associated with multiple descriptions. If any of the descriptions are a good completion of the given prefix, the skill is included in the results.
        -
        -
        Parameters:
        -
        prefix - The skill prefix to be completed. Must contain at least 1 character.
        -
        languages - The language(s) used to search for matching skills (the language of the provided Prefix). A maximum of 5 languages can be provided. Must be one of the supported ISO codes.
        Default is 'en' only.
        -
        outputLanguage - The language to ouput the found skill descriptions in (default is 'en'). Must be one of the supported ISO codes.
        -
        types - If specified, only these types of skills will be returned. The following values are acceptable: Professional, IT, Language, Soft, Certification, All.
        -
        limit - The maximum number of returned skills. The default is 10 and the maximum is 100.
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        autocompleteSkillV2

        -
        public AutoCompleteSkillsResponse autocompleteSkillV2(String prefix)
-                                               throws TxException
        -
        Returns normalized skills that begin with a given prefix, based on the chosen language(s). Each skill is associated with multiple descriptions. If any of the descriptions are a good completion of the given prefix, the skill is included in the results.
        -
        -
        Parameters:
        -
        prefix - The skill prefix to be completed. Must contain at least 1 character.
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        lookupSkillsV2

        -
        public LookupSkillCodesResponse lookupSkillsV2(List<String> skillIds,
-                                               String outputLanguage)
-                                        throws TxException
        -
        Get the details associated with given skills in the taxonomy.
        -
        -
        Parameters:
        -
        skillIds - The IDs of the skills to get details about. A maximum of 100 IDs can be requested.
        -
        outputLanguage - The language to use for the output skill descriptions. If not provided, defaults to en. If specified, must be one of the supported ISO codes.
        Default is 'en'.
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        lookupSkillsV2

        -
        public LookupSkillCodesResponse lookupSkillsV2(List<String> skillIds)
-                                        throws TxException
        -
        Get the details associated with given skills in the taxonomy.
        -
        -
        Parameters:
        -
        skillIds - The IDs of the skills to get details about. A maximum of 100 IDs can be requested.
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        normalizeSkillsV2

        -
        public NormalizeSkillsResponse normalizeSkillsV2(List<String> skills,
-                                                 String language,
-                                                 String outputLanguage)
-                                          throws TxException
        -
        Normalize the given skills to the most closely-related skills in the taxonomy.
        -
        -
        Parameters:
        -
        skills - The list of skills to normalize (up to 50 skills, each skill may not exceed 100 characters).
        -
        language - The language of the given skills. Must be one of the supported ISO codes.
        Default is 'en'.
        -
        outputLanguage - The language to use for the output skill descriptions. Must be one of the supported ISO codes.
        Defaults to whatever is used for the 'language' parameter.
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        normalizeSkillsV2

        -
        public NormalizeSkillsResponse normalizeSkillsV2(List<String> skills)
-                                          throws TxException
        -
        Normalize the given skills to the most closely-related skills in the taxonomy.
        -
        -
        Parameters:
        -
        skills - The list of skills to normalize (up to 50 skills, each skill may not exceed 100 characters).
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        extractSkillsV2

        -
        public ExtractSkillsResponse extractSkillsV2(String text,
-                                             String language,
-                                             String outputLanguage,
-                                             float threshold)
-                                      throws TxException
        -
        Extracts known skills from the given text.
        -
        -
        Parameters:
        -
        text - The text to extract skills from. There is a 24,000 character limit.
        -
        language - The language of the input text. Must be one of the supported ISO codes.
        Default is 'en'.
        -
        outputLanguage - The language to use for the output skill descriptions. If not provided, defaults to the input language. Must be one of the supported ISO codes.
        -
        threshold - A value from [0 - 1] for the minimum confidence threshold for extracted skills. Lower values will return more skills, but also increase the likelihood of ambiguity-related errors. The recommended and default value is 0.5.
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        extractSkillsV2

        -
        public ExtractSkillsResponse extractSkillsV2(String text)
-                                      throws TxException
        -
        Extracts known skills from the given text.
        -
        -
        Parameters:
        -
        text - The text to extract skills from. There is a 24,000 character limit.
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        getProfessionsTaxonomy

        -
        public GetProfessionsTaxonomyResponse getProfessionsTaxonomy(String language,
-                                                             TaxonomyFormat format)
-                                                      throws TxException
        -
        Get all professions in the taxonomy with associated IDs and descriptions in all supported languages.
        -
        -
        Parameters:
        -
        language - The language parameter returns the taxonomy with descriptions only in that specified language. If not specified, descriptions in all languages are returned. Must be specified as one of the supported ISO codes.
        -
        format - The format of the returned taxonomy.
        NOTE: if you set this to TaxonomyFormat.csv, only the Taxonomy.CsvOutput will be populated.
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        getProfessionsTaxonomy

        -
        public GetProfessionsTaxonomyResponse getProfessionsTaxonomy()
-                                                      throws TxException
        -
        Get all professions in the taxonomy with associated IDs and descriptions in all supported languages.
        -
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        getProfessionsTaxonomyMetadata

        -
        public GetMetadataResponse getProfessionsTaxonomyMetadata()
-                                                   throws TxException
        -
        Get metadata about the professions taxonomy/service.
        -
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        autocompleteProfession

        -
        public ProfessionsAutoCompleteResponse autocompleteProfession(String prefix,
-                                                              List<String> languages,
-                                                              String outputLanguage,
-                                                              int limit)
-                                                       throws TxException
        -
        Returns normalized professions that begin with a given prefix, based on the chosen language(s). Each profession is associated with multiple descriptions. If any of the descriptions are a good completion of the given prefix, the profession is included in the results.
        -
        -
        Parameters:
        -
        prefix - The job title prefix to be completed. Must contain at least 1 character.
        -
        languages - The language(s) used to search for matching professions (the language of the provided Prefix). A maximum of 5 languages can be provided. Must be one of the supported ISO codes. Default is 'en' only.
        -
        outputLanguage - The language to ouput the found professions in (default is 'en'). Must be one of the supported ISO codes.
        -
        limit - The maximum number of returned professions. The default is 10 and the maximum is 100.
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        autocompleteProfession

        -
        public ProfessionsAutoCompleteResponse autocompleteProfession(String prefix)
-                                                       throws TxException
        -
        Returns normalized professions that begin with a given prefix, based on the default language of english. Each profession is associated with multiple descriptions. If any of the descriptions are a good completion of the given prefix, the profession is included in the results.
        -
        -
        Parameters:
        -
        prefix - The job title prefix to be completed. Must contain at least 1 character.
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        normalizeProfessions

        -
        public NormalizeProfessionsResponse normalizeProfessions(List<String> jobTitles,
-                                                         String language,
-                                                         String outputLanguage)
-                                                  throws TxException
        -
        Normalize the given job titles to the most closely-related professions in the taxonomy.
        -
        -
        Parameters:
        -
        jobTitles - The list of job titles to normalize (up to 10 job titles, each job title may not exceed 400 characters).
        -
        language - The language of the input job titles. Must be one of the supported ISO codes.
        Default is 'en'.
        -
        outputLanguage - The language to use for descriptions of the returned normalized professions. Must be one of the supported ISO codes.
        Defaults to whatever is used for the 'language' parameter.
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        normalizeProfessions

        -
        public NormalizeProfessionsResponse normalizeProfessions(List<String> jobTitles)
-                                                  throws TxException
        -
        Normalize the given job titles to the most closely-related professions in the taxonomy.
        -
        -
        Parameters:
        -
        jobTitles - The list of job titles to normalize (up to 10 job titles, each job title may not exceed 400 characters).
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        lookupProfessions

        -
        public LookupProfessionCodesResponse lookupProfessions(List<Integer> codeIds,
-                                                       String outputLanguage)
-                                                throws TxException
        -
        Get details for the given professions in the taxonomy.
        -
        -
        Parameters:
        -
        codeIds - The profession code IDs to get details about from the Professions Taxonomy.
        -
        outputLanguage - The language to use for professions descriptions (default is en). Must be an allowed ISO code.
        Default is 'en'.
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - - - - - -
        -
      • -

        compareProfessions

        -
        public CompareProfessionsResponse compareProfessions(int profession1,
-                                                     int profession2,
-                                                     String outputLanguage)
-                                              throws TxException
        -
        Compare two professions based on the skills associated with each.
        -
        -
        Parameters:
        -
        profession1 - A profession code ID from the Professions Taxonomy to compare.
        -
        profession2 - A profession code ID from the Professions Taxonomy to compare.
        -
        outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        compareSkillsToProfessions

        -
        public CompareSkillsToProfessionResponse compareSkillsToProfessions(int professionCodeId,
-                                                                    String outputLanguage,
-                                                                    List<SkillScore> skills)
-                                                             throws TxException
        -
        Compare a given set of skills to the skills related to a given profession.
        -
        -
        Parameters:
        -
        professionCodeId - The profession code ID from the Professions Taxonomy to compare the skill set to.
        -
        outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code
        -
        skills - The skills which should be compared against the given profession. The list can contain up to 50 skills.
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        compareSkillsToProfessions

        -
        public CompareSkillsToProfessionResponse compareSkillsToProfessions(ParsedResume resume,
-                                                                    int professionCodeId,
-                                                                    String outputLanguage,
-                                                                    boolean weightSkillsByExperience)
-                                                             throws TxException
        -
        Compare the skills of a candidate to the skills related to a job using the Ontology API.
        -
        -
        Parameters:
        -
        resume - The resume containing the skills of the candidate
        -
        professionCodeId - The profession code ID from the Professions Taxonomy to compare the skill set to.
        -
        outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code
        -
        weightSkillsByExperience - Whether or not to give a higher weight to skills that the candidate has more experience with.
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        suggestSkillsFromProfessions

        -
        public SuggestSkillsResponse suggestSkillsFromProfessions(List<Integer> professionCodeIds,
-                                                          int limit,
-                                                          String outputLanguage)
-                                                   throws TxException
        -
        Suggests skills related to given professions. The service returns salient skills that are strongly associated with the professions.
        -
        -
        Parameters:
        -
        professionCodeIds - The code IDs of the professions to suggest skills for.
        -
        limit - The maximum amount of suggested skills returned. If not sure what value should be, provide 10 as default limit.
        -
        outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        suggestSkillsFromProfessions

        -
        public SuggestSkillsResponse suggestSkillsFromProfessions(List<Integer> professionCodeIds,
-                                                          String outputLanguage)
-                                                   throws TxException
        -
        Suggests skills related to given professions. The service returns salient skills that are strongly associated with the professions.
        -
        -
        Parameters:
        -
        professionCodeIds - The code IDs of the professions to suggest skills for.
        -
        outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        suggestSkillsFromProfessions

        -
        public SuggestSkillsResponse suggestSkillsFromProfessions(ParsedResume resume,
-                                                          String outputLanguage)
-                                                   throws TxException
        -
        Suggests skills related to a resume based on the recent professions in the resume.
        -
        -
        Parameters:
        -
        resume - The resume to suggest skills for (based on the professions in the resume).
        -
        outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        suggestSkillsFromProfessions

        -
        public SuggestSkillsResponse suggestSkillsFromProfessions(ParsedResume resume)
-                                                   throws TxException
        -
        Suggests skills related to a resume based on the recent professions in the resume.
        -
        -
        Parameters:
        -
        resume - The resume to suggest skills for (based on the professions in the resume).
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        suggestSkillsFromProfessions

        -
        public SuggestSkillsResponse suggestSkillsFromProfessions(ParsedJob job,
-                                                          String outputLanguage)
-                                                   throws TxException
        -
        Suggests skills related to a job based on the profession title in the job.
        -
        -
        Parameters:
        -
        job - The resume to suggest skills for (based on the professions in the resume).
        -
        outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        suggestSkillsFromProfessions

        -
        public SuggestSkillsResponse suggestSkillsFromProfessions(ParsedJob job)
-                                                   throws TxException
        -
        Suggests skills related to a job based on the profession title in the job.
        -
        -
        Parameters:
        -
        job - The resume to suggest skills for (based on the professions in the resume).
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        suggestProfessionsFromSkills

        -
        public SuggestProfessionsResponse suggestProfessionsFromSkills(ParsedResume resume,
-                                                               int limit,
-                                                               boolean returnMissingSkills,
-                                                               String outputLanguage,
-                                                               boolean weightSkillsByExperience)
-                                                        throws TxException
        -
        Suggest professions based on the skills within a given resume.
        -
        -
        Parameters:
        -
        resume - The professions are suggested based on the skills within this resume.
        -
        limit - The maximum amount of professions returned. If not sure what value should be, provide 10 as default limit.
        -
        returnMissingSkills - Flag to enable returning a list of missing skills per suggested profession.
        -
        outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code
        -
        weightSkillsByExperience - Whether or not to give a higher weight to skills that the candidate has more experience with.
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        suggestProfessionsFromSkills

        -
        public SuggestProfessionsResponse suggestProfessionsFromSkills(ParsedResume resume,
-                                                               String outputLanguage)
-                                                        throws TxException
        -
        Suggest professions based on the skills within a given resume.
        -
        -
        Parameters:
        -
        resume - The professions are suggested based on the skills within this resume. Defaults limit returned to 10 and does not return missing skills. Use another overload to specify these parameters.
        -
        outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        suggestProfessionsFromSkills

        -
        public SuggestProfessionsResponse suggestProfessionsFromSkills(ParsedResume resume)
-                                                        throws TxException
        -
        Suggest professions based on the skills within a given resume.
        -
        -
        Parameters:
        -
        resume - The professions are suggested based on the skills within this resume. Defaults limit returned to 10 and does not return missing skills. Use another overload to specify these parameters.
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        suggestProfessionsFromSkills

        -
        public SuggestProfessionsResponse suggestProfessionsFromSkills(ParsedJob job,
-                                                               int limit,
-                                                               boolean returnMissingSkills,
-                                                               String outputLanguage)
-                                                        throws TxException
        -
        Suggest professions based on the skills within a given job.
        -
        -
        Parameters:
        -
        job - The professions are suggested based on the skills within this job.
        -
        limit - The maximum amount of professions returned. If not sure what value should be, provide 10 as default limit.
        -
        returnMissingSkills - Flag to enable returning a list of missing skills per suggested profession.
        -
        outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        suggestProfessionsFromSkills

        -
        public SuggestProfessionsResponse suggestProfessionsFromSkills(ParsedJob job,
-                                                               String outputLanguage)
-                                                        throws TxException
        -
        Suggest professions based on the skills within a given job.
        -
        -
        Parameters:
        -
        job - The professions are suggested based on the skills within this job. Defaults limit returned to 10 and does not return missing skills. Use another overload to specify these parameters.
        -
        outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        suggestProfessionsFromSkills

        -
        public SuggestProfessionsResponse suggestProfessionsFromSkills(ParsedJob job)
-                                                        throws TxException
        -
        Suggest professions based on the skills within a given job.
        -
        -
        Parameters:
        -
        job - The professions are suggested based on the skills within this job. Defaults limit returned to 10 and does not return missing skills. Use another overload to specify these parameters.
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        suggestProfessionsFromSkills

        -
        public SuggestProfessionsResponse suggestProfessionsFromSkills(List<SkillScore> skills,
-                                                               int limit,
-                                                               boolean returnMissingSkills,
-                                                               String outputLanguage)
-                                                        throws TxException
        -
        Suggest professions based on a given set of skills.
        -
        -
        Parameters:
        -
        skills - The skills used to return the most relevant professions. The list can contain up to 50 skills.
        -
        limit - The maximum amount of professions returned. If not sure what value should be, provide 10 as default limit.
        -
        returnMissingSkills - Flag to enable returning a list of missing skills per suggested profession.
        -
        outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        suggestProfessionsFromSkills

        -
        public SuggestProfessionsResponse suggestProfessionsFromSkills(List<String> skillIds,
-                                                               String outputLanguage)
-                                                        throws TxException
        -
        Suggest professions based on a given set of skill IDs.
        -
        -
        Parameters:
        -
        skillIds - The skill IDs used to return the most relevant professions. The list can contain up to 50 skill IDs. Defaults limit returned to 10 and does not return missing skills. Use another overload to specify these parameters.
        -
        outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        suggestSkillsFromSkills

        -
        public SuggestSkillsResponse suggestSkillsFromSkills(List<SkillScore> skills,
-                                                     int limit,
-                                                     String outputLanguage)
-                                              throws TxException
        -
        Returns skills related to a given skill or set of skills. The service returns closely related skills in a sense that - knowing the provided skills either implies knowledge about the returned related skills, or should make it considerably - easier to acquire knowledge about them.
        -
        -
        Parameters:
        -
        skills - The skills (and optionally, scores) for which the service should return related skills. The list can contain up to 50 skills.
        -
        limit - The maximum amount of suggested skills returned. The maximum is 25.
        -
        outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        suggestSkillsFromSkills

        -
        public SuggestSkillsResponse suggestSkillsFromSkills(List<String> skillIds,
-                                                     String outputLanguage)
-                                              throws TxException
        -
        Returns skills related to a given skill or set of skills. The service returns closely related skills in a sense that - knowing the provided skills either implies knowledge about the returned related skills, or should make it considerably - easier to acquire knowledge about them.
        -
        -
        Parameters:
        -
        skillIds - The skill IDs for which the service should return related skills. The list can contain up to 50 skills.
        -
        outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        suggestSkillsFromSkills

        -
        public SuggestSkillsResponse suggestSkillsFromSkills(ParsedJob job,
-                                                     int limit,
-                                                     String outputLanguage)
-                                              throws TxException
        -
        Suggests skills related to a job (but not in the job) based on the skills in the job. The service returns closely related skills in a sense that - knowing the provided skills either implies knowledge about the returned related skills, or should make it considerably - easier to acquire knowledge about them.
        -
        -
        Parameters:
        -
        job - The job to suggest skills for (based on the skills in the job).
        -
        limit - The maximum amount of suggested skills returned. The maximum is 25.
        -
        outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        suggestSkillsFromSkills

        -
        public SuggestSkillsResponse suggestSkillsFromSkills(ParsedJob job,
-                                                     String outputLanguage)
-                                              throws TxException
        -
        Suggests skills related to a job (but not in the job) based on the skills in the job. The service returns closely related skills in a sense that - knowing the provided skills either implies knowledge about the returned related skills, or should make it considerably - easier to acquire knowledge about them.
        -
        -
        Parameters:
        -
        job - The job to suggest skills for (based on the skills in the job).
        -
        outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        suggestSkillsFromSkills

        -
        public SuggestSkillsResponse suggestSkillsFromSkills(ParsedResume resume,
-                                                     int limit,
-                                                     String outputLanguage,
-                                                     boolean weightSkillsByExperience)
-                                              throws TxException
        -
        Suggests skills related to a resume (but not in the resume) based on the skills in the resume. The service returns closely related skills in a sense that - knowing the provided skills either implies knowledge about the returned related skills, or should make it considerably - easier to acquire knowledge about them.
        -
        -
        Parameters:
        -
        resume - The resume to suggest skills for (based on the skills in the resume).
        -
        limit - The maximum amount of suggested skills returned. The maximum is 25.
        -
        outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code
        -
        weightSkillsByExperience - Whether or not to give a higher weight to skills that the candidate has more experience with.
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        suggestSkillsFromSkills

        -
        public SuggestSkillsResponse suggestSkillsFromSkills(ParsedResume resume,
-                                                     String outputLanguage)
-                                              throws TxException
        -
        Suggests skills related to a resume (but not in the resume) based on the skills in the resume. The service returns closely related skills in a sense that - knowing the provided skills either implies knowledge about the returned related skills, or should make it considerably - easier to acquire knowledge about them.
        -
        -
        Parameters:
        -
        resume - The resume to suggest skills for (based on the skills in the resume).
        -
        outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        skillsSimilarityScore

        -
        public SkillsSimilarityScoreResponse skillsSimilarityScore(List<SkillScore> skillSetA,
-                                                           List<SkillScore> skillSetB)
-                                                    throws TxException
        -
        Determines how closely related one set of skills is to another. The service defines closely related skills - such that knowing a skill either implies knowledge about another skill, or should make it considerably - easier to acquire knowledge about that skill.
        -
        -
        Parameters:
        -
        skillSetA - A set of skills (and optionally, scores) to score against the other set of skills. The list can contain up to 50 skills.
        -
        skillSetB - A set of skills (and optionally, scores) to score against the other set of skills. The list can contain up to 50 skills.
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        suggestSkillsFromProfessionsV2

        -
        public SuggestSkillsResponse suggestSkillsFromProfessionsV2(List<Integer> professionCodeIds,
-                                                            int limit,
-                                                            String outputLanguage,
-                                                            List<String> types)
-                                                     throws TxException
        -
        Suggests skills related to given professions. The service returns salient skills that are strongly associated with the professions.
        -
        -
        Parameters:
        -
        professionCodeIds - The code IDs of the professions to suggest skills for.
        -
        limit - The maximum amount of suggested skills returned. If not sure what value should be, provide 10 as default limit.
        -
        outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code
        -
        types - If specified, only these types of skills will be returned. The following values are acceptable: Professional, IT, Language, Soft, Certfication, All.
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        suggestSkillsFromProfessionsV2

        -
        public SuggestSkillsResponse suggestSkillsFromProfessionsV2(List<Integer> professionCodeIds,
-                                                            String outputLanguage)
-                                                     throws TxException
        -
        Suggests skills related to given professions. The service returns salient skills that are strongly associated with the professions.
        -
        -
        Parameters:
        -
        professionCodeIds - The code IDs of the professions to suggest skills for.
        -
        outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        suggestSkillsFromProfessionsV2

        -
        public SuggestSkillsResponse suggestSkillsFromProfessionsV2(ParsedResume resume,
-                                                            String outputLanguage)
-                                                     throws TxException
        -
        Suggests skills related to a resume based on the recent professions in the resume.
        -
        -
        Parameters:
        -
        resume - The resume to suggest skills for (based on the professions in the resume).
        -
        outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        suggestSkillsFromProfessionsV2

        -
        public SuggestSkillsResponse suggestSkillsFromProfessionsV2(ParsedResume resume)
-                                                     throws TxException
        -
        Suggests skills related to a resume based on the recent professions in the resume.
        -
        -
        Parameters:
        -
        resume - The resume to suggest skills for (based on the professions in the resume).
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        suggestSkillsFromProfessionsV2

        -
        public SuggestSkillsResponse suggestSkillsFromProfessionsV2(ParsedJob job,
-                                                            String outputLanguage)
-                                                     throws TxException
        -
        Suggests skills related to a job based on the profession title in the job.
        -
        -
        Parameters:
        -
        job - The resume to suggest skills for (based on the professions in the resume).
        -
        outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        suggestSkillsFromProfessionsV2

        -
        public SuggestSkillsResponse suggestSkillsFromProfessionsV2(ParsedJob job)
-                                                     throws TxException
        -
        Suggests skills related to a job based on the profession title in the job.
        -
        -
        Parameters:
        -
        job - The resume to suggest skills for (based on the professions in the resume).
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        suggestProfessionsFromSkillsV2

        -
        public SuggestProfessionsResponse suggestProfessionsFromSkillsV2(ParsedResume resume,
-                                                                 int limit,
-                                                                 boolean returnMissingSkills,
-                                                                 String outputLanguage,
-                                                                 boolean weightSkillsByExperience)
-                                                          throws TxException
        -
        Suggest professions based on the skills within a given resume.
        -
        -
        Parameters:
        -
        resume - The professions are suggested based on the skills within this resume.
        -
        limit - The maximum amount of professions returned. If not sure what value should be, provide 10 as default limit.
        -
        returnMissingSkills - Flag to enable returning a list of missing skills per suggested profession.
        -
        outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code
        -
        weightSkillsByExperience - Whether or not to give a higher weight to skills that the candidate has more experience with.
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        suggestProfessionsFromSkillsV2

        -
        public SuggestProfessionsResponse suggestProfessionsFromSkillsV2(ParsedResume resume,
-                                                                 String outputLanguage)
-                                                          throws TxException
        -
        Suggest professions based on the skills within a given resume.
        -
        -
        Parameters:
        -
        resume - The professions are suggested based on the skills within this resume. Defaults limit returned to 10 and does not return missing skills. Use another overload to specify these parameters.
        -
        outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        suggestProfessionsFromSkillsV2

        -
        public SuggestProfessionsResponse suggestProfessionsFromSkillsV2(ParsedResume resume)
-                                                          throws TxException
        -
        Suggest professions based on the skills within a given resume.
        -
        -
        Parameters:
        -
        resume - The professions are suggested based on the skills within this resume. Defaults limit returned to 10 and does not return missing skills. Use another overload to specify these parameters.
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        suggestProfessionsFromSkillsV2

        -
        public SuggestProfessionsResponse suggestProfessionsFromSkillsV2(ParsedJob job,
-                                                                 int limit,
-                                                                 boolean returnMissingSkills,
-                                                                 String outputLanguage)
-                                                          throws TxException
        -
        Suggest professions based on the skills within a given job.
        -
        -
        Parameters:
        -
        job - The professions are suggested based on the skills within this job.
        -
        limit - The maximum amount of professions returned. If not sure what value should be, provide 10 as default limit.
        -
        returnMissingSkills - Flag to enable returning a list of missing skills per suggested profession.
        -
        outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        suggestProfessionsFromSkillsV2

        -
        public SuggestProfessionsResponse suggestProfessionsFromSkillsV2(ParsedJob job,
-                                                                 String outputLanguage)
-                                                          throws TxException
        -
        Suggest professions based on the skills within a given job.
        -
        -
        Parameters:
        -
        job - The professions are suggested based on the skills within this job. Defaults limit returned to 10 and does not return missing skills. Use another overload to specify these parameters.
        -
        outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        suggestProfessionsFromSkillsV2

        -
        public SuggestProfessionsResponse suggestProfessionsFromSkillsV2(ParsedJob job)
-                                                          throws TxException
        -
        Suggest professions based on the skills within a given job.
        -
        -
        Parameters:
        -
        job - The professions are suggested based on the skills within this job. Defaults limit returned to 10 and does not return missing skills. Use another overload to specify these parameters.
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        suggestProfessionsFromSkillsV2

        -
        public SuggestProfessionsResponse suggestProfessionsFromSkillsV2(List<SkillScore> skills,
-                                                                 int limit,
-                                                                 boolean returnMissingSkills,
-                                                                 String outputLanguage)
-                                                          throws TxException
        -
        Suggest professions based on a given set of skills.
        -
        -
        Parameters:
        -
        skills - The skills used to return the most relevant professions. The list can contain up to 50 skills.
        -
        limit - The maximum amount of professions returned. If not sure what value should be, provide 10 as default limit.
        -
        returnMissingSkills - Flag to enable returning a list of missing skills per suggested profession.
        -
        outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        suggestProfessionsFromSkillsV2

        -
        public SuggestProfessionsResponse suggestProfessionsFromSkillsV2(List<String> skillIds,
-                                                                 String outputLanguage)
-                                                          throws TxException
        -
        Suggest professions based on a given set of skill IDs.
        -
        -
        Parameters:
        -
        skillIds - The skill IDs used to return the most relevant professions. The list can contain up to 50 skill IDs. Defaults limit returned to 10 and does not return missing skills. Use another overload to specify these parameters.
        -
        outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        suggestSkillsFromSkillsV2

        -
        public SuggestSkillsResponse suggestSkillsFromSkillsV2(List<SkillScore> skills,
-                                                       int limit,
-                                                       String outputLanguage,
-                                                       List<String> types)
-                                                throws TxException
        -
        Returns skills related to a given skill or set of skills. The service returns closely related skills in a sense that - knowing the provided skills either implies knowledge about the returned related skills, or should make it considerably - easier to acquire knowledge about them.
        -
        -
        Parameters:
        -
        skills - The skills (and optionally, scores) for which the service should return related skills. The list can contain up to 50 skills.
        -
        limit - The maximum amount of suggested skills returned. The maximum is 25.
        -
        outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code
        -
        types - If specified, only these types of skills will be returned. The following values are acceptable: Professional, IT, Language, Soft, Certfication, All.
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        suggestSkillsFromSkillsV2

        -
        public SuggestSkillsResponse suggestSkillsFromSkillsV2(List<String> skillIds,
-                                                       String outputLanguage)
-                                                throws TxException
        -
        Returns skills related to a given skill or set of skills. The service returns closely related skills in a sense that - knowing the provided skills either implies knowledge about the returned related skills, or should make it considerably - easier to acquire knowledge about them.
        -
        -
        Parameters:
        -
        skillIds - The skill IDs for which the service should return related skills. The list can contain up to 50 skills.
        -
        outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        suggestSkillsFromSkillsV2

        -
        public SuggestSkillsResponse suggestSkillsFromSkillsV2(ParsedJob job,
-                                                       int limit,
-                                                       String outputLanguage)
-                                                throws TxException
        -
        Suggests skills related to a job (but not in the job) based on the skills in the job. The service returns closely related skills in a sense that - knowing the provided skills either implies knowledge about the returned related skills, or should make it considerably - easier to acquire knowledge about them.
        -
        -
        Parameters:
        -
        job - The job to suggest skills for (based on the skills in the job).
        -
        limit - The maximum amount of suggested skills returned. The maximum is 25.
        -
        outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        suggestSkillsFromSkillsV2

        -
        public SuggestSkillsResponse suggestSkillsFromSkillsV2(ParsedJob job,
-                                                       String outputLanguage)
-                                                throws TxException
        -
        Suggests skills related to a job (but not in the job) based on the skills in the job. The service returns closely related skills in a sense that - knowing the provided skills either implies knowledge about the returned related skills, or should make it considerably - easier to acquire knowledge about them.
        -
        -
        Parameters:
        -
        job - The job to suggest skills for (based on the skills in the job).
        -
        outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        suggestSkillsFromSkillsV2

        -
        public SuggestSkillsResponse suggestSkillsFromSkillsV2(ParsedResume resume,
-                                                       int limit,
-                                                       String outputLanguage,
-                                                       boolean weightSkillsByExperience)
-                                                throws TxException
        -
        Suggests skills related to a resume (but not in the resume) based on the skills in the resume. The service returns closely related skills in a sense that - knowing the provided skills either implies knowledge about the returned related skills, or should make it considerably - easier to acquire knowledge about them.
        -
        -
        Parameters:
        -
        resume - The resume to suggest skills for (based on the skills in the resume).
        -
        limit - The maximum amount of suggested skills returned. The maximum is 25.
        -
        outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code
        -
        weightSkillsByExperience - Whether or not to give a higher weight to skills that the candidate has more experience with.
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        suggestSkillsFromSkillsV2

        -
        public SuggestSkillsResponse suggestSkillsFromSkillsV2(ParsedResume resume,
-                                                       String outputLanguage)
-                                                throws TxException
        -
        Suggests skills related to a resume (but not in the resume) based on the skills in the resume. The service returns closely related skills in a sense that - knowing the provided skills either implies knowledge about the returned related skills, or should make it considerably - easier to acquire knowledge about them.
        -
        -
        Parameters:
        -
        resume - The resume to suggest skills for (based on the skills in the resume).
        -
        outputLanguage - The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        skillsSimilarityScoreV2

        -
        public SkillsSimilarityScoreResponse skillsSimilarityScoreV2(List<SkillScore> skillSetA,
-                                                             List<SkillScore> skillSetB)
-                                                      throws TxException
        -
        Determines how closely related one set of skills is to another. The service defines closely related skills - such that knowing a skill either implies knowledge about another skill, or should make it considerably - easier to acquire knowledge about that skill.
        -
        -
        Parameters:
        -
        skillSetA - A set of skills (and optionally, scores) to score against the other set of skills. The list can contain up to 50 skills.
        -
        skillSetB - A set of skills (and optionally, scores) to score against the other set of skills. The list can contain up to 50 skills.
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        generateJobDescription

        -
        public GenerateJobResponse generateJobDescription(GenerateJobRequest request)
-                                           throws TxException
        -
        Generates a job description based on specified parameters.
        -
        -
        Parameters:
        -
        request - The request body
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        suggestSkillsFromJobTitle

        -
        public SuggestSkillsFromJobTitleResponse suggestSkillsFromJobTitle(String jobTitle,
-                                                                   String language,
-                                                                   Integer limit)
-                                                            throws TxException
        -
        Takes a job title and suggests relevant skills.
        -
        -
        Parameters:
        -
        jobTitle - The title of the job for which skills are being suggested.
        -
        language - Language of the suggested skills in ISO 639-1 code format.
        -
        limit - Maximum number of skills to suggest. If not specified this parameter defaults to 10. This value cannot exceed 50.
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        suggestSkillsFromJobTitle

        -
        public SuggestSkillsFromJobTitleResponse suggestSkillsFromJobTitle(String jobTitle)
-                                                            throws TxException
        -
        Takes a job title and suggests relevant skills.
        -
        -
        Parameters:
        -
        jobTitle - The title of the job for which skills are being suggested.
        -
        Returns:
        -
        The API response body
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/TxUIClient.html b/docs/com/textkernel/tx/TxUIClient.html deleted file mode 100644 index 8a2979b31..000000000 --- a/docs/com/textkernel/tx/TxUIClient.html +++ /dev/null @@ -1,461 +0,0 @@ - - - - - - -TxUIClient (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx
-

Class TxUIClient

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        match

        -
        public GenerateUIResponse match(ParsedResume resume,
-                                List<String> indexesToQuery,
-                                CategoryWeights preferredWeights,
-                                FilterCriteria filters,
-                                SearchMatchSettings settings,
-                                int numResults)
-                         throws TxException
        -
        Create a Matching UI session to find matches for a non-indexed resume.
        -
        -
        Parameters:
        -
        resume - The resume (generated by the Resume Parser) to use as the source for a match query
        -
        indexesToQuery - The indexes to find results in. These must all be of the same type (resumes or jobs)
        -
        preferredWeights - The preferred category weights for scoring the results. If null, - The best values will be determined based on the source resume
        -
        filters - Any filters to apply prior to the match (a result must satisfy all the filters), or null
        -
        settings - The settings for this match request. Use null for defaults.
        -
        numResults - The number of results to show. Use 0 for the default.
        -
        Returns:
        -
        The response containing a URL for the Matching UI session
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        match

        -
        public GenerateUIResponse match(ParsedJob job,
-                                List<String> indexesToQuery,
-                                CategoryWeights preferredWeights,
-                                FilterCriteria filters,
-                                SearchMatchSettings settings,
-                                int numResults)
-                         throws TxException
        -
        Create a Matching UI session to find matches for a non-indexed job.
        -
        -
        Parameters:
        -
        job - The job (generated by the Job Parser) to use as the source for a match query
        -
        indexesToQuery - The indexes to find results in. These must all be of the same type (resumes or jobs)
        -
        preferredWeights - The preferred category weights for scoring the results. If null, - The best values will be determined based on the source job
        -
        filters - Any filters to apply prior to the match (a result must satisfy all the filters), or null
        -
        settings - The settings for this match request. Use null for defaults.
        -
        numResults - The number of results to show. Use 0 for the default.
        -
        Returns:
        -
        The response containing a URL for the Matching UI session
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        match

        -
        public GenerateUIResponse match(String indexId,
-                                String documentId,
-                                List<String> indexesToQuery,
-                                CategoryWeights preferredWeights,
-                                FilterCriteria filters,
-                                SearchMatchSettings settings,
-                                int numResults)
-                         throws TxException
        -
        Create a Matching UI session to find matches for a resume or job that is already indexed
        -
        -
        Parameters:
        -
        indexId - The index containing the document you want to match
        -
        documentId - The ID of the document to match
        -
        indexesToQuery - The indexes to find results in. These must all be of the same type (resumes or jobs)
        -
        preferredWeights - The preferred category weights for scoring the results. If null, - The best values will be determined based on the source resume/job
        -
        filters - Any filters to apply prior to the match (a result must satisfy all the filters), or null
        -
        settings - The settings for this match request. Use null for defaults.
        -
        numResults - The number of results to show. Use 0 for the default.
        -
        Returns:
        -
        The response containing a URL for the Matching UI session
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        search

        -
        public GenerateUIResponse search(List<String> indexesToQuery,
-                                 FilterCriteria query,
-                                 SearchMatchSettings settings,
-                                 PaginationSettings pagination)
-                          throws TxException
        -
        Create a Matching UI session to search for resumes or jobs that meet specific criteria
        -
        -
        Parameters:
        -
        indexesToQuery - The indexes to find results in. These must all be of the same type (resumes or jobs)
        -
        query - The search query. A result must satisfy all of these criteria
        -
        settings - The settings for this search request. Use null for defaults.
        -
        pagination - Pagination settings. Use null for defaults.
        -
        Returns:
        -
        The response containing a URL for the Matching UI session
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        bimetricScore

        -
        public <TTarget extends IParsedDocWithId> GenerateUIResponse bimetricScore(ParsedResumeWithId sourceResume,
-                                                                           List<TTarget> targetDocuments,
-                                                                           CategoryWeights preferredWeights,
-                                                                           SearchMatchSettings settings)
-                                                                    throws TxException
        -
        Create a Matching UI session to score one or more target documents against a source resume
        -
        -
        Type Parameters:
        -
        TTarget - Either ParsedResumeWithId or ParsedJobWithId
        -
        Parameters:
        -
        sourceResume - The source resume
        -
        targetDocuments - The target resumes/jobs
        -
        preferredWeights - The preferred category weights for scoring the results. If null, - The best values will be determined based on the source resume.
        -
        settings - The settings for this search request. Use null for defaults.
        -
        Returns:
        -
        The response containing a URL for the Matching UI session
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      - - - -
        -
      • -

        bimetricScore

        -
        public <TTarget extends IParsedDocWithId> GenerateUIResponse bimetricScore(ParsedJobWithId sourceJob,
-                                                                           List<TTarget> targetDocuments,
-                                                                           CategoryWeights preferredWeights,
-                                                                           SearchMatchSettings settings)
-                                                                    throws TxException
        -
        Create a Matching UI session to score one or more target documents against a source job
        -
        -
        Type Parameters:
        -
        TTarget - Either ParsedResumeWithId or ParsedJobWithId
        -
        Parameters:
        -
        sourceJob - The source job
        -
        targetDocuments - The target resumes/jobs
        -
        preferredWeights - The preferred category weights for scoring the results. If null, - The best values will be determined based on the source job.
        -
        settings - The settings for this search request. Use null for defaults.
        -
        Returns:
        -
        The response containing a URL for the Matching UI session
        -
        Throws:
        -
        TxException - Thrown when an API error occurs
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/class-use/DataCenter.html b/docs/com/textkernel/tx/class-use/DataCenter.html deleted file mode 100644 index 35e8f0f26..000000000 --- a/docs/com/textkernel/tx/class-use/DataCenter.html +++ /dev/null @@ -1,212 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.DataCenter (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.DataCenter

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/class-use/TxClient.html b/docs/com/textkernel/tx/class-use/TxClient.html deleted file mode 100644 index 3e0f365f1..000000000 --- a/docs/com/textkernel/tx/class-use/TxClient.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.TxClient (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.TxClient

-
-
No usage of com.textkernel.tx.TxClient
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/class-use/TxUIClient.html b/docs/com/textkernel/tx/class-use/TxUIClient.html deleted file mode 100644 index 622cc6e63..000000000 --- a/docs/com/textkernel/tx/class-use/TxUIClient.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.TxUIClient (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.TxUIClient

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/exceptions/TxException.html b/docs/com/textkernel/tx/exceptions/TxException.html deleted file mode 100644 index a43f89bc6..000000000 --- a/docs/com/textkernel/tx/exceptions/TxException.html +++ /dev/null @@ -1,410 +0,0 @@ - - - - - - -TxException (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.exceptions
-

Class TxException

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        RestResponse

        -
        public okhttp3.Response RestResponse
        -
        The raw response from the API
        -
        • -
      - - - -
        -
      • -

        HttpStatusCode

        -
        public int HttpStatusCode
        -
        The HTTP Status Code of the response. See https://developer.textkernel.com/tx-platform/v10/overview/#http-status-codes
        -
        • -
      - - - -
        -
      • -

        TxErrorCode

        -
        public String TxErrorCode
        -
        The Info.Code of the response. This will indicate what type of error occurred. See https://developer.textkernel.com/tx-platform/v10/overview/#http-status-codes
        -
        • -
      - - - -
        -
      • -

        TransactionId

        -
        public String TransactionId
        -
        The Id of the transaction, use this when reporting errors to Support
        -
        • -
      - - - - - - - -
        -
      • -

        InnerException

        -
        public Exception InnerException
        -
        If this exception was caused by another exception, the root cause will be here.
        -
        • -
      -
      • -
    - - -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/exceptions/TxGeocodeJobException.html b/docs/com/textkernel/tx/exceptions/TxGeocodeJobException.html deleted file mode 100644 index 3c8bad873..000000000 --- a/docs/com/textkernel/tx/exceptions/TxGeocodeJobException.html +++ /dev/null @@ -1,303 +0,0 @@ - - - - - - -TxGeocodeJobException (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.exceptions
-

Class TxGeocodeJobException

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    Serializable
    -
    -
    -
    -
    public class TxGeocodeJobException
-extends TxUsableJobException
    -
    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)
    -
    -
    See Also:
    -
    Serialized Form
    -
    -
    • -
-
-
- -
-
- -
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/exceptions/TxGeocodeResumeException.html b/docs/com/textkernel/tx/exceptions/TxGeocodeResumeException.html deleted file mode 100644 index 02d40498a..000000000 --- a/docs/com/textkernel/tx/exceptions/TxGeocodeResumeException.html +++ /dev/null @@ -1,303 +0,0 @@ - - - - - - -TxGeocodeResumeException (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.exceptions
-

Class TxGeocodeResumeException

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    Serializable
    -
    -
    -
    -
    public class TxGeocodeResumeException
-extends TxUsableResumeException
    -
    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)
    -
    -
    See Also:
    -
    Serialized Form
    -
    -
    • -
-
-
- -
-
- -
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/exceptions/TxIndexJobException.html b/docs/com/textkernel/tx/exceptions/TxIndexJobException.html deleted file mode 100644 index 730614c70..000000000 --- a/docs/com/textkernel/tx/exceptions/TxIndexJobException.html +++ /dev/null @@ -1,303 +0,0 @@ - - - - - - -TxIndexJobException (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.exceptions
-

Class TxIndexJobException

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    Serializable
    -
    -
    -
    -
    public class TxIndexJobException
-extends TxUsableJobException
    -
    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)
    -
    -
    See Also:
    -
    Serialized Form
    -
    -
    • -
-
-
- -
-
- -
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/exceptions/TxIndexResumeException.html b/docs/com/textkernel/tx/exceptions/TxIndexResumeException.html deleted file mode 100644 index f0f1c44c4..000000000 --- a/docs/com/textkernel/tx/exceptions/TxIndexResumeException.html +++ /dev/null @@ -1,303 +0,0 @@ - - - - - - -TxIndexResumeException (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.exceptions
-

Class TxIndexResumeException

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    Serializable
    -
    -
    -
    -
    public class TxIndexResumeException
-extends TxUsableResumeException
    -
    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)
    -
    -
    See Also:
    -
    Serialized Form
    -
    -
    • -
-
-
- -
-
- -
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/exceptions/TxProfessionNormalizationJobException.html b/docs/com/textkernel/tx/exceptions/TxProfessionNormalizationJobException.html deleted file mode 100644 index 59c0e35eb..000000000 --- a/docs/com/textkernel/tx/exceptions/TxProfessionNormalizationJobException.html +++ /dev/null @@ -1,303 +0,0 @@ - - - - - - -TxProfessionNormalizationJobException (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.exceptions
-

Class TxProfessionNormalizationJobException

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    Serializable
    -
    -
    -
    -
    public class TxProfessionNormalizationJobException
-extends TxUsableJobException
    -
    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)
    -
    -
    See Also:
    -
    Serialized Form
    -
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        TxProfessionNormalizationJobException

        -
        public TxProfessionNormalizationJobException(okhttp3.Response response,
-                                             ApiResponseInfoLite errorInfo,
-                                             String transactionId,
-                                             ParseJobResponse parseResponse)
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/exceptions/TxProfessionNormalizationResumeException.html b/docs/com/textkernel/tx/exceptions/TxProfessionNormalizationResumeException.html deleted file mode 100644 index 314e39684..000000000 --- a/docs/com/textkernel/tx/exceptions/TxProfessionNormalizationResumeException.html +++ /dev/null @@ -1,303 +0,0 @@ - - - - - - -TxProfessionNormalizationResumeException (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.exceptions
-

Class TxProfessionNormalizationResumeException

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    Serializable
    -
    -
    -
    -
    public class TxProfessionNormalizationResumeException
-extends TxUsableResumeException
    -
    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)
    -
    -
    See Also:
    -
    Serialized Form
    -
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        TxProfessionNormalizationResumeException

        -
        public TxProfessionNormalizationResumeException(okhttp3.Response response,
-                                                ApiResponseInfoLite errorInfo,
-                                                String transactionId,
-                                                ParseResumeResponse parseResponse)
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/exceptions/TxUsableJobException.html b/docs/com/textkernel/tx/exceptions/TxUsableJobException.html deleted file mode 100644 index b92002887..000000000 --- a/docs/com/textkernel/tx/exceptions/TxUsableJobException.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - -TxUsableJobException (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.exceptions
-

Class TxUsableJobException

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Response

        -
        public ParseJobResponse Response
        -
        This may or may not be null or incomplete depending on what specific error occurred
        -
        • -
      -
      • -
    - - -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/exceptions/TxUsableResumeException.html b/docs/com/textkernel/tx/exceptions/TxUsableResumeException.html deleted file mode 100644 index 1b850f6f7..000000000 --- a/docs/com/textkernel/tx/exceptions/TxUsableResumeException.html +++ /dev/null @@ -1,326 +0,0 @@ - - - - - - -TxUsableResumeException (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.exceptions
-

Class TxUsableResumeException

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Response

        -
        public ParseResumeResponse Response
        -
        This may or may not be null or incomplete depending on what specific error occurred
        -
        • -
      -
      • -
    - - -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/exceptions/class-use/TxException.html b/docs/com/textkernel/tx/exceptions/class-use/TxException.html deleted file mode 100644 index dfe3aa371..000000000 --- a/docs/com/textkernel/tx/exceptions/class-use/TxException.html +++ /dev/null @@ -1,1133 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.exceptions.TxException (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.exceptions.TxException

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/exceptions/class-use/TxGeocodeJobException.html b/docs/com/textkernel/tx/exceptions/class-use/TxGeocodeJobException.html deleted file mode 100644 index 6ac555d52..000000000 --- a/docs/com/textkernel/tx/exceptions/class-use/TxGeocodeJobException.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.exceptions.TxGeocodeJobException (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.exceptions.TxGeocodeJobException

-
-
No usage of com.textkernel.tx.exceptions.TxGeocodeJobException
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/exceptions/class-use/TxGeocodeResumeException.html b/docs/com/textkernel/tx/exceptions/class-use/TxGeocodeResumeException.html deleted file mode 100644 index cd5b7cb39..000000000 --- a/docs/com/textkernel/tx/exceptions/class-use/TxGeocodeResumeException.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.exceptions.TxGeocodeResumeException (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.exceptions.TxGeocodeResumeException

-
-
No usage of com.textkernel.tx.exceptions.TxGeocodeResumeException
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/exceptions/class-use/TxIndexJobException.html b/docs/com/textkernel/tx/exceptions/class-use/TxIndexJobException.html deleted file mode 100644 index d51f4d3d2..000000000 --- a/docs/com/textkernel/tx/exceptions/class-use/TxIndexJobException.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.exceptions.TxIndexJobException (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.exceptions.TxIndexJobException

-
-
No usage of com.textkernel.tx.exceptions.TxIndexJobException
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/exceptions/class-use/TxIndexResumeException.html b/docs/com/textkernel/tx/exceptions/class-use/TxIndexResumeException.html deleted file mode 100644 index b4170d60d..000000000 --- a/docs/com/textkernel/tx/exceptions/class-use/TxIndexResumeException.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.exceptions.TxIndexResumeException (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.exceptions.TxIndexResumeException

-
-
No usage of com.textkernel.tx.exceptions.TxIndexResumeException
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/exceptions/class-use/TxProfessionNormalizationJobException.html b/docs/com/textkernel/tx/exceptions/class-use/TxProfessionNormalizationJobException.html deleted file mode 100644 index eeb051de8..000000000 --- a/docs/com/textkernel/tx/exceptions/class-use/TxProfessionNormalizationJobException.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.exceptions.TxProfessionNormalizationJobException (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.exceptions.TxProfessionNormalizationJobException

-
-
No usage of com.textkernel.tx.exceptions.TxProfessionNormalizationJobException
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/exceptions/class-use/TxProfessionNormalizationResumeException.html b/docs/com/textkernel/tx/exceptions/class-use/TxProfessionNormalizationResumeException.html deleted file mode 100644 index cae644aab..000000000 --- a/docs/com/textkernel/tx/exceptions/class-use/TxProfessionNormalizationResumeException.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.exceptions.TxProfessionNormalizationResumeException (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.exceptions.TxProfessionNormalizationResumeException

-
-
No usage of com.textkernel.tx.exceptions.TxProfessionNormalizationResumeException
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/exceptions/class-use/TxUsableJobException.html b/docs/com/textkernel/tx/exceptions/class-use/TxUsableJobException.html deleted file mode 100644 index 3161b74ff..000000000 --- a/docs/com/textkernel/tx/exceptions/class-use/TxUsableJobException.html +++ /dev/null @@ -1,180 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.exceptions.TxUsableJobException (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.exceptions.TxUsableJobException

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/exceptions/class-use/TxUsableResumeException.html b/docs/com/textkernel/tx/exceptions/class-use/TxUsableResumeException.html deleted file mode 100644 index 530cffeeb..000000000 --- a/docs/com/textkernel/tx/exceptions/class-use/TxUsableResumeException.html +++ /dev/null @@ -1,180 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.exceptions.TxUsableResumeException (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.exceptions.TxUsableResumeException

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/exceptions/package-frame.html b/docs/com/textkernel/tx/exceptions/package-frame.html deleted file mode 100644 index 52d39ea67..000000000 --- a/docs/com/textkernel/tx/exceptions/package-frame.html +++ /dev/null @@ -1,29 +0,0 @@ - - - - - - -com.textkernel.tx.exceptions (Textkernel Tx Java SDK 2.3.3 API) - - - - - -

com.textkernel.tx.exceptions

-
-

Exceptions

- -
- - diff --git a/docs/com/textkernel/tx/exceptions/package-summary.html b/docs/com/textkernel/tx/exceptions/package-summary.html deleted file mode 100644 index 70cc1e9e7..000000000 --- a/docs/com/textkernel/tx/exceptions/package-summary.html +++ /dev/null @@ -1,194 +0,0 @@ - - - - - - -com.textkernel.tx.exceptions (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package com.textkernel.tx.exceptions

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/exceptions/package-tree.html b/docs/com/textkernel/tx/exceptions/package-tree.html deleted file mode 100644 index fc0600f1d..000000000 --- a/docs/com/textkernel/tx/exceptions/package-tree.html +++ /dev/null @@ -1,164 +0,0 @@ - - - - - - -com.textkernel.tx.exceptions Class Hierarchy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package com.textkernel.tx.exceptions

-Package Hierarchies: - -
-
-

Class Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/exceptions/package-use.html b/docs/com/textkernel/tx/exceptions/package-use.html deleted file mode 100644 index 05a72ecaa..000000000 --- a/docs/com/textkernel/tx/exceptions/package-use.html +++ /dev/null @@ -1,192 +0,0 @@ - - - - - - -Uses of Package com.textkernel.tx.exceptions (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Package
com.textkernel.tx.exceptions

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/http/HttpResponse.html b/docs/com/textkernel/tx/http/HttpResponse.html deleted file mode 100644 index 6e1255fa3..000000000 --- a/docs/com/textkernel/tx/http/HttpResponse.html +++ /dev/null @@ -1,294 +0,0 @@ - - - - - - -HttpResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
com.textkernel.tx.http
-

Class HttpResponse<T extends ApiResponse<?>>

-
-
- -
-
    -
  • -
    -
    -
    public class HttpResponse<T extends ApiResponse<?>>
-extends Object
    -
    A simple class to contain a raw OkHttp Response and a deserialized response body
    -
    • -
-
-
- -
-
-
    -
  • - - - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getResponse

        -
        public okhttp3.Response getResponse()
        -
        • -
      - - - -
        -
      • -

        getData

        -
        public T getData()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/http/class-use/HttpResponse.html b/docs/com/textkernel/tx/http/class-use/HttpResponse.html deleted file mode 100644 index e526de084..000000000 --- a/docs/com/textkernel/tx/http/class-use/HttpResponse.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.http.HttpResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.http.HttpResponse

-
-
No usage of com.textkernel.tx.http.HttpResponse
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/http/package-frame.html b/docs/com/textkernel/tx/http/package-frame.html deleted file mode 100644 index 2aa549c79..000000000 --- a/docs/com/textkernel/tx/http/package-frame.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - -com.textkernel.tx.http (Textkernel Tx Java SDK 2.3.3 API) - - - - - -

com.textkernel.tx.http

-
-

Classes

- -
- - diff --git a/docs/com/textkernel/tx/http/package-summary.html b/docs/com/textkernel/tx/http/package-summary.html deleted file mode 100644 index 1deb6e68c..000000000 --- a/docs/com/textkernel/tx/http/package-summary.html +++ /dev/null @@ -1,146 +0,0 @@ - - - - - - -com.textkernel.tx.http (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package com.textkernel.tx.http

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/http/package-tree.html b/docs/com/textkernel/tx/http/package-tree.html deleted file mode 100644 index 02ce8a43d..000000000 --- a/docs/com/textkernel/tx/http/package-tree.html +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - -com.textkernel.tx.http Class Hierarchy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package com.textkernel.tx.http

-Package Hierarchies: - -
-
-

Class Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/http/package-use.html b/docs/com/textkernel/tx/http/package-use.html deleted file mode 100644 index 40de5f83d..000000000 --- a/docs/com/textkernel/tx/http/package-use.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Package com.textkernel.tx.http (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Package
com.textkernel.tx.http

-
-
No usage of com.textkernel.tx.http
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/Document.html b/docs/com/textkernel/tx/models/Document.html deleted file mode 100644 index 844a91842..000000000 --- a/docs/com/textkernel/tx/models/Document.html +++ /dev/null @@ -1,369 +0,0 @@ - - - - - - -Document (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models
-

Class Document

-
-
- -
-
    -
  • -
    -
    -
    public class Document
-extends Object
    -
    Represents an unparsed document (a file on the filesystem, byte[] from a database, etc)
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        _asBase64

        -
        protected String _asBase64
        -
        • -
      - - - -
        -
      • -

        LastModified

        -
        public java.time.LocalDate LastModified
        -
        The last revised/modified date for this file.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        Document

        -
        public Document(byte[] fileBytes,
-                java.time.LocalDate lastModified)
        -
        Create a Document from a file byte[]
        -
        -
        Parameters:
        -
        fileBytes - - The file byte array
        -
        lastModified - - The last-revised date for this file. -

        This is extremely important so that the Parser knows how to interpret dates in the document that are - expressed as "current" or "as of" (or similar) to correctly calculate date spans

        -
        Throws:
        -
        IllegalArgumentException - If the fileBytes is null or empty
        -
        -
        • -
      - - - - -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getAsBase64

        -
        public String getAsBase64()
        -
        -
        Returns:
        -
        The base-64 encoded byte[] for this file. This is what is sent over HTTPS to the API
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/GeoCoordinates.html b/docs/com/textkernel/tx/models/GeoCoordinates.html deleted file mode 100644 index de5041e60..000000000 --- a/docs/com/textkernel/tx/models/GeoCoordinates.html +++ /dev/null @@ -1,299 +0,0 @@ - - - - - - -GeoCoordinates (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models
-

Class GeoCoordinates

-
-
- -
-
    -
  • -
    -
    Direct Known Subclasses:
    -
    GeocodedCoordinates
    -
    -
    -
    -
    public class GeoCoordinates
-extends Object
    -
    Represents a lat/lon
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Latitude

        -
        public double Latitude
        -
        The latitude, in degrees
        -
        • -
      - - - -
        -
      • -

        Longitude

        -
        public double Longitude
        -
        The longitude, in degrees
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        GeoCoordinates

        -
        public GeoCoordinates()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/GeocodedCoordinates.html b/docs/com/textkernel/tx/models/GeocodedCoordinates.html deleted file mode 100644 index 2be2d7231..000000000 --- a/docs/com/textkernel/tx/models/GeocodedCoordinates.html +++ /dev/null @@ -1,291 +0,0 @@ - - - - - - -GeocodedCoordinates (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models
-

Class GeocodedCoordinates

-
-
- -
-
    -
  • -
    -
    -
    public class GeocodedCoordinates
-extends GeoCoordinates
    -
    Represents a lat/lon provided by a 3rd party service
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Source

        -
        public String Source
        -
        The geocoding source, such as Google or Bing
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        GeocodedCoordinates

        -
        public GeocodedCoordinates()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/Location.html b/docs/com/textkernel/tx/models/Location.html deleted file mode 100644 index b8770633e..000000000 --- a/docs/com/textkernel/tx/models/Location.html +++ /dev/null @@ -1,359 +0,0 @@ - - - - - - -Location (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models
-

Class Location

-
-
- -
-
    -
  • -
    -
    -
    public class Location
-extends Object
    -
    Represents a physical location on Earth (mostly used for addresses)
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        CountryCode

        -
        public String CountryCode
        -
        The 2-letter ISO 3166 country code
        -
        • -
      - - - -
        -
      • -

        PostalCode

        -
        public String PostalCode
        -
        The Postal or Zip code
        -
        • -
      - - - -
        -
      • -

        Regions

        -
        public List<String> Regions
        -
        The Regions/Districts/States
        -
        • -
      - - - -
        -
      • -

        Municipality

        -
        public String Municipality
        -
        The City/Municipality/Town
        -
        • -
      - - - -
        -
      • -

        StreetAddressLines

        -
        public List<String> StreetAddressLines
        -
        Street address lines
        -
        • -
      - - - -
        -
      • -

        GeoCoordinates

        -
        public GeocodedCoordinates GeoCoordinates
        -
        If geocoding has been done, this is the lat/lon for the location
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        Location

        -
        public Location()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/ParsedDocument.html b/docs/com/textkernel/tx/models/ParsedDocument.html deleted file mode 100644 index feafca779..000000000 --- a/docs/com/textkernel/tx/models/ParsedDocument.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - - -ParsedDocument (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
com.textkernel.tx.models
-

Class ParsedDocument

-
-
- -
-
    -
  • -
    -
    Direct Known Subclasses:
    -
    ParsedJob, ParsedResume
    -
    -
    -
    -
    public abstract class ParsedDocument
-extends Object
    -
    Base class for parsed resumes/jobs
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ParsedDocument

        -
        public ParsedDocument()
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - - - - - -
        -
      • -

        toJson

        -
        public String toJson(boolean formatted)
        -
        -
        Parameters:
        -
        formatted - true for pretty-printing
        -
        Returns:
        -
        a JSON string that can be saved to disk or any other data storage. -
        NOTE: be sure to save with UTF-8 encoding!
        -
        -
        • -
      - - - -
        -
      • -

        toFile

        -
        public void toFile(String filepath,
-                   boolean formatted)
-            throws IOException
        -
        Save the json to disk using UTF-8 encoding
        -
        -
        Parameters:
        -
        filepath - The file to save to
        -
        formatted - true for pretty-printing
        -
        Throws:
        -
        IOException - When an error occurs writing the file
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/ParsedDocumentMetadata.html b/docs/com/textkernel/tx/models/ParsedDocumentMetadata.html deleted file mode 100644 index b480babe1..000000000 --- a/docs/com/textkernel/tx/models/ParsedDocumentMetadata.html +++ /dev/null @@ -1,357 +0,0 @@ - - - - - - -ParsedDocumentMetadata (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models
-

Class ParsedDocumentMetadata

-
-
- -
-
    -
  • -
    -
    Direct Known Subclasses:
    -
    JobMetadata, ResumeMetadata
    -
    -
    -
    -
    public class ParsedDocumentMetadata
-extends Object
    -
    Metadata about a parsed document
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        PlainText

        -
        public String PlainText
        -
        The plain text that was used for parsing
        -
        • -
      - - - -
        -
      • -

        DocumentLanguage

        -
        public String DocumentLanguage
        -
        An ISO 639-1 code that represents the primary language of the parsed text. When the - language could not be automatically determined, it is reported as the special value - iv(invariant/unknown). Note that the two-letter ISO codes reported by the - Parser - such as zh for Chinese - do not differentiate between language - variants, such as Mandarin and Cantonese.
        -
        • -
      - - - -
        -
      • -

        DocumentCulture

        -
        public String DocumentCulture
        -
        An ISO 3066 code that represents the cultural context of the document regarding formatting of - numbers, dates, character symbols, etc. This value is usually a simple concatenation of the - language and country codes, such as en-US for US English; however, note that culture - can be set independently of language and country to achieve fine-tuned cultural control over parsing, - so if you use this value you should not assume that it always matches the language and country.
        -
        • -
      - - - -
        -
      • -

        ParserSettings

        -
        public String ParserSettings
        -
        The full parser settings that were used during parsing
        -
        • -
      - - - -
        -
      • -

        DocumentLastModified

        -
        public java.time.LocalDate DocumentLastModified
        -
        The last-revised/last-modified date that was provided for the document. - This was used to calculate all of the important metrics about skills and jobs.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ParsedDocumentMetadata

        -
        public ParsedDocumentMetadata()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/TxDate.html b/docs/com/textkernel/tx/models/TxDate.html deleted file mode 100644 index f127483c4..000000000 --- a/docs/com/textkernel/tx/models/TxDate.html +++ /dev/null @@ -1,347 +0,0 @@ - - - - - - -TxDate (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models
-

Class TxDate

-
-
- -
-
    -
  • -
    -
    -
    public class TxDate
-extends Object
    -
    the custom Date type that represents dates found in resumes/jobs. The following are common examples: -

    - Current, as in "July 2018 - current". See IsCurrentDate -

    - Year only, as in "2018 - 2020". FoundYear will be true, FoundMonth and FoundDay will be false -

    - Year and month, as in "2018/06 - 2020/07". FoundYear and FoundMonth will be true, FoundDay will be false -

    - Year/month/day, as in "5/4/2018 - 7/2/2020". FoundYear, FoundMonth, and FoundDay will be true

    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Field Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - -
      Fields 
      Modifier and TypeField and Description
      java.time.LocalDateDate -
      The ISO 8601 (yyyy-MM-dd) date, if the day and/or month could not be found, they will be 01
      -
      booleanFoundDay -
      true if the day was found in the text (eg: June 7, 2020), otherwise false (eg: June 2020)
      -
      booleanFoundMonth -
      true if the month was found in the text (eg: June 2020), otherwise false (eg: 2020)
      -
      booleanFoundYear -
      true if the year was found in the text, otherwise false
      -
      booleanIsCurrentDate -
      true if this date represents '- current' and not an actual date
      -
      -
      • -
    - -
      -
    • - - -

      Constructor Summary

      - - - - - - - - -
      Constructors 
      Constructor and Description
      TxDate() 
      -
      • -
    - - -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Date

        -
        public java.time.LocalDate Date
        -
        The ISO 8601 (yyyy-MM-dd) date, if the day and/or month could not be found, they will be 01
        -
        • -
      - - - -
        -
      • -

        IsCurrentDate

        -
        public boolean IsCurrentDate
        -
        true if this date represents '- current' and not an actual date
        -
        • -
      - - - -
        -
      • -

        FoundYear

        -
        public boolean FoundYear
        -
        true if the year was found in the text, otherwise false
        -
        • -
      - - - -
        -
      • -

        FoundMonth

        -
        public boolean FoundMonth
        -
        true if the month was found in the text (eg: June 2020), otherwise false (eg: 2020)
        -
        • -
      - - - -
        -
      • -

        FoundDay

        -
        public boolean FoundDay
        -
        true if the day was found in the text (eg: June 7, 2020), otherwise false (eg: June 2020)
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        TxDate

        -
        public TxDate()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/TxPrimitive.html b/docs/com/textkernel/tx/models/TxPrimitive.html deleted file mode 100644 index 3942c872f..000000000 --- a/docs/com/textkernel/tx/models/TxPrimitive.html +++ /dev/null @@ -1,279 +0,0 @@ - - - - - - -TxPrimitive (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models
-

Class TxPrimitive<T>

-
-
- -
-
    -
  • -
    -
    -
    public class TxPrimitive<T>
-extends Object
    -
    Represents a native type (int, boolean, etc) that can have a value or be null
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Value

        -
        public T Value
        -
        The value for this object
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        TxPrimitive

        -
        public TxPrimitive()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/AccountInfo.html b/docs/com/textkernel/tx/models/api/AccountInfo.html deleted file mode 100644 index 5562c4404..000000000 --- a/docs/com/textkernel/tx/models/api/AccountInfo.html +++ /dev/null @@ -1,391 +0,0 @@ - - - - - - -AccountInfo (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api
-

Class AccountInfo

-
-
- -
-
    -
  • -
    -
    -
    public class AccountInfo
-extends Object
    -
    Contains information about the account making the API call
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        AccountId

        -
        public String AccountId
        -
        The AccountId for the account
        -
        • -
      - - - -
        -
      • -

        Name

        -
        public String Name
        -
        The customer name on the account
        -
        • -
      - - - -
        -
      • -

        IPAddress

        -
        public String IPAddress
        -
        The client IP Address where the API call originated
        -
        • -
      - - - -
        -
      • -

        Region

        -
        public String Region
        -
        The region for the account, also known as the 'Data Center'
        -
        • -
      - - - -
        -
      • -

        CreditsRemaining

        -
        public double CreditsRemaining
        -
        The number of credits remaining to be used by the account
        -
        • -
      - - - -
        -
      • -

        CreditsUsed

        -
        public double CreditsUsed
        -
        The number of credits used by the account
        -
        • -
      - - - -
        -
      • -

        MaximumConcurrentRequests

        -
        public int MaximumConcurrentRequests
        -
        The number of requests that can be made at one time
        -
        • -
      - - - -
        -
      • -

        ExpirationDate

        -
        public String ExpirationDate
        -
        The date that the current credits expire
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        AccountInfo

        -
        public AccountInfo()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/ApiResponse.html b/docs/com/textkernel/tx/models/api/ApiResponse.html deleted file mode 100644 index 178bd5041..000000000 --- a/docs/com/textkernel/tx/models/api/ApiResponse.html +++ /dev/null @@ -1,344 +0,0 @@ - - - - - - -ApiResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api
-

Class ApiResponse<T>

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Info

        -
        public ApiResponseInfo Info
        -
        Contains information about the response and the customer
        -
        • -
      - - - -
        -
      • -

        Value

        -
        public T Value
        -
        The data returned based on the request type/content
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ApiResponse

        -
        public ApiResponse()
        -
        • -
      -
      • -
    - - -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/ApiResponseInfo.html b/docs/com/textkernel/tx/models/api/ApiResponseInfo.html deleted file mode 100644 index 4195a2590..000000000 --- a/docs/com/textkernel/tx/models/api/ApiResponseInfo.html +++ /dev/null @@ -1,380 +0,0 @@ - - - - - - -ApiResponseInfo (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api
-

Class ApiResponseInfo

-
-
- -
-
    -
  • -
    -
    -
    public class ApiResponseInfo
-extends ApiResponseInfoLite
    -
    Information/metadata for an individual REST API call. - See https://developer.textkernel.com/tx-platform/v10/overview/#http-status-codes
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        TransactionId

        -
        public String TransactionId
        -
        The id for a specific API transaction. Use this when contacting service@textkernel.com about issues.
        -
        • -
      - - - -
        -
      • -

        TotalElapsedMilliseconds

        -
        public int TotalElapsedMilliseconds
        -
        How long the transaction took on the server, in milliseconds. -

        If the transaction takes longer to complete on the client side, that extra duration is solely network latency.

        -
        • -
      - - - -
        -
      • -

        EngineVersion

        -
        public String EngineVersion
        -
        The version of the parsing engine
        -
        • -
      - - - -
        -
      • -

        ApiVersion

        -
        public String ApiVersion
        -
        The version of the API
        -
        • -
      - - - -
        -
      • -

        CreditsUsed

        -
        public double CreditsUsed
        -
        How many credits the customer was charged for this transaction
        -
        • -
      - - - -
        -
      • -

        CustomerDetails

        -
        public AccountInfo CustomerDetails
        -
        Information about the customer who made the API call
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ApiResponseInfo

        -
        public ApiResponseInfo()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/ApiResponseInfoLite.html b/docs/com/textkernel/tx/models/api/ApiResponseInfoLite.html deleted file mode 100644 index f54791dc9..000000000 --- a/docs/com/textkernel/tx/models/api/ApiResponseInfoLite.html +++ /dev/null @@ -1,334 +0,0 @@ - - - - - - -ApiResponseInfoLite (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api
-

Class ApiResponseInfoLite

-
-
- -
-
    -
  • -
    -
    Direct Known Subclasses:
    -
    ApiResponseInfo, IndexMultipleDocumentsResponseValue
    -
    -
    -
    -
    public class ApiResponseInfoLite
-extends Object
    -
    Information/metadata for an individual REST API call. - See https://developer.textkernel.com/tx-platform/v10/overview/#http-status-codes
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Code

        -
        public String Code
        -
        See https://developer.textkernel.com/tx-platform/v10/overview/#http-status-codes
        -
        • -
      - - - -
        -
      • -

        Message

        -
        public String Message
        -
        A short human-readable description explaining the Code value
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ApiResponseInfoLite

        -
        public ApiResponseInfoLite()
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        isSuccess

        -
        public boolean isSuccess()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/ITxResponse.html b/docs/com/textkernel/tx/models/api/ITxResponse.html deleted file mode 100644 index fe4d8b53f..000000000 --- a/docs/com/textkernel/tx/models/api/ITxResponse.html +++ /dev/null @@ -1,232 +0,0 @@ - - - - - - -ITxResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api
-

Interface ITxResponse

-
-
-
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getInfo

        -
        ApiResponseInfo getInfo()
        -
        -
        Returns:
        -
        Information about the response and the customer
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/account/GetAccountInfoResponse.html b/docs/com/textkernel/tx/models/api/account/GetAccountInfoResponse.html deleted file mode 100644 index f6c0aa481..000000000 --- a/docs/com/textkernel/tx/models/api/account/GetAccountInfoResponse.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - -GetAccountInfoResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api.account
-

Class GetAccountInfoResponse

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    ITxResponse
    -
    -
    -
    -
    public class GetAccountInfoResponse
-extends ApiResponse<Object>
    -
    The response body from a GetAccount API call
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        GetAccountInfoResponse

        -
        public GetAccountInfoResponse()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/account/class-use/GetAccountInfoResponse.html b/docs/com/textkernel/tx/models/api/account/class-use/GetAccountInfoResponse.html deleted file mode 100644 index be53c7e5f..000000000 --- a/docs/com/textkernel/tx/models/api/account/class-use/GetAccountInfoResponse.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.account.GetAccountInfoResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.account.GetAccountInfoResponse

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/account/package-frame.html b/docs/com/textkernel/tx/models/api/account/package-frame.html deleted file mode 100644 index 0d27cc68e..000000000 --- a/docs/com/textkernel/tx/models/api/account/package-frame.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.account (Textkernel Tx Java SDK 2.3.3 API) - - - - - -

com.textkernel.tx.models.api.account

-
-

Classes

- -
- - diff --git a/docs/com/textkernel/tx/models/api/account/package-summary.html b/docs/com/textkernel/tx/models/api/account/package-summary.html deleted file mode 100644 index 2fd19a8ea..000000000 --- a/docs/com/textkernel/tx/models/api/account/package-summary.html +++ /dev/null @@ -1,146 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.account (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package com.textkernel.tx.models.api.account

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/account/package-tree.html b/docs/com/textkernel/tx/models/api/account/package-tree.html deleted file mode 100644 index 0fe10a294..000000000 --- a/docs/com/textkernel/tx/models/api/account/package-tree.html +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.account Class Hierarchy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package com.textkernel.tx.models.api.account

-Package Hierarchies: - -
-
-

Class Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/account/package-use.html b/docs/com/textkernel/tx/models/api/account/package-use.html deleted file mode 100644 index 8408a2773..000000000 --- a/docs/com/textkernel/tx/models/api/account/package-use.html +++ /dev/null @@ -1,161 +0,0 @@ - - - - - - -Uses of Package com.textkernel.tx.models.api.account (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Package
com.textkernel.tx.models.api.account

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/bimetricscoring/BimetricScoreJobRequest.html b/docs/com/textkernel/tx/models/api/bimetricscoring/BimetricScoreJobRequest.html deleted file mode 100644 index 4c1dbe2dc..000000000 --- a/docs/com/textkernel/tx/models/api/bimetricscoring/BimetricScoreJobRequest.html +++ /dev/null @@ -1,292 +0,0 @@ - - - - - - -BimetricScoreJobRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.bimetricscoring
-

Class BimetricScoreJobRequest

-
-
- -
-
    -
  • -
    -
    -
    public class BimetricScoreJobRequest
-extends BimetricScoreRequest
    -
    Request body for a 'BimetricScore' request
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        SourceJob

        -
        public ParsedJobWithId SourceJob
        -
        The job to use as the 'source' document for the bimetric score. -

        All the target documents will be scored against this job.

        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        BimetricScoreJobRequest

        -
        public BimetricScoreJobRequest()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/bimetricscoring/BimetricScoreRequest.html b/docs/com/textkernel/tx/models/api/bimetricscoring/BimetricScoreRequest.html deleted file mode 100644 index 028077d22..000000000 --- a/docs/com/textkernel/tx/models/api/bimetricscoring/BimetricScoreRequest.html +++ /dev/null @@ -1,337 +0,0 @@ - - - - - - -BimetricScoreRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.bimetricscoring
-

Class BimetricScoreRequest

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Settings

        -
        public SearchMatchSettings Settings
        -
        The settings to use during scoring calculations
        -
        • -
      - - - -
        -
      • -

        PreferredCategoryWeights

        -
        public CategoryWeights PreferredCategoryWeights
        -
        The weights you want to use for scoring. It is important to specify these, otherwise default values will be used. -

        These weights will be used except in the case - that you provided a non-zero weight for a category that is irrelevant in the source document. - For example, this can happen when the source document contains no languages. -

        See also: BaseScoredResponseValue.AppliedCategoryWeights

        -
        • -
      - - - -
        -
      • -

        TargetResumes

        -
        public List<ParsedResumeWithId> TargetResumes
        -
        A list of parsed resumes containing the document name/identifier and the parsed resume data. - NOTE: you can only use either this property to score resumes, or TargetJobs to score jobs, but not both
        -
        • -
      - - - -
        -
      • -

        TargetJobs

        -
        public List<ParsedJobWithId> TargetJobs
        -
        A list of parsed jobs containing the document name/identifier and the parsed job data. - NOTE: you can only use either this property to score jobs, or TargetResumes to score resumes, but not both
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        BimetricScoreRequest

        -
        public BimetricScoreRequest()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/bimetricscoring/BimetricScoreResponse.html b/docs/com/textkernel/tx/models/api/bimetricscoring/BimetricScoreResponse.html deleted file mode 100644 index e1ffc3862..000000000 --- a/docs/com/textkernel/tx/models/api/bimetricscoring/BimetricScoreResponse.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - -BimetricScoreResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api.bimetricscoring
-

Class BimetricScoreResponse

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        BimetricScoreResponse

        -
        public BimetricScoreResponse()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/bimetricscoring/BimetricScoreResponseValue.html b/docs/com/textkernel/tx/models/api/bimetricscoring/BimetricScoreResponseValue.html deleted file mode 100644 index 3b0765960..000000000 --- a/docs/com/textkernel/tx/models/api/bimetricscoring/BimetricScoreResponseValue.html +++ /dev/null @@ -1,272 +0,0 @@ - - - - - - -BimetricScoreResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api.bimetricscoring
-

Class BimetricScoreResponseValue

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        BimetricScoreResponseValue

        -
        public BimetricScoreResponseValue()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/bimetricscoring/BimetricScoreResult.html b/docs/com/textkernel/tx/models/api/bimetricscoring/BimetricScoreResult.html deleted file mode 100644 index a849bf3d7..000000000 --- a/docs/com/textkernel/tx/models/api/bimetricscoring/BimetricScoreResult.html +++ /dev/null @@ -1,372 +0,0 @@ - - - - - - -BimetricScoreResult (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.bimetricscoring
-

Class BimetricScoreResult

-
-
- -
-
    -
  • -
    -
    -
    public class BimetricScoreResult
-extends Object
    -
    And individual result (representing a single document) for a 'BimetricScore' request
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Id

        -
        public String Id
        -
        The document id of the result
        -
        • -
      - - - -
        -
      • -

        SovScore

        -
        public int SovScore
        -
        An integer score representing the overall fit of the match. - This is the result of a proprietary algorithm that combines the - WeightedScore and the ReverseCompatibilityScore - into one overall score. Results are sorted by this parameter in descending order.
        -
        • -
      - - - -
        -
      • -

        WeightedScore

        -
        public int WeightedScore
        -
        An integer score from 0-100 representing how well the current document matched the source document. - This calculation is the sum of the unweighted category scores multiplied by their respective applied weight. - A score of 100 means that all of the data points in the source document were found in the target document, - but the target document may have had many extra data points. -

        See also:

        -
        • -
      - - - -
        -
      • -

        ReverseCompatibilityScore

        -
        public int ReverseCompatibilityScore
        -
        An integer score from 0-100 which represents how well the target document matched to the source document. - This is equivalent to the WeightedScore if you ran the match/score with the source and - target documents swapped. A score of 100 means that all of the data points in the target document were found - in the source document, but the source document may have had many extra data points.
        -
        • -
      - - - - - - - - -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        BimetricScoreResult

        -
        public BimetricScoreResult()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/bimetricscoring/BimetricScoreResumeRequest.html b/docs/com/textkernel/tx/models/api/bimetricscoring/BimetricScoreResumeRequest.html deleted file mode 100644 index 8d87830d7..000000000 --- a/docs/com/textkernel/tx/models/api/bimetricscoring/BimetricScoreResumeRequest.html +++ /dev/null @@ -1,292 +0,0 @@ - - - - - - -BimetricScoreResumeRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.bimetricscoring
-

Class BimetricScoreResumeRequest

-
-
- -
-
    -
  • -
    -
    -
    public class BimetricScoreResumeRequest
-extends BimetricScoreRequest
    -
    Request body for a 'BimetricScore' request
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        SourceResume

        -
        public ParsedResumeWithId SourceResume
        -
        The resume to use as the 'source' document for the bimetric score. -

        All the target documents will be scored against this resume.

        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        BimetricScoreResumeRequest

        -
        public BimetricScoreResumeRequest()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/bimetricscoring/IParsedDocWithId.html b/docs/com/textkernel/tx/models/api/bimetricscoring/IParsedDocWithId.html deleted file mode 100644 index 91a4e6629..000000000 --- a/docs/com/textkernel/tx/models/api/bimetricscoring/IParsedDocWithId.html +++ /dev/null @@ -1,232 +0,0 @@ - - - - - - -IParsedDocWithId (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api.bimetricscoring
-

Interface IParsedDocWithId

-
-
-
-
    -
  • -
    -
    All Known Implementing Classes:
    -
    ParsedJobWithId, ParsedResumeWithId
    -
    -
    -
    -
    public interface IParsedDocWithId
    -
    Interface to simplify Bimetric Score requests
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getDocId

        -
        String getDocId()
        -
        -
        Returns:
        -
        The id of the document (used in the response body)
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/bimetricscoring/ParsedJobWithId.html b/docs/com/textkernel/tx/models/api/bimetricscoring/ParsedJobWithId.html deleted file mode 100644 index 9a7670057..000000000 --- a/docs/com/textkernel/tx/models/api/bimetricscoring/ParsedJobWithId.html +++ /dev/null @@ -1,340 +0,0 @@ - - - - - - -ParsedJobWithId (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.bimetricscoring
-

Class ParsedJobWithId

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    IParsedDocWithId
    -
    -
    -
    -
    public class ParsedJobWithId
-extends Object
-implements IParsedDocWithId
    -
    A ParsedJob and id pair for a bimetric score request
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Id

        -
        public String Id
        -
        The id of the document (used in the response body)
        -
        • -
      - - - -
        -
      • -

        JobData

        -
        public ParsedJob JobData
        -
        A job generated by the job parser
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ParsedJobWithId

        -
        public ParsedJobWithId()
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getDocId

        -
        public String getDocId()
        -
        -
        Specified by:
        -
        getDocId in interface IParsedDocWithId
        -
        Returns:
        -
        The id of the document (used in the response body)
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/bimetricscoring/ParsedResumeWithId.html b/docs/com/textkernel/tx/models/api/bimetricscoring/ParsedResumeWithId.html deleted file mode 100644 index 9200362f1..000000000 --- a/docs/com/textkernel/tx/models/api/bimetricscoring/ParsedResumeWithId.html +++ /dev/null @@ -1,340 +0,0 @@ - - - - - - -ParsedResumeWithId (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.bimetricscoring
-

Class ParsedResumeWithId

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    IParsedDocWithId
    -
    -
    -
    -
    public class ParsedResumeWithId
-extends Object
-implements IParsedDocWithId
    -
    A ParsedResume and id pair for a bimetric score request
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Id

        -
        public String Id
        -
        The id of the document (used in the response body)
        -
        • -
      - - - -
        -
      • -

        ResumeData

        -
        public ParsedResume ResumeData
        -
        A resume generated by the resume parser
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ParsedResumeWithId

        -
        public ParsedResumeWithId()
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getDocId

        -
        public String getDocId()
        -
        -
        Specified by:
        -
        getDocId in interface IParsedDocWithId
        -
        Returns:
        -
        The id of the document (used in the response body)
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/bimetricscoring/class-use/BimetricScoreJobRequest.html b/docs/com/textkernel/tx/models/api/bimetricscoring/class-use/BimetricScoreJobRequest.html deleted file mode 100644 index 5f68936ae..000000000 --- a/docs/com/textkernel/tx/models/api/bimetricscoring/class-use/BimetricScoreJobRequest.html +++ /dev/null @@ -1,165 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.bimetricscoring.BimetricScoreJobRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.bimetricscoring.BimetricScoreJobRequest

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/bimetricscoring/class-use/BimetricScoreRequest.html b/docs/com/textkernel/tx/models/api/bimetricscoring/class-use/BimetricScoreRequest.html deleted file mode 100644 index f4d1c7a8f..000000000 --- a/docs/com/textkernel/tx/models/api/bimetricscoring/class-use/BimetricScoreRequest.html +++ /dev/null @@ -1,174 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.bimetricscoring.BimetricScoreRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.bimetricscoring.BimetricScoreRequest

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/bimetricscoring/class-use/BimetricScoreResponse.html b/docs/com/textkernel/tx/models/api/bimetricscoring/class-use/BimetricScoreResponse.html deleted file mode 100644 index 5979be63b..000000000 --- a/docs/com/textkernel/tx/models/api/bimetricscoring/class-use/BimetricScoreResponse.html +++ /dev/null @@ -1,180 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.bimetricscoring.BimetricScoreResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.bimetricscoring.BimetricScoreResponse

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/bimetricscoring/class-use/BimetricScoreResponseValue.html b/docs/com/textkernel/tx/models/api/bimetricscoring/class-use/BimetricScoreResponseValue.html deleted file mode 100644 index 2ced498c8..000000000 --- a/docs/com/textkernel/tx/models/api/bimetricscoring/class-use/BimetricScoreResponseValue.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.bimetricscoring.BimetricScoreResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.bimetricscoring.BimetricScoreResponseValue

-
-
No usage of com.textkernel.tx.models.api.bimetricscoring.BimetricScoreResponseValue
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/bimetricscoring/class-use/BimetricScoreResult.html b/docs/com/textkernel/tx/models/api/bimetricscoring/class-use/BimetricScoreResult.html deleted file mode 100644 index 77b1f3e64..000000000 --- a/docs/com/textkernel/tx/models/api/bimetricscoring/class-use/BimetricScoreResult.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.bimetricscoring.BimetricScoreResult (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.bimetricscoring.BimetricScoreResult

-
-
No usage of com.textkernel.tx.models.api.bimetricscoring.BimetricScoreResult
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/bimetricscoring/class-use/BimetricScoreResumeRequest.html b/docs/com/textkernel/tx/models/api/bimetricscoring/class-use/BimetricScoreResumeRequest.html deleted file mode 100644 index 51b79230e..000000000 --- a/docs/com/textkernel/tx/models/api/bimetricscoring/class-use/BimetricScoreResumeRequest.html +++ /dev/null @@ -1,165 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.bimetricscoring.BimetricScoreResumeRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.bimetricscoring.BimetricScoreResumeRequest

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/bimetricscoring/class-use/IParsedDocWithId.html b/docs/com/textkernel/tx/models/api/bimetricscoring/class-use/IParsedDocWithId.html deleted file mode 100644 index 060d00a32..000000000 --- a/docs/com/textkernel/tx/models/api/bimetricscoring/class-use/IParsedDocWithId.html +++ /dev/null @@ -1,228 +0,0 @@ - - - - - - -Uses of Interface com.textkernel.tx.models.api.bimetricscoring.IParsedDocWithId (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Interface
com.textkernel.tx.models.api.bimetricscoring.IParsedDocWithId

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/bimetricscoring/class-use/ParsedJobWithId.html b/docs/com/textkernel/tx/models/api/bimetricscoring/class-use/ParsedJobWithId.html deleted file mode 100644 index be253c945..000000000 --- a/docs/com/textkernel/tx/models/api/bimetricscoring/class-use/ParsedJobWithId.html +++ /dev/null @@ -1,219 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.bimetricscoring.ParsedJobWithId (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.bimetricscoring.ParsedJobWithId

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/bimetricscoring/class-use/ParsedResumeWithId.html b/docs/com/textkernel/tx/models/api/bimetricscoring/class-use/ParsedResumeWithId.html deleted file mode 100644 index 5fc6eee66..000000000 --- a/docs/com/textkernel/tx/models/api/bimetricscoring/class-use/ParsedResumeWithId.html +++ /dev/null @@ -1,219 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.bimetricscoring.ParsedResumeWithId (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.bimetricscoring.ParsedResumeWithId

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/bimetricscoring/package-frame.html b/docs/com/textkernel/tx/models/api/bimetricscoring/package-frame.html deleted file mode 100644 index 591a8aaa2..000000000 --- a/docs/com/textkernel/tx/models/api/bimetricscoring/package-frame.html +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.bimetricscoring (Textkernel Tx Java SDK 2.3.3 API) - - - - - -

com.textkernel.tx.models.api.bimetricscoring

-
-

Interfaces

- -

Classes

- -
- - diff --git a/docs/com/textkernel/tx/models/api/bimetricscoring/package-summary.html b/docs/com/textkernel/tx/models/api/bimetricscoring/package-summary.html deleted file mode 100644 index 3bc4a1347..000000000 --- a/docs/com/textkernel/tx/models/api/bimetricscoring/package-summary.html +++ /dev/null @@ -1,205 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.bimetricscoring (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package com.textkernel.tx.models.api.bimetricscoring

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/bimetricscoring/package-tree.html b/docs/com/textkernel/tx/models/api/bimetricscoring/package-tree.html deleted file mode 100644 index 7e926994b..000000000 --- a/docs/com/textkernel/tx/models/api/bimetricscoring/package-tree.html +++ /dev/null @@ -1,165 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.bimetricscoring Class Hierarchy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package com.textkernel.tx.models.api.bimetricscoring

-Package Hierarchies: - -
-
-

Class Hierarchy

- -

Interface Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/bimetricscoring/package-use.html b/docs/com/textkernel/tx/models/api/bimetricscoring/package-use.html deleted file mode 100644 index 17506ab9f..000000000 --- a/docs/com/textkernel/tx/models/api/bimetricscoring/package-use.html +++ /dev/null @@ -1,238 +0,0 @@ - - - - - - -Uses of Package com.textkernel.tx.models.api.bimetricscoring (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Package
com.textkernel.tx.models.api.bimetricscoring

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/class-use/AccountInfo.html b/docs/com/textkernel/tx/models/api/class-use/AccountInfo.html deleted file mode 100644 index f2925aaf9..000000000 --- a/docs/com/textkernel/tx/models/api/class-use/AccountInfo.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.AccountInfo (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.AccountInfo

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/class-use/ApiResponse.html b/docs/com/textkernel/tx/models/api/class-use/ApiResponse.html deleted file mode 100644 index 903ed50bb..000000000 --- a/docs/com/textkernel/tx/models/api/class-use/ApiResponse.html +++ /dev/null @@ -1,616 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.ApiResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.ApiResponse

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/class-use/ApiResponseInfo.html b/docs/com/textkernel/tx/models/api/class-use/ApiResponseInfo.html deleted file mode 100644 index 59574af0d..000000000 --- a/docs/com/textkernel/tx/models/api/class-use/ApiResponseInfo.html +++ /dev/null @@ -1,207 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.ApiResponseInfo (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.ApiResponseInfo

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/class-use/ApiResponseInfoLite.html b/docs/com/textkernel/tx/models/api/class-use/ApiResponseInfoLite.html deleted file mode 100644 index deba1bfd9..000000000 --- a/docs/com/textkernel/tx/models/api/class-use/ApiResponseInfoLite.html +++ /dev/null @@ -1,344 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.ApiResponseInfoLite (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.ApiResponseInfoLite

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/class-use/ITxResponse.html b/docs/com/textkernel/tx/models/api/class-use/ITxResponse.html deleted file mode 100644 index d8c602d64..000000000 --- a/docs/com/textkernel/tx/models/api/class-use/ITxResponse.html +++ /dev/null @@ -1,616 +0,0 @@ - - - - - - -Uses of Interface com.textkernel.tx.models.api.ITxResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Interface
com.textkernel.tx.models.api.ITxResponse

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/AutocompleteRequest.html b/docs/com/textkernel/tx/models/api/dataenrichment/AutocompleteRequest.html deleted file mode 100644 index a9e90a5c2..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/AutocompleteRequest.html +++ /dev/null @@ -1,331 +0,0 @@ - - - - - - -AutocompleteRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.dataenrichment
-

Class AutocompleteRequest

-
-
- -
-
    -
  • -
    -
    Direct Known Subclasses:
    -
    SkillsAutoCompleteRequest
    -
    -
    -
    -
    public class AutocompleteRequest
-extends Object
    -
    Request body for a 'ProfessionsAutocomplete' request
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Prefix

        -
        public String Prefix
        -
        The job title prefix to be completed. Must contain at least 1 character.
        -
        • -
      - - - -
        -
      • -

        Limit

        -
        public int Limit
        -
        The maximum number of returned professions. The default is 10 and the maximum is 100.
        -
        • -
      - - - -
        -
      • -

        Languages

        -
        public List<String> Languages
        -
        The language(s) used to search for matching professions (the language of the provided Prefix). A maximum of 5 languages can be provided. Must be one of the supported ISO codes.
        -
        • -
      - - - -
        -
      • -

        OutputLanguage

        -
        public String OutputLanguage
        -
        The language to ouput the found professions in (default is 'en'). Must be one of the supported ISO codes.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        AutocompleteRequest

        -
        public AutocompleteRequest()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/GetMetadataResponse.html b/docs/com/textkernel/tx/models/api/dataenrichment/GetMetadataResponse.html deleted file mode 100644 index d4201799e..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/GetMetadataResponse.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - -GetMetadataResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api.dataenrichment
-

Class GetMetadataResponse

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        GetMetadataResponse

        -
        public GetMetadataResponse()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/TaxonomyFormat.html b/docs/com/textkernel/tx/models/api/dataenrichment/TaxonomyFormat.html deleted file mode 100644 index 2b4836967..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/TaxonomyFormat.html +++ /dev/null @@ -1,350 +0,0 @@ - - - - - - -TaxonomyFormat (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.dataenrichment
-

Enum TaxonomyFormat

-
-
- -
- -
-
- -
-
-
    -
  • - - - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        values

        -
        public static TaxonomyFormat[] values()
        -
        Returns an array containing the constants of this enum type, in -the order they are declared. This method may be used to iterate -over the constants as follows: -
        -for (TaxonomyFormat c : TaxonomyFormat.values())
-    System.out.println(c);
-
        -
        -
        Returns:
        -
        an array containing the constants of this enum type, in the order they are declared
        -
        -
        • -
      - - - -
        -
      • -

        valueOf

        -
        public static TaxonomyFormat valueOf(String name)
        -
        Returns the enum constant of this type with the specified name. -The string must match exactly an identifier used to declare an -enum constant in this type. (Extraneous whitespace characters are -not permitted.)
        -
        -
        Parameters:
        -
        name - the name of the enum constant to be returned.
        -
        Returns:
        -
        the enum constant with the specified name
        -
        Throws:
        -
        IllegalArgumentException - if this enum type has no constant with the specified name
        -
        NullPointerException - if the argument is null
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/class-use/AutocompleteRequest.html b/docs/com/textkernel/tx/models/api/dataenrichment/class-use/AutocompleteRequest.html deleted file mode 100644 index d60c0c84b..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/class-use/AutocompleteRequest.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.dataenrichment.AutocompleteRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.dataenrichment.AutocompleteRequest

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/class-use/GetMetadataResponse.html b/docs/com/textkernel/tx/models/api/dataenrichment/class-use/GetMetadataResponse.html deleted file mode 100644 index fbfc39df4..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/class-use/GetMetadataResponse.html +++ /dev/null @@ -1,180 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.dataenrichment.GetMetadataResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.dataenrichment.GetMetadataResponse

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/class-use/TaxonomyFormat.html b/docs/com/textkernel/tx/models/api/dataenrichment/class-use/TaxonomyFormat.html deleted file mode 100644 index cebdcaa51..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/class-use/TaxonomyFormat.html +++ /dev/null @@ -1,212 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.dataenrichment.TaxonomyFormat (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.dataenrichment.TaxonomyFormat

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/request/CompareProfessionsRequest.html b/docs/com/textkernel/tx/models/api/dataenrichment/ontology/request/CompareProfessionsRequest.html deleted file mode 100644 index 520f08e1b..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/request/CompareProfessionsRequest.html +++ /dev/null @@ -1,311 +0,0 @@ - - - - - - -CompareProfessionsRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.dataenrichment.ontology.request
-

Class CompareProfessionsRequest

-
-
- -
-
    -
  • -
    -
    -
    public class CompareProfessionsRequest
-extends Object
    -
    Request body for a 'CompareProfessions' request
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        ProfessionACodeId

        -
        public int ProfessionACodeId
        -
        A profession code ID from the Professions Taxonomy to compare.
        -
        • -
      - - - -
        -
      • -

        ProfessionBCodeId

        -
        public int ProfessionBCodeId
        -
        A profession code ID from the Professions Taxonomy to compare.
        -
        • -
      - - - -
        -
      • -

        OutputLanguage

        -
        public String OutputLanguage
        -
        The language to use for the returned descriptions.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        CompareProfessionsRequest

        -
        public CompareProfessionsRequest()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/request/CompareSkillsToProfessionRequest.html b/docs/com/textkernel/tx/models/api/dataenrichment/ontology/request/CompareSkillsToProfessionRequest.html deleted file mode 100644 index cd4c8672f..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/request/CompareSkillsToProfessionRequest.html +++ /dev/null @@ -1,311 +0,0 @@ - - - - - - -CompareSkillsToProfessionRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.dataenrichment.ontology.request
-

Class CompareSkillsToProfessionRequest

-
-
- -
-
    -
  • -
    -
    -
    public class CompareSkillsToProfessionRequest
-extends Object
    -
    Request body for a 'CompareSkillsToProfession' request
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Skills

        -
        public List<SkillScore> Skills
        -
        The skills which should be compared against the given profession. The list can contain up to 50 skills.
        -
        • -
      - - - -
        -
      • -

        ProfessionCodeId

        -
        public int ProfessionCodeId
        -
        The profession code ID from the Professions Taxonomy to compare the skill set to.
        -
        • -
      - - - -
        -
      • -

        OutputLanguage

        -
        public String OutputLanguage
        -
        The language to use for the returned descriptions.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        CompareSkillsToProfessionRequest

        -
        public CompareSkillsToProfessionRequest()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/request/SkillsSimilarityScoreRequest.html b/docs/com/textkernel/tx/models/api/dataenrichment/ontology/request/SkillsSimilarityScoreRequest.html deleted file mode 100644 index 8cc977c4e..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/request/SkillsSimilarityScoreRequest.html +++ /dev/null @@ -1,295 +0,0 @@ - - - - - - -SkillsSimilarityScoreRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.dataenrichment.ontology.request
-

Class SkillsSimilarityScoreRequest

-
-
- -
-
    -
  • -
    -
    -
    public class SkillsSimilarityScoreRequest
-extends Object
    -
    Request body for a 'SuggestProfessions' request
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        SkillsA

        -
        public List<SkillScore> SkillsA
        -
        A set of skills (and optionally, scores) to score against the other set of skills. The list can contain up to 50 skills.
        -
        • -
      - - - -
        -
      • -

        SkillsB

        -
        public List<SkillScore> SkillsB
        -
        A set of skills (and optionally, scores) to score against the other set of skills. The list can contain up to 50 skills.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        SkillsSimilarityScoreRequest

        -
        public SkillsSimilarityScoreRequest()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/request/SuggestProfessionsRequest.html b/docs/com/textkernel/tx/models/api/dataenrichment/ontology/request/SuggestProfessionsRequest.html deleted file mode 100644 index c5535ad47..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/request/SuggestProfessionsRequest.html +++ /dev/null @@ -1,327 +0,0 @@ - - - - - - -SuggestProfessionsRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.dataenrichment.ontology.request
-

Class SuggestProfessionsRequest

-
-
- -
-
    -
  • -
    -
    -
    public class SuggestProfessionsRequest
-extends Object
    -
    Request body for a 'SuggestProfessions' request
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Skills

        -
        public List<SkillScore> Skills
        -
        The skills used to return the most relevant professions. The list can contain up to 50 skills.
        -
        • -
      - - - -
        -
      • -

        ReturnMissingSkills

        -
        public boolean ReturnMissingSkills
        -
        Flag to enable returning a list of missing skills per suggested profession.
        -
        • -
      - - - -
        -
      • -

        Limit

        -
        public int Limit
        -
        The maximum amount of professions returned. If not specified this parameter defaults to 10.
        -
        • -
      - - - -
        -
      • -

        OutputLanguage

        -
        public String OutputLanguage
        -
        The language to use for the returned descriptions.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        SuggestProfessionsRequest

        -
        public SuggestProfessionsRequest()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/request/SuggestSkillsFromProfessionsRequest.html b/docs/com/textkernel/tx/models/api/dataenrichment/ontology/request/SuggestSkillsFromProfessionsRequest.html deleted file mode 100644 index 335b6a22a..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/request/SuggestSkillsFromProfessionsRequest.html +++ /dev/null @@ -1,327 +0,0 @@ - - - - - - -SuggestSkillsFromProfessionsRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.dataenrichment.ontology.request
-

Class SuggestSkillsFromProfessionsRequest

-
-
- -
-
    -
  • -
    -
    -
    public class SuggestSkillsFromProfessionsRequest
-extends Object
    -
    Request body for a 'SuggestSkills' request
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        ProfessionCodeIds

        -
        public List<Integer> ProfessionCodeIds
        -
        The profession code IDs from the Professions Taxonomy for which the service should return related skills. The list can contain up to 10 profession codes.
        -
        • -
      - - - -
        -
      • -

        Limit

        -
        public int Limit
        -
        The maximum amount of suggested skills returned. If not specified this parameter defaults to 10.
        -
        • -
      - - - -
        -
      • -

        OutputLanguage

        -
        public String OutputLanguage
        -
        The language to use for the returned descriptions.
        -
        • -
      - - - -
        -
      • -

        Types

        -
        public List<String> Types
        -
        If specified, only these types of skills will be returned. The following values are acceptable: Professional, IT, Language, Soft, Certification, All. Only applicable in v2 endpoints.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        SuggestSkillsFromProfessionsRequest

        -
        public SuggestSkillsFromProfessionsRequest()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/request/SuggestSkillsFromSkillsRequest.html b/docs/com/textkernel/tx/models/api/dataenrichment/ontology/request/SuggestSkillsFromSkillsRequest.html deleted file mode 100644 index e38f899d0..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/request/SuggestSkillsFromSkillsRequest.html +++ /dev/null @@ -1,327 +0,0 @@ - - - - - - -SuggestSkillsFromSkillsRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.dataenrichment.ontology.request
-

Class SuggestSkillsFromSkillsRequest

-
-
- -
-
    -
  • -
    -
    -
    public class SuggestSkillsFromSkillsRequest
-extends Object
    -
    Request body for a 'SuggestProfessions' request
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Skills

        -
        public List<SkillScore> Skills
        -
        The skills for which the service should return related skills. The list can contain up to 50 skills.
        -
        • -
      - - - -
        -
      • -

        Limit

        -
        public int Limit
        -
        The maximum amount of suggested skills returned. If not specified this parameter defaults to 25.
        -
        • -
      - - - -
        -
      • -

        OutputLanguage

        -
        public String OutputLanguage
        -
        The language to use for the returned descriptions.
        -
        • -
      - - - -
        -
      • -

        Types

        -
        public List<String> Types
        -
        If specified, only these types of skills will be returned. The following values are acceptable: Professional, IT, Language, Soft, Certification, All. Only applicable in v2 endpoints.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        SuggestSkillsFromSkillsRequest

        -
        public SuggestSkillsFromSkillsRequest()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/request/class-use/CompareProfessionsRequest.html b/docs/com/textkernel/tx/models/api/dataenrichment/ontology/request/class-use/CompareProfessionsRequest.html deleted file mode 100644 index 0fa96d116..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/request/class-use/CompareProfessionsRequest.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.dataenrichment.ontology.request.CompareProfessionsRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.dataenrichment.ontology.request.CompareProfessionsRequest

-
-
No usage of com.textkernel.tx.models.api.dataenrichment.ontology.request.CompareProfessionsRequest
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/request/class-use/CompareSkillsToProfessionRequest.html b/docs/com/textkernel/tx/models/api/dataenrichment/ontology/request/class-use/CompareSkillsToProfessionRequest.html deleted file mode 100644 index 04491544e..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/request/class-use/CompareSkillsToProfessionRequest.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.dataenrichment.ontology.request.CompareSkillsToProfessionRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.dataenrichment.ontology.request.CompareSkillsToProfessionRequest

-
-
No usage of com.textkernel.tx.models.api.dataenrichment.ontology.request.CompareSkillsToProfessionRequest
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/request/class-use/SkillsSimilarityScoreRequest.html b/docs/com/textkernel/tx/models/api/dataenrichment/ontology/request/class-use/SkillsSimilarityScoreRequest.html deleted file mode 100644 index fc4edb324..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/request/class-use/SkillsSimilarityScoreRequest.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.dataenrichment.ontology.request.SkillsSimilarityScoreRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.dataenrichment.ontology.request.SkillsSimilarityScoreRequest

-
-
No usage of com.textkernel.tx.models.api.dataenrichment.ontology.request.SkillsSimilarityScoreRequest
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/request/class-use/SuggestProfessionsRequest.html b/docs/com/textkernel/tx/models/api/dataenrichment/ontology/request/class-use/SuggestProfessionsRequest.html deleted file mode 100644 index f20c04133..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/request/class-use/SuggestProfessionsRequest.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.dataenrichment.ontology.request.SuggestProfessionsRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.dataenrichment.ontology.request.SuggestProfessionsRequest

-
-
No usage of com.textkernel.tx.models.api.dataenrichment.ontology.request.SuggestProfessionsRequest
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/request/class-use/SuggestSkillsFromProfessionsRequest.html b/docs/com/textkernel/tx/models/api/dataenrichment/ontology/request/class-use/SuggestSkillsFromProfessionsRequest.html deleted file mode 100644 index d36cd48b3..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/request/class-use/SuggestSkillsFromProfessionsRequest.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.dataenrichment.ontology.request.SuggestSkillsFromProfessionsRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.dataenrichment.ontology.request.SuggestSkillsFromProfessionsRequest

-
-
No usage of com.textkernel.tx.models.api.dataenrichment.ontology.request.SuggestSkillsFromProfessionsRequest
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/request/class-use/SuggestSkillsFromSkillsRequest.html b/docs/com/textkernel/tx/models/api/dataenrichment/ontology/request/class-use/SuggestSkillsFromSkillsRequest.html deleted file mode 100644 index 3772b4e27..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/request/class-use/SuggestSkillsFromSkillsRequest.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.dataenrichment.ontology.request.SuggestSkillsFromSkillsRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.dataenrichment.ontology.request.SuggestSkillsFromSkillsRequest

-
-
No usage of com.textkernel.tx.models.api.dataenrichment.ontology.request.SuggestSkillsFromSkillsRequest
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/request/package-frame.html b/docs/com/textkernel/tx/models/api/dataenrichment/ontology/request/package-frame.html deleted file mode 100644 index 7b5a1baf6..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/request/package-frame.html +++ /dev/null @@ -1,26 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.dataenrichment.ontology.request (Textkernel Tx Java SDK 2.3.3 API) - - - - - -

com.textkernel.tx.models.api.dataenrichment.ontology.request

-
-

Classes

- -
- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/request/package-summary.html b/docs/com/textkernel/tx/models/api/dataenrichment/ontology/request/package-summary.html deleted file mode 100644 index c8257d6cc..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/request/package-summary.html +++ /dev/null @@ -1,176 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.dataenrichment.ontology.request (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package com.textkernel.tx.models.api.dataenrichment.ontology.request

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/request/package-tree.html b/docs/com/textkernel/tx/models/api/dataenrichment/ontology/request/package-tree.html deleted file mode 100644 index e738c427b..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/request/package-tree.html +++ /dev/null @@ -1,144 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.dataenrichment.ontology.request Class Hierarchy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package com.textkernel.tx.models.api.dataenrichment.ontology.request

-Package Hierarchies: - -
-
-

Class Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/request/package-use.html b/docs/com/textkernel/tx/models/api/dataenrichment/ontology/request/package-use.html deleted file mode 100644 index e6aeda86d..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/request/package-use.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Package com.textkernel.tx.models.api.dataenrichment.ontology.request (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Package
com.textkernel.tx.models.api.dataenrichment.ontology.request

-
-
No usage of com.textkernel.tx.models.api.dataenrichment.ontology.request
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/CompareProfessionsResponse.html b/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/CompareProfessionsResponse.html deleted file mode 100644 index e6f18e988..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/CompareProfessionsResponse.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - -CompareProfessionsResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api.dataenrichment.ontology.response
-

Class CompareProfessionsResponse

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        CompareProfessionsResponse

        -
        public CompareProfessionsResponse()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/CompareProfessionsResponseValue.html b/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/CompareProfessionsResponseValue.html deleted file mode 100644 index b10567352..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/CompareProfessionsResponseValue.html +++ /dev/null @@ -1,311 +0,0 @@ - - - - - - -CompareProfessionsResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.dataenrichment.ontology.response
-

Class CompareProfessionsResponseValue

-
-
- -
-
    -
  • -
    -
    -
    public class CompareProfessionsResponseValue
-extends Object
    -
    One entry in the ApiResponse.Value from a 'CompareProfessions' response
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        SimilarityScore

        -
        public float SimilarityScore
        -
        A value from [0 - 1] indicating the similarity between the two professions.
        -
        • -
      - - - -
        -
      • -

        CommonSkills

        -
        public List<SkillScore> CommonSkills
        -
        A list of common skills for both professions.
        -
        • -
      - - - -
        -
      • -

        ExclusiveSkillsByProfession

        -
        public List<ProfessionExclusiveSkills> ExclusiveSkillsByProfession
        -
        A list of exclusive skills per profession. This list will have at most 2 entries (one for each profession you provided).
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        CompareProfessionsResponseValue

        -
        public CompareProfessionsResponseValue()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/CompareSkillsToProfessionResponse.html b/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/CompareSkillsToProfessionResponse.html deleted file mode 100644 index 8e1b50a4f..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/CompareSkillsToProfessionResponse.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - -CompareSkillsToProfessionResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api.dataenrichment.ontology.response
-

Class CompareSkillsToProfessionResponse

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        CompareSkillsToProfessionResponse

        -
        public CompareSkillsToProfessionResponse()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/CompareSkillsToProfessionResponseValue.html b/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/CompareSkillsToProfessionResponseValue.html deleted file mode 100644 index f7ae45bba..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/CompareSkillsToProfessionResponseValue.html +++ /dev/null @@ -1,327 +0,0 @@ - - - - - - -CompareSkillsToProfessionResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.dataenrichment.ontology.response
-

Class CompareSkillsToProfessionResponseValue

-
-
- -
-
    -
  • -
    -
    -
    public class CompareSkillsToProfessionResponseValue
-extends Object
    -
    One entry in the ApiResponse.Value from a 'CompareSkillsToProfession' response
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        SimilarityScore

        -
        public float SimilarityScore
        -
        A value from[0 - 1] indicating the similarity of the skill set and profession.
        -
        • -
      - - - -
        -
      • -

        CommonSkills

        -
        public List<SkillScore> CommonSkills
        -
        A list of common skills between skill set and profession.
        -
        • -
      - - - -
        -
      • -

        InputSkillsNotInProfession

        -
        public List<String> InputSkillsNotInProfession
        -
        The list of given skill IDs that are not associated to the given profession.
        -
        • -
      - - - -
        -
      • -

        MissingSkillsFoundInProfession

        -
        public List<SkillScore> MissingSkillsFoundInProfession
        -
        A list of skills associated with the profession but missing from list of provided skills.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        CompareSkillsToProfessionResponseValue

        -
        public CompareSkillsToProfessionResponseValue()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/ProfessionExclusiveSkills.html b/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/ProfessionExclusiveSkills.html deleted file mode 100644 index addb73ad2..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/ProfessionExclusiveSkills.html +++ /dev/null @@ -1,295 +0,0 @@ - - - - - - -ProfessionExclusiveSkills (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.dataenrichment.ontology.response
-

Class ProfessionExclusiveSkills

-
-
- -
-
    -
  • -
    -
    -
    public class ProfessionExclusiveSkills
-extends Object
    -
    An exclusive skill per profession.
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        ProfessionCodeId

        -
        public int ProfessionCodeId
        -
        The code ID of the profession in the Professions Taxonomy.
        -
        • -
      - - - -
        -
      • -

        SkillsFoundOnlyInThisProfession

        -
        public List<SkillScore> SkillsFoundOnlyInThisProfession
        -
        A list of skills that are relative to this profession, but not the other.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ProfessionExclusiveSkills

        -
        public ProfessionExclusiveSkills()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/SkillScore.html b/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/SkillScore.html deleted file mode 100644 index a98e59a38..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/SkillScore.html +++ /dev/null @@ -1,323 +0,0 @@ - - - - - - -SkillScore (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.dataenrichment.ontology.response
-

Class SkillScore

-
-
- -
-
    -
  • -
    -
    -
    public class SkillScore
-extends Object
    -
    A skill related to the given profession.
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Score

        -
        public float Score
        -
        A value from [0 - 1] indicating how relative this skill is to all of the given professions.
        -
        • -
      - - - -
        -
      • -

        Id

        -
        public String Id
        -
        The ID of the skill in the skills taxonomy.
        -
        • -
      - - - -
        -
      • -

        Description

        -
        public String Description
        -
        The description of the skill in the Skills Taxonomy. Will only be returned if OutputLanguage is specified in the request. This has no effect in a request body.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        SkillScore

        -
        public SkillScore()
        -
        • -
      - - - -
        -
      • -

        SkillScore

        -
        public SkillScore(String id)
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/SkillsSimilarityScoreResponse.html b/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/SkillsSimilarityScoreResponse.html deleted file mode 100644 index c19511a1f..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/SkillsSimilarityScoreResponse.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - -SkillsSimilarityScoreResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api.dataenrichment.ontology.response
-

Class SkillsSimilarityScoreResponse

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        SkillsSimilarityScoreResponse

        -
        public SkillsSimilarityScoreResponse()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/SkillsSimilarityScoreResponseValue.html b/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/SkillsSimilarityScoreResponseValue.html deleted file mode 100644 index 815aa3be0..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/SkillsSimilarityScoreResponseValue.html +++ /dev/null @@ -1,279 +0,0 @@ - - - - - - -SkillsSimilarityScoreResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.dataenrichment.ontology.response
-

Class SkillsSimilarityScoreResponseValue

-
-
- -
-
    -
  • -
    -
    -
    public class SkillsSimilarityScoreResponseValue
-extends Object
    -
    One entry in the ApiResponse.Value from a 'skills Similarity Score' response
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        SimilarityScore

        -
        public float SimilarityScore
        -
        A value from [0 - 1] representing how closely related skill set A and skill set B are, based on the relations between skills.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        SkillsSimilarityScoreResponseValue

        -
        public SkillsSimilarityScoreResponseValue()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/SuggestProfessionsResponse.html b/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/SuggestProfessionsResponse.html deleted file mode 100644 index eb26018e0..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/SuggestProfessionsResponse.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - -SuggestProfessionsResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api.dataenrichment.ontology.response
-

Class SuggestProfessionsResponse

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        SuggestProfessionsResponse

        -
        public SuggestProfessionsResponse()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/SuggestProfessionsResponseValue.html b/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/SuggestProfessionsResponseValue.html deleted file mode 100644 index 721152488..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/SuggestProfessionsResponseValue.html +++ /dev/null @@ -1,295 +0,0 @@ - - - - - - -SuggestProfessionsResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.dataenrichment.ontology.response
-

Class SuggestProfessionsResponseValue

-
-
- -
-
    -
  • -
    -
    -
    public class SuggestProfessionsResponseValue
-extends Object
    -
    One entry in the ApiResponse.Value from a 'SuggestProfessions' response
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        SuggestedProfessions

        -
        public List<SuggestedProfession> SuggestedProfessions
        -
        A list of professions most relevant to the given skills.
        -
        • -
      - - - - -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        SuggestProfessionsResponseValue

        -
        public SuggestProfessionsResponseValue()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/SuggestSkillsResponse.html b/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/SuggestSkillsResponse.html deleted file mode 100644 index 076f92e81..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/SuggestSkillsResponse.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - -SuggestSkillsResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api.dataenrichment.ontology.response
-

Class SuggestSkillsResponse

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        SuggestSkillsResponse

        -
        public SuggestSkillsResponse()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/SuggestSkillsResponseValue.html b/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/SuggestSkillsResponseValue.html deleted file mode 100644 index 61d6d2f8b..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/SuggestSkillsResponseValue.html +++ /dev/null @@ -1,279 +0,0 @@ - - - - - - -SuggestSkillsResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.dataenrichment.ontology.response
-

Class SuggestSkillsResponseValue

-
-
- -
-
    -
  • -
    -
    -
    public class SuggestSkillsResponseValue
-extends Object
    -
    One entry in the ApiResponse.Value from a 'SuggestSkills' response
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        SuggestedSkills

        -
        public List<SkillScore> SuggestedSkills
        -
        A list of skills related to the given professions.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        SuggestSkillsResponseValue

        -
        public SuggestSkillsResponseValue()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/SuggestedProfession.html b/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/SuggestedProfession.html deleted file mode 100644 index 8dbdc9056..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/SuggestedProfession.html +++ /dev/null @@ -1,327 +0,0 @@ - - - - - - -SuggestedProfession (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.dataenrichment.ontology.response
-

Class SuggestedProfession

-
-
- -
-
    -
  • -
    -
    -
    public class SuggestedProfession
-extends Object
    -
    A profession that was most relevant to the given skill.
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - - - - - -
        -
      • -

        Score

        -
        public float Score
        -
        A value from [0 - 1] indicating how relative the given skills are to this profession.
        -
        • -
      - - - - - - - -
        -
      • -

        Description

        -
        public String Description
        -
        The description of the profession in the Professions Taxonomy.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        SuggestedProfession

        -
        public SuggestedProfession()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/SuggestedProfessionsWarnings.html b/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/SuggestedProfessionsWarnings.html deleted file mode 100644 index 0c036f1f2..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/SuggestedProfessionsWarnings.html +++ /dev/null @@ -1,295 +0,0 @@ - - - - - - -SuggestedProfessionsWarnings (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.dataenrichment.ontology.response
-

Class SuggestedProfessionsWarnings

-
-
- -
-
    -
  • -
    -
    -
    public class SuggestedProfessionsWarnings
-extends Object
    -
    Warnings when trying to suggest professions from skills.
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        SkillsWithoutProfessionRelation

        -
        public List<String> SkillsWithoutProfessionRelation
        -
        A list of warnings about provided skills that do not have a profession relation.
        -
        • -
      - - - -
        -
      • -

        InvalidSkills

        -
        public List<String> InvalidSkills
        -
        A list of warnings about provided skills that are invalid.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        SuggestedProfessionsWarnings

        -
        public SuggestedProfessionsWarnings()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/class-use/CompareProfessionsResponse.html b/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/class-use/CompareProfessionsResponse.html deleted file mode 100644 index 5c2f5aa15..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/class-use/CompareProfessionsResponse.html +++ /dev/null @@ -1,170 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.dataenrichment.ontology.response.CompareProfessionsResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.dataenrichment.ontology.response.CompareProfessionsResponse

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/class-use/CompareProfessionsResponseValue.html b/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/class-use/CompareProfessionsResponseValue.html deleted file mode 100644 index f7c9d33a6..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/class-use/CompareProfessionsResponseValue.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.dataenrichment.ontology.response.CompareProfessionsResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.dataenrichment.ontology.response.CompareProfessionsResponseValue

-
-
No usage of com.textkernel.tx.models.api.dataenrichment.ontology.response.CompareProfessionsResponseValue
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/class-use/CompareSkillsToProfessionResponse.html b/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/class-use/CompareSkillsToProfessionResponse.html deleted file mode 100644 index f5698162d..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/class-use/CompareSkillsToProfessionResponse.html +++ /dev/null @@ -1,179 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.dataenrichment.ontology.response.CompareSkillsToProfessionResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.dataenrichment.ontology.response.CompareSkillsToProfessionResponse

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/class-use/CompareSkillsToProfessionResponseValue.html b/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/class-use/CompareSkillsToProfessionResponseValue.html deleted file mode 100644 index a5d39fdc3..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/class-use/CompareSkillsToProfessionResponseValue.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.dataenrichment.ontology.response.CompareSkillsToProfessionResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.dataenrichment.ontology.response.CompareSkillsToProfessionResponseValue

-
-
No usage of com.textkernel.tx.models.api.dataenrichment.ontology.response.CompareSkillsToProfessionResponseValue
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/class-use/ProfessionExclusiveSkills.html b/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/class-use/ProfessionExclusiveSkills.html deleted file mode 100644 index 0d7f3b559..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/class-use/ProfessionExclusiveSkills.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.dataenrichment.ontology.response.ProfessionExclusiveSkills (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.dataenrichment.ontology.response.ProfessionExclusiveSkills

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/class-use/SkillScore.html b/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/class-use/SkillScore.html deleted file mode 100644 index 7b74a2f80..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/class-use/SkillScore.html +++ /dev/null @@ -1,335 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.dataenrichment.ontology.response.SkillScore (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.dataenrichment.ontology.response.SkillScore

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/class-use/SkillsSimilarityScoreResponse.html b/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/class-use/SkillsSimilarityScoreResponse.html deleted file mode 100644 index 50a5056fd..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/class-use/SkillsSimilarityScoreResponse.html +++ /dev/null @@ -1,176 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.dataenrichment.ontology.response.SkillsSimilarityScoreResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.dataenrichment.ontology.response.SkillsSimilarityScoreResponse

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/class-use/SkillsSimilarityScoreResponseValue.html b/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/class-use/SkillsSimilarityScoreResponseValue.html deleted file mode 100644 index 45bb89c80..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/class-use/SkillsSimilarityScoreResponseValue.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.dataenrichment.ontology.response.SkillsSimilarityScoreResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.dataenrichment.ontology.response.SkillsSimilarityScoreResponseValue

-
-
No usage of com.textkernel.tx.models.api.dataenrichment.ontology.response.SkillsSimilarityScoreResponseValue
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/class-use/SuggestProfessionsResponse.html b/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/class-use/SuggestProfessionsResponse.html deleted file mode 100644 index 081e9d999..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/class-use/SuggestProfessionsResponse.html +++ /dev/null @@ -1,284 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.dataenrichment.ontology.response.SuggestProfessionsResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.dataenrichment.ontology.response.SuggestProfessionsResponse

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/class-use/SuggestProfessionsResponseValue.html b/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/class-use/SuggestProfessionsResponseValue.html deleted file mode 100644 index 1be60cf16..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/class-use/SuggestProfessionsResponseValue.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.dataenrichment.ontology.response.SuggestProfessionsResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.dataenrichment.ontology.response.SuggestProfessionsResponseValue

-
-
No usage of com.textkernel.tx.models.api.dataenrichment.ontology.response.SuggestProfessionsResponseValue
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/class-use/SuggestSkillsResponse.html b/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/class-use/SuggestSkillsResponse.html deleted file mode 100644 index f8b4218f8..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/class-use/SuggestSkillsResponse.html +++ /dev/null @@ -1,338 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.dataenrichment.ontology.response.SuggestSkillsResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.dataenrichment.ontology.response.SuggestSkillsResponse

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/class-use/SuggestSkillsResponseValue.html b/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/class-use/SuggestSkillsResponseValue.html deleted file mode 100644 index ac6e29095..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/class-use/SuggestSkillsResponseValue.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.dataenrichment.ontology.response.SuggestSkillsResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.dataenrichment.ontology.response.SuggestSkillsResponseValue

-
-
No usage of com.textkernel.tx.models.api.dataenrichment.ontology.response.SuggestSkillsResponseValue
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/class-use/SuggestedProfession.html b/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/class-use/SuggestedProfession.html deleted file mode 100644 index 432814085..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/class-use/SuggestedProfession.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.dataenrichment.ontology.response.SuggestedProfession (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.dataenrichment.ontology.response.SuggestedProfession

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/class-use/SuggestedProfessionsWarnings.html b/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/class-use/SuggestedProfessionsWarnings.html deleted file mode 100644 index 8c0d72ba2..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/class-use/SuggestedProfessionsWarnings.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.dataenrichment.ontology.response.SuggestedProfessionsWarnings (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.dataenrichment.ontology.response.SuggestedProfessionsWarnings

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/package-frame.html b/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/package-frame.html deleted file mode 100644 index ebb26be80..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/package-frame.html +++ /dev/null @@ -1,34 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.dataenrichment.ontology.response (Textkernel Tx Java SDK 2.3.3 API) - - - - - -

com.textkernel.tx.models.api.dataenrichment.ontology.response

-
-

Classes

- -
- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/package-summary.html b/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/package-summary.html deleted file mode 100644 index 05c241814..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/package-summary.html +++ /dev/null @@ -1,224 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.dataenrichment.ontology.response (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package com.textkernel.tx.models.api.dataenrichment.ontology.response

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/package-tree.html b/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/package-tree.html deleted file mode 100644 index 5243147ea..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/package-tree.html +++ /dev/null @@ -1,156 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.dataenrichment.ontology.response Class Hierarchy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package com.textkernel.tx.models.api.dataenrichment.ontology.response

-Package Hierarchies: - -
-
-

Class Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/package-use.html b/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/package-use.html deleted file mode 100644 index 9724442ff..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/ontology/response/package-use.html +++ /dev/null @@ -1,243 +0,0 @@ - - - - - - -Uses of Package com.textkernel.tx.models.api.dataenrichment.ontology.response (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Package
com.textkernel.tx.models.api.dataenrichment.ontology.response

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/package-frame.html b/docs/com/textkernel/tx/models/api/dataenrichment/package-frame.html deleted file mode 100644 index f02aad243..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/package-frame.html +++ /dev/null @@ -1,26 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.dataenrichment (Textkernel Tx Java SDK 2.3.3 API) - - - - - -

com.textkernel.tx.models.api.dataenrichment

-
-

Classes

- -

Enums

- -
- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/package-summary.html b/docs/com/textkernel/tx/models/api/dataenrichment/package-summary.html deleted file mode 100644 index e1ad6afd2..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/package-summary.html +++ /dev/null @@ -1,169 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.dataenrichment (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package com.textkernel.tx.models.api.dataenrichment

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/package-tree.html b/docs/com/textkernel/tx/models/api/dataenrichment/package-tree.html deleted file mode 100644 index 62e31b4ef..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/package-tree.html +++ /dev/null @@ -1,156 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.dataenrichment Class Hierarchy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package com.textkernel.tx.models.api.dataenrichment

-Package Hierarchies: - -
-
-

Class Hierarchy

- -

Enum Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/package-use.html b/docs/com/textkernel/tx/models/api/dataenrichment/package-use.html deleted file mode 100644 index 68bbd5ab5..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/package-use.html +++ /dev/null @@ -1,208 +0,0 @@ - - - - - - -Uses of Package com.textkernel.tx.models.api.dataenrichment (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Package
com.textkernel.tx.models.api.dataenrichment

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/professions/ONETVersion.html b/docs/com/textkernel/tx/models/api/dataenrichment/professions/ONETVersion.html deleted file mode 100644 index 1e2302ab1..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/professions/ONETVersion.html +++ /dev/null @@ -1,352 +0,0 @@ - - - - - - -ONETVersion (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.dataenrichment.professions
-

Enum ONETVersion

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Enum Constant Detail

      - - - -
        -
      • -

        ONET2010

        -
        @SerializedName(value="2010")
-public static final ONETVersion ONET2010
        -
        ONET 2010
        -
        • -
      - - - -
        -
      • -

        ONET2019

        -
        @SerializedName(value="2019")
-public static final ONETVersion ONET2019
        -
        ONET 2010
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        values

        -
        public static ONETVersion[] values()
        -
        Returns an array containing the constants of this enum type, in -the order they are declared. This method may be used to iterate -over the constants as follows: -
        -for (ONETVersion c : ONETVersion.values())
-    System.out.println(c);
-
        -
        -
        Returns:
        -
        an array containing the constants of this enum type, in the order they are declared
        -
        -
        • -
      - - - -
        -
      • -

        valueOf

        -
        public static ONETVersion valueOf(String name)
        -
        Returns the enum constant of this type with the specified name. -The string must match exactly an identifier used to declare an -enum constant in this type. (Extraneous whitespace characters are -not permitted.)
        -
        -
        Parameters:
        -
        name - the name of the enum constant to be returned.
        -
        Returns:
        -
        the enum constant with the specified name
        -
        Throws:
        -
        IllegalArgumentException - if this enum type has no constant with the specified name
        -
        NullPointerException - if the argument is null
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/professions/ProfessionNormalizationVersions.html b/docs/com/textkernel/tx/models/api/dataenrichment/professions/ProfessionNormalizationVersions.html deleted file mode 100644 index 91ff3a31e..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/professions/ProfessionNormalizationVersions.html +++ /dev/null @@ -1,279 +0,0 @@ - - - - - - -ProfessionNormalizationVersions (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.dataenrichment.professions
-

Class ProfessionNormalizationVersions

-
-
- -
-
    -
  • -
    -
    -
    public class ProfessionNormalizationVersions
-extends Object
    -
    Versions to use when normalizing professions if more than one is available for a taxonomy
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        ONET

        -
        public ONETVersion ONET
        -
        The ONET Version to use when normalizing Professions. Defaults to ONET2010
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ProfessionNormalizationVersions

        -
        public ProfessionNormalizationVersions()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/professions/class-use/ONETVersion.html b/docs/com/textkernel/tx/models/api/dataenrichment/professions/class-use/ONETVersion.html deleted file mode 100644 index bbb27a512..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/professions/class-use/ONETVersion.html +++ /dev/null @@ -1,190 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.dataenrichment.professions.ONETVersion (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.dataenrichment.professions.ONETVersion

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/professions/class-use/ProfessionNormalizationVersions.html b/docs/com/textkernel/tx/models/api/dataenrichment/professions/class-use/ProfessionNormalizationVersions.html deleted file mode 100644 index 6c5fd2185..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/professions/class-use/ProfessionNormalizationVersions.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.dataenrichment.professions.ProfessionNormalizationVersions (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.dataenrichment.professions.ProfessionNormalizationVersions

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/professions/package-frame.html b/docs/com/textkernel/tx/models/api/dataenrichment/professions/package-frame.html deleted file mode 100644 index e536f6d98..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/professions/package-frame.html +++ /dev/null @@ -1,25 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.dataenrichment.professions (Textkernel Tx Java SDK 2.3.3 API) - - - - - -

com.textkernel.tx.models.api.dataenrichment.professions

-
-

Classes

- -

Enums

- -
- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/professions/package-summary.html b/docs/com/textkernel/tx/models/api/dataenrichment/professions/package-summary.html deleted file mode 100644 index 7be29a13f..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/professions/package-summary.html +++ /dev/null @@ -1,163 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.dataenrichment.professions (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package com.textkernel.tx.models.api.dataenrichment.professions

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/professions/package-tree.html b/docs/com/textkernel/tx/models/api/dataenrichment/professions/package-tree.html deleted file mode 100644 index 7b3c42abe..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/professions/package-tree.html +++ /dev/null @@ -1,151 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.dataenrichment.professions Class Hierarchy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package com.textkernel.tx.models.api.dataenrichment.professions

-Package Hierarchies: - -
-
-

Class Hierarchy

- -

Enum Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/professions/package-use.html b/docs/com/textkernel/tx/models/api/dataenrichment/professions/package-use.html deleted file mode 100644 index 93bddb4d9..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/professions/package-use.html +++ /dev/null @@ -1,182 +0,0 @@ - - - - - - -Uses of Package com.textkernel.tx.models.api.dataenrichment.professions (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Package
com.textkernel.tx.models.api.dataenrichment.professions

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/professions/request/LookupProfessionCodesRequest.html b/docs/com/textkernel/tx/models/api/dataenrichment/professions/request/LookupProfessionCodesRequest.html deleted file mode 100644 index bd23591bf..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/professions/request/LookupProfessionCodesRequest.html +++ /dev/null @@ -1,295 +0,0 @@ - - - - - - -LookupProfessionCodesRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.dataenrichment.professions.request
-

Class LookupProfessionCodesRequest

-
-
- -
-
    -
  • -
    -
    -
    public class LookupProfessionCodesRequest
-extends Object
    -
    Request body for a 'LookupProfessions' request
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - - - - - -
        -
      • -

        OutputLanguage

        -
        public String OutputLanguage
        -
        The language to use for professions descriptions (default is en). Must be an allowed ISO code.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        LookupProfessionCodesRequest

        -
        public LookupProfessionCodesRequest()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/professions/request/NormalizeProfessionsRequest.html b/docs/com/textkernel/tx/models/api/dataenrichment/professions/request/NormalizeProfessionsRequest.html deleted file mode 100644 index 852cb4a95..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/professions/request/NormalizeProfessionsRequest.html +++ /dev/null @@ -1,311 +0,0 @@ - - - - - - -NormalizeProfessionsRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.dataenrichment.professions.request
-

Class NormalizeProfessionsRequest

-
-
- -
-
    -
  • -
    -
    -
    public class NormalizeProfessionsRequest
-extends Object
    -
    Request body for a 'NormalizeProfessions' request
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        JobTitles

        -
        public List<String> JobTitles
        -
        The list of job titles to normalize (up to 10 job titles, each job title may not exceed 400 characters).
        -
        • -
      - - - -
        -
      • -

        Language

        -
        public String Language
        -
        The language of the input job titles. Must be one of the supported ISO codes.
        -
        • -
      - - - -
        -
      • -

        OutputLanguage

        -
        public String OutputLanguage
        -
        The language to use for descriptions of the returned normalized professions. Must be one of the supported ISO codes.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        NormalizeProfessionsRequest

        -
        public NormalizeProfessionsRequest()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/professions/request/class-use/LookupProfessionCodesRequest.html b/docs/com/textkernel/tx/models/api/dataenrichment/professions/request/class-use/LookupProfessionCodesRequest.html deleted file mode 100644 index a6a298fac..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/professions/request/class-use/LookupProfessionCodesRequest.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.dataenrichment.professions.request.LookupProfessionCodesRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.dataenrichment.professions.request.LookupProfessionCodesRequest

-
-
No usage of com.textkernel.tx.models.api.dataenrichment.professions.request.LookupProfessionCodesRequest
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/professions/request/class-use/NormalizeProfessionsRequest.html b/docs/com/textkernel/tx/models/api/dataenrichment/professions/request/class-use/NormalizeProfessionsRequest.html deleted file mode 100644 index 989615011..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/professions/request/class-use/NormalizeProfessionsRequest.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.dataenrichment.professions.request.NormalizeProfessionsRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.dataenrichment.professions.request.NormalizeProfessionsRequest

-
-
No usage of com.textkernel.tx.models.api.dataenrichment.professions.request.NormalizeProfessionsRequest
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/professions/request/package-frame.html b/docs/com/textkernel/tx/models/api/dataenrichment/professions/request/package-frame.html deleted file mode 100644 index c7f9fe6e7..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/professions/request/package-frame.html +++ /dev/null @@ -1,22 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.dataenrichment.professions.request (Textkernel Tx Java SDK 2.3.3 API) - - - - - -

com.textkernel.tx.models.api.dataenrichment.professions.request

-
-

Classes

- -
- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/professions/request/package-summary.html b/docs/com/textkernel/tx/models/api/dataenrichment/professions/request/package-summary.html deleted file mode 100644 index 7464e8ca3..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/professions/request/package-summary.html +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.dataenrichment.professions.request (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package com.textkernel.tx.models.api.dataenrichment.professions.request

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/professions/request/package-tree.html b/docs/com/textkernel/tx/models/api/dataenrichment/professions/request/package-tree.html deleted file mode 100644 index 71f90dc62..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/professions/request/package-tree.html +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.dataenrichment.professions.request Class Hierarchy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package com.textkernel.tx.models.api.dataenrichment.professions.request

-Package Hierarchies: - -
-
-

Class Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/professions/request/package-use.html b/docs/com/textkernel/tx/models/api/dataenrichment/professions/request/package-use.html deleted file mode 100644 index f1499b770..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/professions/request/package-use.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Package com.textkernel.tx.models.api.dataenrichment.professions.request (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Package
com.textkernel.tx.models.api.dataenrichment.professions.request

-
-
No usage of com.textkernel.tx.models.api.dataenrichment.professions.request
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/GetProfessionsTaxonomyResponse.html b/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/GetProfessionsTaxonomyResponse.html deleted file mode 100644 index f6343d3e8..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/GetProfessionsTaxonomyResponse.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - -GetProfessionsTaxonomyResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api.dataenrichment.professions.response
-

Class GetProfessionsTaxonomyResponse

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        GetProfessionsTaxonomyResponse

        -
        public GetProfessionsTaxonomyResponse()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/GetProfessionsTaxonomyResponseValue.html b/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/GetProfessionsTaxonomyResponseValue.html deleted file mode 100644 index 0ba9998d0..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/GetProfessionsTaxonomyResponseValue.html +++ /dev/null @@ -1,291 +0,0 @@ - - - - - - -GetProfessionsTaxonomyResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.dataenrichment.professions.response
-

Class GetProfessionsTaxonomyResponseValue

-
-
- -
-
    -
  • -
    -
    -
    public class GetProfessionsTaxonomyResponseValue
-extends Taxonomy
    -
    One entry in the ApiResponse.Value from a 'GetProfessionsTaxonomy' response
    -
    • -
-
-
- -
-
-
    -
  • - - - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        GetProfessionsTaxonomyResponseValue

        -
        public GetProfessionsTaxonomyResponseValue()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/LookupProfessionCodesResponse.html b/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/LookupProfessionCodesResponse.html deleted file mode 100644 index 93ea327eb..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/LookupProfessionCodesResponse.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - -LookupProfessionCodesResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api.dataenrichment.professions.response
-

Class LookupProfessionCodesResponse

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        LookupProfessionCodesResponse

        -
        public LookupProfessionCodesResponse()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/LookupProfessionCodesResponseValue.html b/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/LookupProfessionCodesResponseValue.html deleted file mode 100644 index 176c1a537..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/LookupProfessionCodesResponseValue.html +++ /dev/null @@ -1,279 +0,0 @@ - - - - - - -LookupProfessionCodesResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.dataenrichment.professions.response
-

Class LookupProfessionCodesResponseValue

-
-
- -
-
    -
  • -
    -
    -
    public class LookupProfessionCodesResponseValue
-extends Object
    -
    One entry in the ApiResponse.Value from a 'LookupProfessions' response
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Professions

        -
        public List<Profession> Professions
        -
        A list of returned professions.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        LookupProfessionCodesResponseValue

        -
        public LookupProfessionCodesResponseValue()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/NormalizeProfessionsResponse.html b/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/NormalizeProfessionsResponse.html deleted file mode 100644 index 89af7de01..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/NormalizeProfessionsResponse.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - -NormalizeProfessionsResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api.dataenrichment.professions.response
-

Class NormalizeProfessionsResponse

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        NormalizeProfessionsResponse

        -
        public NormalizeProfessionsResponse()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/NormalizeProfessionsResponseValue.html b/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/NormalizeProfessionsResponseValue.html deleted file mode 100644 index 1d47cefc1..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/NormalizeProfessionsResponseValue.html +++ /dev/null @@ -1,279 +0,0 @@ - - - - - - -NormalizeProfessionsResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.dataenrichment.professions.response
-

Class NormalizeProfessionsResponseValue

-
-
- -
-
    -
  • -
    -
    -
    public class NormalizeProfessionsResponseValue
-extends Object
    -
    One entry in the ApiResponse.Value from a 'NormalizeProfessions' response
    -
    • -
-
-
- -
-
-
    -
  • - - - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        NormalizeProfessionsResponseValue

        -
        public NormalizeProfessionsResponseValue()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/ProfessionsAutoCompleteResponse.html b/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/ProfessionsAutoCompleteResponse.html deleted file mode 100644 index b0ade3d4a..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/ProfessionsAutoCompleteResponse.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - -ProfessionsAutoCompleteResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api.dataenrichment.professions.response
-

Class ProfessionsAutoCompleteResponse

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ProfessionsAutoCompleteResponse

        -
        public ProfessionsAutoCompleteResponse()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/ProfessionsAutoCompleteResponseValue.html b/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/ProfessionsAutoCompleteResponseValue.html deleted file mode 100644 index 1c5e887e5..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/ProfessionsAutoCompleteResponseValue.html +++ /dev/null @@ -1,279 +0,0 @@ - - - - - - -ProfessionsAutoCompleteResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.dataenrichment.professions.response
-

Class ProfessionsAutoCompleteResponseValue

-
-
- -
-
    -
  • -
    -
    -
    public class ProfessionsAutoCompleteResponseValue
-extends Object
    -
    One entry in the ApiResponse.Value from a 'ProfessionsAutocomplete' response
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Professions

        -
        public List<BasicProfession> Professions
        -
        A list of professions that match the given Prefix.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ProfessionsAutoCompleteResponseValue

        -
        public ProfessionsAutoCompleteResponseValue()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/class-use/GetProfessionsTaxonomyResponse.html b/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/class-use/GetProfessionsTaxonomyResponse.html deleted file mode 100644 index b8c1bd3f4..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/class-use/GetProfessionsTaxonomyResponse.html +++ /dev/null @@ -1,175 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.dataenrichment.professions.response.GetProfessionsTaxonomyResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.dataenrichment.professions.response.GetProfessionsTaxonomyResponse

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/class-use/GetProfessionsTaxonomyResponseValue.html b/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/class-use/GetProfessionsTaxonomyResponseValue.html deleted file mode 100644 index c657be4bd..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/class-use/GetProfessionsTaxonomyResponseValue.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.dataenrichment.professions.response.GetProfessionsTaxonomyResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.dataenrichment.professions.response.GetProfessionsTaxonomyResponseValue

-
-
No usage of com.textkernel.tx.models.api.dataenrichment.professions.response.GetProfessionsTaxonomyResponseValue
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/class-use/LookupProfessionCodesResponse.html b/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/class-use/LookupProfessionCodesResponse.html deleted file mode 100644 index d879f99f5..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/class-use/LookupProfessionCodesResponse.html +++ /dev/null @@ -1,175 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.dataenrichment.professions.response.LookupProfessionCodesResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.dataenrichment.professions.response.LookupProfessionCodesResponse

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/class-use/LookupProfessionCodesResponseValue.html b/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/class-use/LookupProfessionCodesResponseValue.html deleted file mode 100644 index 0bc3dbf81..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/class-use/LookupProfessionCodesResponseValue.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.dataenrichment.professions.response.LookupProfessionCodesResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.dataenrichment.professions.response.LookupProfessionCodesResponseValue

-
-
No usage of com.textkernel.tx.models.api.dataenrichment.professions.response.LookupProfessionCodesResponseValue
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/class-use/NormalizeProfessionsResponse.html b/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/class-use/NormalizeProfessionsResponse.html deleted file mode 100644 index 45da7be61..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/class-use/NormalizeProfessionsResponse.html +++ /dev/null @@ -1,176 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.dataenrichment.professions.response.NormalizeProfessionsResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.dataenrichment.professions.response.NormalizeProfessionsResponse

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/class-use/NormalizeProfessionsResponseValue.html b/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/class-use/NormalizeProfessionsResponseValue.html deleted file mode 100644 index 1d76ce22d..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/class-use/NormalizeProfessionsResponseValue.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.dataenrichment.professions.response.NormalizeProfessionsResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.dataenrichment.professions.response.NormalizeProfessionsResponseValue

-
-
No usage of com.textkernel.tx.models.api.dataenrichment.professions.response.NormalizeProfessionsResponseValue
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/class-use/ProfessionsAutoCompleteResponse.html b/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/class-use/ProfessionsAutoCompleteResponse.html deleted file mode 100644 index 5b8c8eaa2..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/class-use/ProfessionsAutoCompleteResponse.html +++ /dev/null @@ -1,177 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.dataenrichment.professions.response.ProfessionsAutoCompleteResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.dataenrichment.professions.response.ProfessionsAutoCompleteResponse

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/class-use/ProfessionsAutoCompleteResponseValue.html b/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/class-use/ProfessionsAutoCompleteResponseValue.html deleted file mode 100644 index 6648c9729..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/class-use/ProfessionsAutoCompleteResponseValue.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.dataenrichment.professions.response.ProfessionsAutoCompleteResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.dataenrichment.professions.response.ProfessionsAutoCompleteResponseValue

-
-
No usage of com.textkernel.tx.models.api.dataenrichment.professions.response.ProfessionsAutoCompleteResponseValue
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/package-frame.html b/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/package-frame.html deleted file mode 100644 index 4e4b7e7f8..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/package-frame.html +++ /dev/null @@ -1,28 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.dataenrichment.professions.response (Textkernel Tx Java SDK 2.3.3 API) - - - - - -

com.textkernel.tx.models.api.dataenrichment.professions.response

-
-

Classes

- -
- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/package-summary.html b/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/package-summary.html deleted file mode 100644 index 5f0f3cca7..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/package-summary.html +++ /dev/null @@ -1,188 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.dataenrichment.professions.response (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package com.textkernel.tx.models.api.dataenrichment.professions.response

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/package-tree.html b/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/package-tree.html deleted file mode 100644 index 834edef16..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/package-tree.html +++ /dev/null @@ -1,154 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.dataenrichment.professions.response Class Hierarchy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package com.textkernel.tx.models.api.dataenrichment.professions.response

-Package Hierarchies: - -
-
-

Class Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/package-use.html b/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/package-use.html deleted file mode 100644 index edf9837f6..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/professions/response/package-use.html +++ /dev/null @@ -1,176 +0,0 @@ - - - - - - -Uses of Package com.textkernel.tx.models.api.dataenrichment.professions.response (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Package
com.textkernel.tx.models.api.dataenrichment.professions.response

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/skills/request/ExtractSkillsRequest.html b/docs/com/textkernel/tx/models/api/dataenrichment/skills/request/ExtractSkillsRequest.html deleted file mode 100644 index 35947aa97..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/skills/request/ExtractSkillsRequest.html +++ /dev/null @@ -1,327 +0,0 @@ - - - - - - -ExtractSkillsRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.dataenrichment.skills.request
-

Class ExtractSkillsRequest

-
-
- -
-
    -
  • -
    -
    -
    public class ExtractSkillsRequest
-extends Object
    -
    Request body for a 'ExtractSkills' request
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Text

        -
        public String Text
        -
        The text to extract skills from. There is a 24,000 character limit.
        -
        • -
      - - - -
        -
      • -

        Language

        -
        public String Language
        -
        The language of the input text. Must be one of the supported ISO codes.
        -
        • -
      - - - -
        -
      • -

        Threshold

        -
        public float Threshold
        -
        A value from [0 - 1] for the minimum confidence threshold for extracted skills. Lower values will return more skills, but also increase the likelihood of ambiguity-related errors. The recommended and default value is 0.5.
        -
        • -
      - - - -
        -
      • -

        OutputLanguage

        -
        public String OutputLanguage
        -
        The language to use for the output skill descriptions. If not provided, defaults to the input language. Must be one of the supported ISO codes.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ExtractSkillsRequest

        -
        public ExtractSkillsRequest()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/skills/request/LookupSkillsRequest.html b/docs/com/textkernel/tx/models/api/dataenrichment/skills/request/LookupSkillsRequest.html deleted file mode 100644 index b73b448c2..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/skills/request/LookupSkillsRequest.html +++ /dev/null @@ -1,295 +0,0 @@ - - - - - - -LookupSkillsRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.dataenrichment.skills.request
-

Class LookupSkillsRequest

-
-
- -
-
    -
  • -
    -
    -
    public class LookupSkillsRequest
-extends Object
    -
    Request body for a 'LookupSkills' request
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        SkillIds

        -
        public List<String> SkillIds
        -
        The IDs of the skills to get details about. A maximum of 100 IDs can be requested.
        -
        • -
      - - - -
        -
      • -

        OutputLanguage

        -
        public String OutputLanguage
        -
        The language to use for the output skill descriptions. If not provided, defaults to en. If specified, must be one of the supported ISO codes.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        LookupSkillsRequest

        -
        public LookupSkillsRequest()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/skills/request/NormalizeSkillsRequest.html b/docs/com/textkernel/tx/models/api/dataenrichment/skills/request/NormalizeSkillsRequest.html deleted file mode 100644 index 66cf5c17d..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/skills/request/NormalizeSkillsRequest.html +++ /dev/null @@ -1,311 +0,0 @@ - - - - - - -NormalizeSkillsRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.dataenrichment.skills.request
-

Class NormalizeSkillsRequest

-
-
- -
-
    -
  • -
    -
    -
    public class NormalizeSkillsRequest
-extends Object
    -
    Request body for a 'NormalizeSkills' request
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Skills

        -
        public List<String> Skills
        -
        The list of skills to normalize (up to 50 skills, each skill may not exceed 100 characters).
        -
        • -
      - - - -
        -
      • -

        Language

        -
        public String Language
        -
        The language of the given skills. Must be one of the supported ISO codes.
        -
        • -
      - - - -
        -
      • -

        OutputLanguage

        -
        public String OutputLanguage
        -
        The language to use for the output skill descriptions. If not provided, defaults to the input language. Must be one of the supported ISO codes.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        NormalizeSkillsRequest

        -
        public NormalizeSkillsRequest()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/skills/request/SkillsAutoCompleteRequest.html b/docs/com/textkernel/tx/models/api/dataenrichment/skills/request/SkillsAutoCompleteRequest.html deleted file mode 100644 index 05b019cd5..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/skills/request/SkillsAutoCompleteRequest.html +++ /dev/null @@ -1,292 +0,0 @@ - - - - - - -SkillsAutoCompleteRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.dataenrichment.skills.request
-

Class SkillsAutoCompleteRequest

-
-
- -
-
    -
  • -
    -
    -
    public class SkillsAutoCompleteRequest
-extends AutocompleteRequest
    -
    Request body for a 'SkillsAutocomplete' request
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Types

        -
        public List<String> Types
        -
        If specified, only these types of skills will be returned. The following - values are acceptable: Professional, IT, Language, Soft, Certification (only when using v2 endpoints), All.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        SkillsAutoCompleteRequest

        -
        public SkillsAutoCompleteRequest()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/skills/request/class-use/ExtractSkillsRequest.html b/docs/com/textkernel/tx/models/api/dataenrichment/skills/request/class-use/ExtractSkillsRequest.html deleted file mode 100644 index 643cc07b4..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/skills/request/class-use/ExtractSkillsRequest.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.dataenrichment.skills.request.ExtractSkillsRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.dataenrichment.skills.request.ExtractSkillsRequest

-
-
No usage of com.textkernel.tx.models.api.dataenrichment.skills.request.ExtractSkillsRequest
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/skills/request/class-use/LookupSkillsRequest.html b/docs/com/textkernel/tx/models/api/dataenrichment/skills/request/class-use/LookupSkillsRequest.html deleted file mode 100644 index 2fc438da1..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/skills/request/class-use/LookupSkillsRequest.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.dataenrichment.skills.request.LookupSkillsRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.dataenrichment.skills.request.LookupSkillsRequest

-
-
No usage of com.textkernel.tx.models.api.dataenrichment.skills.request.LookupSkillsRequest
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/skills/request/class-use/NormalizeSkillsRequest.html b/docs/com/textkernel/tx/models/api/dataenrichment/skills/request/class-use/NormalizeSkillsRequest.html deleted file mode 100644 index a25bfd9d5..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/skills/request/class-use/NormalizeSkillsRequest.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.dataenrichment.skills.request.NormalizeSkillsRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.dataenrichment.skills.request.NormalizeSkillsRequest

-
-
No usage of com.textkernel.tx.models.api.dataenrichment.skills.request.NormalizeSkillsRequest
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/skills/request/class-use/SkillsAutoCompleteRequest.html b/docs/com/textkernel/tx/models/api/dataenrichment/skills/request/class-use/SkillsAutoCompleteRequest.html deleted file mode 100644 index 4bf9e1587..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/skills/request/class-use/SkillsAutoCompleteRequest.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.dataenrichment.skills.request.SkillsAutoCompleteRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.dataenrichment.skills.request.SkillsAutoCompleteRequest

-
-
No usage of com.textkernel.tx.models.api.dataenrichment.skills.request.SkillsAutoCompleteRequest
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/skills/request/package-frame.html b/docs/com/textkernel/tx/models/api/dataenrichment/skills/request/package-frame.html deleted file mode 100644 index 1a02de8f0..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/skills/request/package-frame.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.dataenrichment.skills.request (Textkernel Tx Java SDK 2.3.3 API) - - - - - -

com.textkernel.tx.models.api.dataenrichment.skills.request

-
-

Classes

- -
- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/skills/request/package-summary.html b/docs/com/textkernel/tx/models/api/dataenrichment/skills/request/package-summary.html deleted file mode 100644 index 33b0ccec4..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/skills/request/package-summary.html +++ /dev/null @@ -1,164 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.dataenrichment.skills.request (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package com.textkernel.tx.models.api.dataenrichment.skills.request

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/skills/request/package-tree.html b/docs/com/textkernel/tx/models/api/dataenrichment/skills/request/package-tree.html deleted file mode 100644 index 387283029..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/skills/request/package-tree.html +++ /dev/null @@ -1,146 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.dataenrichment.skills.request Class Hierarchy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package com.textkernel.tx.models.api.dataenrichment.skills.request

-Package Hierarchies: - -
-
-

Class Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/skills/request/package-use.html b/docs/com/textkernel/tx/models/api/dataenrichment/skills/request/package-use.html deleted file mode 100644 index ab2e05504..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/skills/request/package-use.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Package com.textkernel.tx.models.api.dataenrichment.skills.request (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Package
com.textkernel.tx.models.api.dataenrichment.skills.request

-
-
No usage of com.textkernel.tx.models.api.dataenrichment.skills.request
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/AutoCompleteSkillsResponse.html b/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/AutoCompleteSkillsResponse.html deleted file mode 100644 index d46e66c18..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/AutoCompleteSkillsResponse.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - -AutoCompleteSkillsResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api.dataenrichment.skills.response
-

Class AutoCompleteSkillsResponse

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        AutoCompleteSkillsResponse

        -
        public AutoCompleteSkillsResponse()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/AutocompleteSkillsResponseValue.html b/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/AutocompleteSkillsResponseValue.html deleted file mode 100644 index 387fe59c9..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/AutocompleteSkillsResponseValue.html +++ /dev/null @@ -1,279 +0,0 @@ - - - - - - -AutocompleteSkillsResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.dataenrichment.skills.response
-

Class AutocompleteSkillsResponseValue

-
-
- -
-
    -
  • -
    -
    -
    public class AutocompleteSkillsResponseValue
-extends Object
    -
    One entry in the ApiResponse.Value from a 'SkillsAutocomplete' response
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Skills

        -
        public List<Skill> Skills
        -
        A list of skills based on the given Prefix.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        AutocompleteSkillsResponseValue

        -
        public AutocompleteSkillsResponseValue()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/ExtractSkillsResponse.html b/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/ExtractSkillsResponse.html deleted file mode 100644 index 7aa85f8cf..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/ExtractSkillsResponse.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - -ExtractSkillsResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api.dataenrichment.skills.response
-

Class ExtractSkillsResponse

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ExtractSkillsResponse

        -
        public ExtractSkillsResponse()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/ExtractSkillsResponseValue.html b/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/ExtractSkillsResponseValue.html deleted file mode 100644 index 370b37eb1..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/ExtractSkillsResponseValue.html +++ /dev/null @@ -1,295 +0,0 @@ - - - - - - -ExtractSkillsResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.dataenrichment.skills.response
-

Class ExtractSkillsResponseValue

-
-
- -
-
    -
  • -
    -
    -
    public class ExtractSkillsResponseValue
-extends Object
    -
    One entry in the ApiResponse.Value from a 'ExtractSkills' response
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Truncated

        -
        public boolean Truncated
        -
        Whether the input text was truncated or not due to length.
        -
        • -
      - - - - -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ExtractSkillsResponseValue

        -
        public ExtractSkillsResponseValue()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/GetSkillsTaxonomyResponse.html b/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/GetSkillsTaxonomyResponse.html deleted file mode 100644 index ebb491891..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/GetSkillsTaxonomyResponse.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - -GetSkillsTaxonomyResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api.dataenrichment.skills.response
-

Class GetSkillsTaxonomyResponse

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        GetSkillsTaxonomyResponse

        -
        public GetSkillsTaxonomyResponse()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/GetSkillsTaxonomyResponseValue.html b/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/GetSkillsTaxonomyResponseValue.html deleted file mode 100644 index 4f6e7e5be..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/GetSkillsTaxonomyResponseValue.html +++ /dev/null @@ -1,291 +0,0 @@ - - - - - - -GetSkillsTaxonomyResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.dataenrichment.skills.response
-

Class GetSkillsTaxonomyResponseValue

-
-
- -
-
    -
  • -
    -
    -
    public class GetSkillsTaxonomyResponseValue
-extends Taxonomy
    -
    One entry in the ApiResponse.Value from a 'GetSkillsTaxonomy' response
    -
    • -
-
-
- -
-
-
    -
  • - - - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        GetSkillsTaxonomyResponseValue

        -
        public GetSkillsTaxonomyResponseValue()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/LookupSkillCodesResponse.html b/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/LookupSkillCodesResponse.html deleted file mode 100644 index 167b78a3b..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/LookupSkillCodesResponse.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - -LookupSkillCodesResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api.dataenrichment.skills.response
-

Class LookupSkillCodesResponse

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        LookupSkillCodesResponse

        -
        public LookupSkillCodesResponse()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/LookupSkillCodesResponseValue.html b/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/LookupSkillCodesResponseValue.html deleted file mode 100644 index 4280ce639..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/LookupSkillCodesResponseValue.html +++ /dev/null @@ -1,279 +0,0 @@ - - - - - - -LookupSkillCodesResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.dataenrichment.skills.response
-

Class LookupSkillCodesResponseValue

-
-
- -
-
    -
  • -
    -
    -
    public class LookupSkillCodesResponseValue
-extends Object
    -
    One entry in the ApiResponse.Value from a 'LookupSkills' response
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Skills

        -
        public List<Skill> Skills
        -
        List of skills in from the skills taxonomy.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        LookupSkillCodesResponseValue

        -
        public LookupSkillCodesResponseValue()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/NormalizeSkillsResponse.html b/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/NormalizeSkillsResponse.html deleted file mode 100644 index aa1b0be08..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/NormalizeSkillsResponse.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - -NormalizeSkillsResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api.dataenrichment.skills.response
-

Class NormalizeSkillsResponse

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        NormalizeSkillsResponse

        -
        public NormalizeSkillsResponse()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/NormalizeSkillsResponseValue.html b/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/NormalizeSkillsResponseValue.html deleted file mode 100644 index 50346d96f..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/NormalizeSkillsResponseValue.html +++ /dev/null @@ -1,279 +0,0 @@ - - - - - - -NormalizeSkillsResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.dataenrichment.skills.response
-

Class NormalizeSkillsResponseValue

-
-
- -
-
    -
  • -
    -
    -
    public class NormalizeSkillsResponseValue
-extends Object
    -
    One entry in the ApiResponse.Value from a 'NormalizeSkills' response
    -
    • -
-
-
- -
-
-
    -
  • - - - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        NormalizeSkillsResponseValue

        -
        public NormalizeSkillsResponseValue()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/class-use/AutoCompleteSkillsResponse.html b/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/class-use/AutoCompleteSkillsResponse.html deleted file mode 100644 index aa04e79a7..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/class-use/AutoCompleteSkillsResponse.html +++ /dev/null @@ -1,194 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.dataenrichment.skills.response.AutoCompleteSkillsResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.dataenrichment.skills.response.AutoCompleteSkillsResponse

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/class-use/AutocompleteSkillsResponseValue.html b/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/class-use/AutocompleteSkillsResponseValue.html deleted file mode 100644 index 40ffcde4e..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/class-use/AutocompleteSkillsResponseValue.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.dataenrichment.skills.response.AutocompleteSkillsResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.dataenrichment.skills.response.AutocompleteSkillsResponseValue

-
-
No usage of com.textkernel.tx.models.api.dataenrichment.skills.response.AutocompleteSkillsResponseValue
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/class-use/ExtractSkillsResponse.html b/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/class-use/ExtractSkillsResponse.html deleted file mode 100644 index f75c4dc3b..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/class-use/ExtractSkillsResponse.html +++ /dev/null @@ -1,192 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.dataenrichment.skills.response.ExtractSkillsResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.dataenrichment.skills.response.ExtractSkillsResponse

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/class-use/ExtractSkillsResponseValue.html b/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/class-use/ExtractSkillsResponseValue.html deleted file mode 100644 index f091fefe2..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/class-use/ExtractSkillsResponseValue.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.dataenrichment.skills.response.ExtractSkillsResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.dataenrichment.skills.response.ExtractSkillsResponseValue

-
-
No usage of com.textkernel.tx.models.api.dataenrichment.skills.response.ExtractSkillsResponseValue
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/class-use/GetSkillsTaxonomyResponse.html b/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/class-use/GetSkillsTaxonomyResponse.html deleted file mode 100644 index 59dd46270..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/class-use/GetSkillsTaxonomyResponse.html +++ /dev/null @@ -1,186 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.dataenrichment.skills.response.GetSkillsTaxonomyResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.dataenrichment.skills.response.GetSkillsTaxonomyResponse

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/class-use/GetSkillsTaxonomyResponseValue.html b/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/class-use/GetSkillsTaxonomyResponseValue.html deleted file mode 100644 index ed02beb01..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/class-use/GetSkillsTaxonomyResponseValue.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.dataenrichment.skills.response.GetSkillsTaxonomyResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.dataenrichment.skills.response.GetSkillsTaxonomyResponseValue

-
-
No usage of com.textkernel.tx.models.api.dataenrichment.skills.response.GetSkillsTaxonomyResponseValue
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/class-use/LookupSkillCodesResponse.html b/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/class-use/LookupSkillCodesResponse.html deleted file mode 100644 index 217ed9bf3..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/class-use/LookupSkillCodesResponse.html +++ /dev/null @@ -1,188 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.dataenrichment.skills.response.LookupSkillCodesResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.dataenrichment.skills.response.LookupSkillCodesResponse

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/class-use/LookupSkillCodesResponseValue.html b/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/class-use/LookupSkillCodesResponseValue.html deleted file mode 100644 index d611062a9..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/class-use/LookupSkillCodesResponseValue.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.dataenrichment.skills.response.LookupSkillCodesResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.dataenrichment.skills.response.LookupSkillCodesResponseValue

-
-
No usage of com.textkernel.tx.models.api.dataenrichment.skills.response.LookupSkillCodesResponseValue
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/class-use/NormalizeSkillsResponse.html b/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/class-use/NormalizeSkillsResponse.html deleted file mode 100644 index 173d8dd8b..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/class-use/NormalizeSkillsResponse.html +++ /dev/null @@ -1,190 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.dataenrichment.skills.response.NormalizeSkillsResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.dataenrichment.skills.response.NormalizeSkillsResponse

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/class-use/NormalizeSkillsResponseValue.html b/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/class-use/NormalizeSkillsResponseValue.html deleted file mode 100644 index 4e0dc5e34..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/class-use/NormalizeSkillsResponseValue.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.dataenrichment.skills.response.NormalizeSkillsResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.dataenrichment.skills.response.NormalizeSkillsResponseValue

-
-
No usage of com.textkernel.tx.models.api.dataenrichment.skills.response.NormalizeSkillsResponseValue
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/package-frame.html b/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/package-frame.html deleted file mode 100644 index a5373900b..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/package-frame.html +++ /dev/null @@ -1,30 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.dataenrichment.skills.response (Textkernel Tx Java SDK 2.3.3 API) - - - - - -

com.textkernel.tx.models.api.dataenrichment.skills.response

-
-

Classes

- -
- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/package-summary.html b/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/package-summary.html deleted file mode 100644 index cc72bfc9f..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/package-summary.html +++ /dev/null @@ -1,200 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.dataenrichment.skills.response (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package com.textkernel.tx.models.api.dataenrichment.skills.response

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/package-tree.html b/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/package-tree.html deleted file mode 100644 index e41bbace6..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/package-tree.html +++ /dev/null @@ -1,156 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.dataenrichment.skills.response Class Hierarchy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package com.textkernel.tx.models.api.dataenrichment.skills.response

-Package Hierarchies: - -
-
-

Class Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/package-use.html b/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/package-use.html deleted file mode 100644 index 066143cb9..000000000 --- a/docs/com/textkernel/tx/models/api/dataenrichment/skills/response/package-use.html +++ /dev/null @@ -1,181 +0,0 @@ - - - - - - -Uses of Package com.textkernel.tx.models.api.dataenrichment.skills.response (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Package
com.textkernel.tx.models.api.dataenrichment.skills.response

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/formatter/FormatResumeRequest.html b/docs/com/textkernel/tx/models/api/formatter/FormatResumeRequest.html deleted file mode 100644 index 7adb5b252..000000000 --- a/docs/com/textkernel/tx/models/api/formatter/FormatResumeRequest.html +++ /dev/null @@ -1,378 +0,0 @@ - - - - - - -FormatResumeRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.formatter
-

Class FormatResumeRequest

-
-
- -
-
    -
  • -
    -
    -
    public class FormatResumeRequest
-extends Object
    -
    Request body for the Format Resume With Template endpoint
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        ResumeData

        -
        public ParsedResume ResumeData
        -
        The resume to use to populate the template
        -
        • -
      - - - -
        -
      • -

        Template

        -
        public String Template
        -
        A base64-encoded string of the DOCX template document file bytes. This should use the standard 'base64' - encoding as defined in RFC 4648 Section 4 (not the 'base64url' variant). -

        Java users can use Base64.Encoder.encodeToString(byte[]) -

        For more information on creating custom templates, see - here

        -
        • -
      - - - - - - - -
        -
      • -

        CustomData

        -
        public Object CustomData
        -
        Any data that the template needs that is not in the extracted CV data. For example: - 
        -JSONObject myCustomData = new JSONObject();
-myCustomData.put("CandidateId", "12345");
-myCustomData.put("DateApplied", LocalDate.now());
-formatRequest.CustomData = myCustomData;
-
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        FormatResumeRequest

        -
        public FormatResumeRequest(ParsedResume resume,
-                           String templatePath,
-                           OutputDocumentFormat docType)
-                    throws IOException
        -
        Creates a request to use when calling the Resume Formatter endpoint with a provided template document.
        -
        -
        Parameters:
        -
        resume - The resume to use to populate the template
        -
        templatePath - The path to the template DOCX file on disk
        -
        docType - The output document type
        -
        Throws:
        -
        IOException - if an error occurs reading the file contents
        -
        -
        • -
      - - - -
        -
      • -

        FormatResumeRequest

        -
        public FormatResumeRequest(ParsedResume resume,
-                           byte[] templateFileBytes,
-                           OutputDocumentFormat docType)
        -
        Creates a request to use when calling the Resume Formatter endpoint with a provided template document.
        -
        -
        Parameters:
        -
        resume - The resume to use to populate the template
        -
        templateFileBytes - The bytes of the template DOCX file
        -
        docType - The output document type
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/formatter/FormatResumeResponse.html b/docs/com/textkernel/tx/models/api/formatter/FormatResumeResponse.html deleted file mode 100644 index 49df8a3d3..000000000 --- a/docs/com/textkernel/tx/models/api/formatter/FormatResumeResponse.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - -FormatResumeResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api.formatter
-

Class FormatResumeResponse

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        FormatResumeResponse

        -
        public FormatResumeResponse()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/formatter/FormatResumeResponseValue.html b/docs/com/textkernel/tx/models/api/formatter/FormatResumeResponseValue.html deleted file mode 100644 index d943a70fb..000000000 --- a/docs/com/textkernel/tx/models/api/formatter/FormatResumeResponseValue.html +++ /dev/null @@ -1,281 +0,0 @@ - - - - - - -FormatResumeResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.formatter
-

Class FormatResumeResponseValue

-
-
- -
-
    -
  • -
    -
    -
    public class FormatResumeResponseValue
-extends Object
    -
    The ApiResponse.Value from a Format Resume response
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        DocumentAsBase64String

        -
        public String DocumentAsBase64String
        -
        The formatted resume document (either PDF or DOCX). - This is a byte[] as a Base64-encoded string. You can use - Base64.Decoder.decode(String) to get a byte[] to save to disk.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        FormatResumeResponseValue

        -
        public FormatResumeResponseValue()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/formatter/OutputDocumentFormat.html b/docs/com/textkernel/tx/models/api/formatter/OutputDocumentFormat.html deleted file mode 100644 index f674dcf5e..000000000 --- a/docs/com/textkernel/tx/models/api/formatter/OutputDocumentFormat.html +++ /dev/null @@ -1,350 +0,0 @@ - - - - - - -OutputDocumentFormat (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.formatter
-

Enum OutputDocumentFormat

-
-
- -
- -
-
- -
-
-
    -
  • - - - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        values

        -
        public static OutputDocumentFormat[] values()
        -
        Returns an array containing the constants of this enum type, in -the order they are declared. This method may be used to iterate -over the constants as follows: -
        -for (OutputDocumentFormat c : OutputDocumentFormat.values())
-    System.out.println(c);
-
        -
        -
        Returns:
        -
        an array containing the constants of this enum type, in the order they are declared
        -
        -
        • -
      - - - -
        -
      • -

        valueOf

        -
        public static OutputDocumentFormat valueOf(String name)
        -
        Returns the enum constant of this type with the specified name. -The string must match exactly an identifier used to declare an -enum constant in this type. (Extraneous whitespace characters are -not permitted.)
        -
        -
        Parameters:
        -
        name - the name of the enum constant to be returned.
        -
        Returns:
        -
        the enum constant with the specified name
        -
        Throws:
        -
        IllegalArgumentException - if this enum type has no constant with the specified name
        -
        NullPointerException - if the argument is null
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/formatter/class-use/FormatResumeRequest.html b/docs/com/textkernel/tx/models/api/formatter/class-use/FormatResumeRequest.html deleted file mode 100644 index 21ffa35d3..000000000 --- a/docs/com/textkernel/tx/models/api/formatter/class-use/FormatResumeRequest.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.formatter.FormatResumeRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.formatter.FormatResumeRequest

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/formatter/class-use/FormatResumeResponse.html b/docs/com/textkernel/tx/models/api/formatter/class-use/FormatResumeResponse.html deleted file mode 100644 index 67ceaa656..000000000 --- a/docs/com/textkernel/tx/models/api/formatter/class-use/FormatResumeResponse.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.formatter.FormatResumeResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.formatter.FormatResumeResponse

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/formatter/class-use/FormatResumeResponseValue.html b/docs/com/textkernel/tx/models/api/formatter/class-use/FormatResumeResponseValue.html deleted file mode 100644 index 058bafb3e..000000000 --- a/docs/com/textkernel/tx/models/api/formatter/class-use/FormatResumeResponseValue.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.formatter.FormatResumeResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.formatter.FormatResumeResponseValue

-
-
No usage of com.textkernel.tx.models.api.formatter.FormatResumeResponseValue
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/formatter/class-use/OutputDocumentFormat.html b/docs/com/textkernel/tx/models/api/formatter/class-use/OutputDocumentFormat.html deleted file mode 100644 index e9d9df376..000000000 --- a/docs/com/textkernel/tx/models/api/formatter/class-use/OutputDocumentFormat.html +++ /dev/null @@ -1,212 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.formatter.OutputDocumentFormat (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.formatter.OutputDocumentFormat

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/formatter/package-frame.html b/docs/com/textkernel/tx/models/api/formatter/package-frame.html deleted file mode 100644 index d8c835854..000000000 --- a/docs/com/textkernel/tx/models/api/formatter/package-frame.html +++ /dev/null @@ -1,27 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.formatter (Textkernel Tx Java SDK 2.3.3 API) - - - - - -

com.textkernel.tx.models.api.formatter

-
-

Classes

- -

Enums

- -
- - diff --git a/docs/com/textkernel/tx/models/api/formatter/package-summary.html b/docs/com/textkernel/tx/models/api/formatter/package-summary.html deleted file mode 100644 index 9408113b8..000000000 --- a/docs/com/textkernel/tx/models/api/formatter/package-summary.html +++ /dev/null @@ -1,175 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.formatter (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package com.textkernel.tx.models.api.formatter

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/formatter/package-tree.html b/docs/com/textkernel/tx/models/api/formatter/package-tree.html deleted file mode 100644 index 424879b32..000000000 --- a/docs/com/textkernel/tx/models/api/formatter/package-tree.html +++ /dev/null @@ -1,157 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.formatter Class Hierarchy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package com.textkernel.tx.models.api.formatter

-Package Hierarchies: - -
-
-

Class Hierarchy

- -

Enum Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/formatter/package-use.html b/docs/com/textkernel/tx/models/api/formatter/package-use.html deleted file mode 100644 index 76a9354cc..000000000 --- a/docs/com/textkernel/tx/models/api/formatter/package-use.html +++ /dev/null @@ -1,187 +0,0 @@ - - - - - - -Uses of Package com.textkernel.tx.models.api.formatter (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Package
com.textkernel.tx.models.api.formatter

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/geocoding/Address.html b/docs/com/textkernel/tx/models/api/geocoding/Address.html deleted file mode 100644 index fadd2d1aa..000000000 --- a/docs/com/textkernel/tx/models/api/geocoding/Address.html +++ /dev/null @@ -1,343 +0,0 @@ - - - - - - -Address (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.geocoding
-

Class Address

-
-
- -
-
    -
  • -
    -
    -
    public class Address
-extends Object
    -
    An address used to geocode a document
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        CountryCode

        -
        public String CountryCode
        -
        The 2-letter ISO 3166 country code
        -
        • -
      - - - -
        -
      • -

        PostalCode

        -
        public String PostalCode
        -
        The Postal or Zip code
        -
        • -
      - - - -
        -
      • -

        Region

        -
        public String Region
        -
        The Region/District/State
        -
        • -
      - - - -
        -
      • -

        Municipality

        -
        public String Municipality
        -
        The City/Municipality/Town
        -
        • -
      - - - -
        -
      • -

        AddressLine

        -
        public String AddressLine
        -
        Street address
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        Address

        -
        public Address()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/geocoding/GeocodeAndIndexJobRequest.html b/docs/com/textkernel/tx/models/api/geocoding/GeocodeAndIndexJobRequest.html deleted file mode 100644 index cc1533a75..000000000 --- a/docs/com/textkernel/tx/models/api/geocoding/GeocodeAndIndexJobRequest.html +++ /dev/null @@ -1,291 +0,0 @@ - - - - - - -GeocodeAndIndexJobRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.geocoding
-

Class GeocodeAndIndexJobRequest

-
-
- -
-
    -
  • -
    -
    -
    public class GeocodeAndIndexJobRequest
-extends GeocodeAndIndexRequest
    -
    Request body for geocoding a job and then adding into an index
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        JobData

        -
        public ParsedJob JobData
        -
        The job you wish to be geocoded/indexed
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        GeocodeAndIndexJobRequest

        -
        public GeocodeAndIndexJobRequest()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/geocoding/GeocodeAndIndexJobResponse.html b/docs/com/textkernel/tx/models/api/geocoding/GeocodeAndIndexJobResponse.html deleted file mode 100644 index 4b2ae1879..000000000 --- a/docs/com/textkernel/tx/models/api/geocoding/GeocodeAndIndexJobResponse.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - -GeocodeAndIndexJobResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api.geocoding
-

Class GeocodeAndIndexJobResponse

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        GeocodeAndIndexJobResponse

        -
        public GeocodeAndIndexJobResponse()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/geocoding/GeocodeAndIndexJobResponseValue.html b/docs/com/textkernel/tx/models/api/geocoding/GeocodeAndIndexJobResponseValue.html deleted file mode 100644 index 926aeae01..000000000 --- a/docs/com/textkernel/tx/models/api/geocoding/GeocodeAndIndexJobResponseValue.html +++ /dev/null @@ -1,291 +0,0 @@ - - - - - - -GeocodeAndIndexJobResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.geocoding
-

Class GeocodeAndIndexJobResponseValue

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        JobData

        -
        public ParsedJob JobData
        -
        The job you sent to be geocoded/indexed with geolocation coordinates added
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        GeocodeAndIndexJobResponseValue

        -
        public GeocodeAndIndexJobResponseValue()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/geocoding/GeocodeAndIndexRequest.html b/docs/com/textkernel/tx/models/api/geocoding/GeocodeAndIndexRequest.html deleted file mode 100644 index 7f61523f8..000000000 --- a/docs/com/textkernel/tx/models/api/geocoding/GeocodeAndIndexRequest.html +++ /dev/null @@ -1,315 +0,0 @@ - - - - - - -GeocodeAndIndexRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.geocoding
-

Class GeocodeAndIndexRequest

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        IndexIfGeocodeFails

        -
        public boolean IndexIfGeocodeFails
        -
        Indicates whether or not the document should still be added to the index if the geocode request fails.
        -
        • -
      - - - - - - - - -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        GeocodeAndIndexRequest

        -
        public GeocodeAndIndexRequest()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/geocoding/GeocodeAndIndexResponseValue.html b/docs/com/textkernel/tx/models/api/geocoding/GeocodeAndIndexResponseValue.html deleted file mode 100644 index de57bb41a..000000000 --- a/docs/com/textkernel/tx/models/api/geocoding/GeocodeAndIndexResponseValue.html +++ /dev/null @@ -1,299 +0,0 @@ - - - - - - -GeocodeAndIndexResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.geocoding
-

Class GeocodeAndIndexResponseValue

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        GeocodeResponse

        -
        public ApiResponseInfoLite GeocodeResponse
        -
        If geocoding was requested, the status of the geocode transaction will be output here
        -
        • -
      - - - -
        -
      • -

        IndexingResponse

        -
        public ApiResponseInfoLite IndexingResponse
        -
        If indexing was requested, the status of the index transaction will be output here
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        GeocodeAndIndexResponseValue

        -
        public GeocodeAndIndexResponseValue()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/geocoding/GeocodeAndIndexResumeRequest.html b/docs/com/textkernel/tx/models/api/geocoding/GeocodeAndIndexResumeRequest.html deleted file mode 100644 index a87810240..000000000 --- a/docs/com/textkernel/tx/models/api/geocoding/GeocodeAndIndexResumeRequest.html +++ /dev/null @@ -1,291 +0,0 @@ - - - - - - -GeocodeAndIndexResumeRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.geocoding
-

Class GeocodeAndIndexResumeRequest

-
-
- -
-
    -
  • -
    -
    -
    public class GeocodeAndIndexResumeRequest
-extends GeocodeAndIndexRequest
    -
    Request body for geocoding a resume and then adding into an index
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        ResumeData

        -
        public ParsedResume ResumeData
        -
        The resume you wish to be geocoded/indexed
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        GeocodeAndIndexResumeRequest

        -
        public GeocodeAndIndexResumeRequest()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/geocoding/GeocodeAndIndexResumeResponse.html b/docs/com/textkernel/tx/models/api/geocoding/GeocodeAndIndexResumeResponse.html deleted file mode 100644 index a3a63bb84..000000000 --- a/docs/com/textkernel/tx/models/api/geocoding/GeocodeAndIndexResumeResponse.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - -GeocodeAndIndexResumeResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api.geocoding
-

Class GeocodeAndIndexResumeResponse

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        GeocodeAndIndexResumeResponse

        -
        public GeocodeAndIndexResumeResponse()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/geocoding/GeocodeAndIndexResumeResponseValue.html b/docs/com/textkernel/tx/models/api/geocoding/GeocodeAndIndexResumeResponseValue.html deleted file mode 100644 index 66a0bdded..000000000 --- a/docs/com/textkernel/tx/models/api/geocoding/GeocodeAndIndexResumeResponseValue.html +++ /dev/null @@ -1,291 +0,0 @@ - - - - - - -GeocodeAndIndexResumeResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.geocoding
-

Class GeocodeAndIndexResumeResponseValue

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        ResumeData

        -
        public ParsedResume ResumeData
        -
        The resume you sent to be geocoded/indexed with geolocation coordinates added
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        GeocodeAndIndexResumeResponseValue

        -
        public GeocodeAndIndexResumeResponseValue()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/geocoding/GeocodeCredentials.html b/docs/com/textkernel/tx/models/api/geocoding/GeocodeCredentials.html deleted file mode 100644 index 25e293e93..000000000 --- a/docs/com/textkernel/tx/models/api/geocoding/GeocodeCredentials.html +++ /dev/null @@ -1,301 +0,0 @@ - - - - - - -GeocodeCredentials (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.geocoding
-

Class GeocodeCredentials

-
-
- -
-
    -
  • -
    -
    Direct Known Subclasses:
    -
    GeocodeOptionsBase
    -
    -
    -
    -
    public class GeocodeCredentials
-extends Object
    -
    Credentials for geocoding
    -
    • -
-
-
- -
-
- -
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/geocoding/GeocodeJobRequest.html b/docs/com/textkernel/tx/models/api/geocoding/GeocodeJobRequest.html deleted file mode 100644 index 183545e95..000000000 --- a/docs/com/textkernel/tx/models/api/geocoding/GeocodeJobRequest.html +++ /dev/null @@ -1,303 +0,0 @@ - - - - - - -GeocodeJobRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.geocoding
-

Class GeocodeJobRequest

-
-
- -
-
    -
  • -
    -
    -
    public class GeocodeJobRequest
-extends GeocodeOptionsBase
    -
    Options for geocoding a job (specifying some location on Earth)
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        JobData

        -
        public ParsedJob JobData
        -
        The job you wish to be geocoded
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        GeocodeJobRequest

        -
        public GeocodeJobRequest()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/geocoding/GeocodeJobResponse.html b/docs/com/textkernel/tx/models/api/geocoding/GeocodeJobResponse.html deleted file mode 100644 index 3c436a2ed..000000000 --- a/docs/com/textkernel/tx/models/api/geocoding/GeocodeJobResponse.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - -GeocodeJobResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api.geocoding
-

Class GeocodeJobResponse

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        GeocodeJobResponse

        -
        public GeocodeJobResponse()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/geocoding/GeocodeJobResponseValue.html b/docs/com/textkernel/tx/models/api/geocoding/GeocodeJobResponseValue.html deleted file mode 100644 index 9e40501d2..000000000 --- a/docs/com/textkernel/tx/models/api/geocoding/GeocodeJobResponseValue.html +++ /dev/null @@ -1,279 +0,0 @@ - - - - - - -GeocodeJobResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.geocoding
-

Class GeocodeJobResponseValue

-
-
- -
-
    -
  • -
    -
    -
    public class GeocodeJobResponseValue
-extends Object
    -
    The ApiResponse.Value from a 'geocode job' response
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        JobData

        -
        public ParsedJob JobData
        -
        The job you sent to be geocoded with geolocation coordinates added
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        GeocodeJobResponseValue

        -
        public GeocodeJobResponseValue()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/geocoding/GeocodeOptions.html b/docs/com/textkernel/tx/models/api/geocoding/GeocodeOptions.html deleted file mode 100644 index 4c967a28f..000000000 --- a/docs/com/textkernel/tx/models/api/geocoding/GeocodeOptions.html +++ /dev/null @@ -1,303 +0,0 @@ - - - - - - -GeocodeOptions (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.geocoding
-

Class GeocodeOptions

-
-
- -
-
    -
  • -
    -
    -
    public class GeocodeOptions
-extends GeocodeOptionsBase
    -
    Options for geocoding a document (specifying some location on Earth)
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        IncludeGeocoding

        -
        public boolean IncludeGeocoding
        -
        true to geocode, otherwise false
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        GeocodeOptions

        -
        public GeocodeOptions()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/geocoding/GeocodeOptionsBase.html b/docs/com/textkernel/tx/models/api/geocoding/GeocodeOptionsBase.html deleted file mode 100644 index 0d0b3a9bb..000000000 --- a/docs/com/textkernel/tx/models/api/geocoding/GeocodeOptionsBase.html +++ /dev/null @@ -1,318 +0,0 @@ - - - - - - -GeocodeOptionsBase (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.geocoding
-

Class GeocodeOptionsBase

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        PostalAddress

        -
        public Address PostalAddress
        -
        The address you wish to geocode. This field is optional. -

        If you specify this value, - this address will be used to get the geocode coordinates instead of the address included - in the parsed document (if present); however, the address in the parsed document will not be modified.

        -
        • -
      - - - -
        -
      • -

        GeoCoordinates

        -
        public GeoCoordinates GeoCoordinates
        -
        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 parsed document and the address included in the - parsed document (if present), will not be modified.

        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        GeocodeOptionsBase

        -
        public GeocodeOptionsBase()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/geocoding/GeocodeProvider.html b/docs/com/textkernel/tx/models/api/geocoding/GeocodeProvider.html deleted file mode 100644 index ce90f7b0d..000000000 --- a/docs/com/textkernel/tx/models/api/geocoding/GeocodeProvider.html +++ /dev/null @@ -1,350 +0,0 @@ - - - - - - -GeocodeProvider (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.geocoding
-

Enum GeocodeProvider

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Enum Constant Detail

      - - - -
        -
      • -

        Google

        -
        public static final GeocodeProvider Google
        -
        Google Maps geocoding service
        -
        • -
      - - - -
        -
      • -

        Bing

        -
        public static final GeocodeProvider Bing
        -
        Bing geocoding service
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        values

        -
        public static GeocodeProvider[] values()
        -
        Returns an array containing the constants of this enum type, in -the order they are declared. This method may be used to iterate -over the constants as follows: -
        -for (GeocodeProvider c : GeocodeProvider.values())
-    System.out.println(c);
-
        -
        -
        Returns:
        -
        an array containing the constants of this enum type, in the order they are declared
        -
        -
        • -
      - - - -
        -
      • -

        valueOf

        -
        public static GeocodeProvider valueOf(String name)
        -
        Returns the enum constant of this type with the specified name. -The string must match exactly an identifier used to declare an -enum constant in this type. (Extraneous whitespace characters are -not permitted.)
        -
        -
        Parameters:
        -
        name - the name of the enum constant to be returned.
        -
        Returns:
        -
        the enum constant with the specified name
        -
        Throws:
        -
        IllegalArgumentException - if this enum type has no constant with the specified name
        -
        NullPointerException - if the argument is null
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/geocoding/GeocodeResumeRequest.html b/docs/com/textkernel/tx/models/api/geocoding/GeocodeResumeRequest.html deleted file mode 100644 index de6ef4483..000000000 --- a/docs/com/textkernel/tx/models/api/geocoding/GeocodeResumeRequest.html +++ /dev/null @@ -1,303 +0,0 @@ - - - - - - -GeocodeResumeRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.geocoding
-

Class GeocodeResumeRequest

-
-
- -
-
    -
  • -
    -
    -
    public class GeocodeResumeRequest
-extends GeocodeOptionsBase
    -
    Options for geocoding a resume (specifying some location on Earth)
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        ResumeData

        -
        public ParsedResume ResumeData
        -
        The resume you wish to be geocoded
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        GeocodeResumeRequest

        -
        public GeocodeResumeRequest()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/geocoding/GeocodeResumeResponse.html b/docs/com/textkernel/tx/models/api/geocoding/GeocodeResumeResponse.html deleted file mode 100644 index 65dc21a82..000000000 --- a/docs/com/textkernel/tx/models/api/geocoding/GeocodeResumeResponse.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - -GeocodeResumeResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api.geocoding
-

Class GeocodeResumeResponse

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        GeocodeResumeResponse

        -
        public GeocodeResumeResponse()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/geocoding/GeocodeResumeResponseValue.html b/docs/com/textkernel/tx/models/api/geocoding/GeocodeResumeResponseValue.html deleted file mode 100644 index cf5a6f365..000000000 --- a/docs/com/textkernel/tx/models/api/geocoding/GeocodeResumeResponseValue.html +++ /dev/null @@ -1,279 +0,0 @@ - - - - - - -GeocodeResumeResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.geocoding
-

Class GeocodeResumeResponseValue

-
-
- -
-
    -
  • -
    -
    -
    public class GeocodeResumeResponseValue
-extends Object
    -
    The ApiResponse.Value from a 'geocode resume' response
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        ResumeData

        -
        public ParsedResume ResumeData
        -
        The resume you sent to be geocoded with geolocation coordinates added
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        GeocodeResumeResponseValue

        -
        public GeocodeResumeResponseValue()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/geocoding/class-use/Address.html b/docs/com/textkernel/tx/models/api/geocoding/class-use/Address.html deleted file mode 100644 index 8a991aede..000000000 --- a/docs/com/textkernel/tx/models/api/geocoding/class-use/Address.html +++ /dev/null @@ -1,226 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.geocoding.Address (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.geocoding.Address

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeAndIndexJobRequest.html b/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeAndIndexJobRequest.html deleted file mode 100644 index a8a0b4c19..000000000 --- a/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeAndIndexJobRequest.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.geocoding.GeocodeAndIndexJobRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.geocoding.GeocodeAndIndexJobRequest

-
-
No usage of com.textkernel.tx.models.api.geocoding.GeocodeAndIndexJobRequest
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeAndIndexJobResponse.html b/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeAndIndexJobResponse.html deleted file mode 100644 index bc7951840..000000000 --- a/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeAndIndexJobResponse.html +++ /dev/null @@ -1,192 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.geocoding.GeocodeAndIndexJobResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.geocoding.GeocodeAndIndexJobResponse

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeAndIndexJobResponseValue.html b/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeAndIndexJobResponseValue.html deleted file mode 100644 index fe61131d1..000000000 --- a/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeAndIndexJobResponseValue.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.geocoding.GeocodeAndIndexJobResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.geocoding.GeocodeAndIndexJobResponseValue

-
-
No usage of com.textkernel.tx.models.api.geocoding.GeocodeAndIndexJobResponseValue
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeAndIndexRequest.html b/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeAndIndexRequest.html deleted file mode 100644 index bf2085ecc..000000000 --- a/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeAndIndexRequest.html +++ /dev/null @@ -1,174 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.geocoding.GeocodeAndIndexRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.geocoding.GeocodeAndIndexRequest

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeAndIndexResponseValue.html b/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeAndIndexResponseValue.html deleted file mode 100644 index ac19afcb7..000000000 --- a/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeAndIndexResponseValue.html +++ /dev/null @@ -1,174 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.geocoding.GeocodeAndIndexResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.geocoding.GeocodeAndIndexResponseValue

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeAndIndexResumeRequest.html b/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeAndIndexResumeRequest.html deleted file mode 100644 index e64bc57b5..000000000 --- a/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeAndIndexResumeRequest.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.geocoding.GeocodeAndIndexResumeRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.geocoding.GeocodeAndIndexResumeRequest

-
-
No usage of com.textkernel.tx.models.api.geocoding.GeocodeAndIndexResumeRequest
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeAndIndexResumeResponse.html b/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeAndIndexResumeResponse.html deleted file mode 100644 index b551ef344..000000000 --- a/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeAndIndexResumeResponse.html +++ /dev/null @@ -1,192 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.geocoding.GeocodeAndIndexResumeResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.geocoding.GeocodeAndIndexResumeResponse

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeAndIndexResumeResponseValue.html b/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeAndIndexResumeResponseValue.html deleted file mode 100644 index 1c8dc2c6a..000000000 --- a/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeAndIndexResumeResponseValue.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.geocoding.GeocodeAndIndexResumeResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.geocoding.GeocodeAndIndexResumeResponseValue

-
-
No usage of com.textkernel.tx.models.api.geocoding.GeocodeAndIndexResumeResponseValue
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeCredentials.html b/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeCredentials.html deleted file mode 100644 index 91d07974f..000000000 --- a/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeCredentials.html +++ /dev/null @@ -1,296 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.geocoding.GeocodeCredentials (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.geocoding.GeocodeCredentials

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeJobRequest.html b/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeJobRequest.html deleted file mode 100644 index c3a22d57b..000000000 --- a/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeJobRequest.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.geocoding.GeocodeJobRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.geocoding.GeocodeJobRequest

-
-
No usage of com.textkernel.tx.models.api.geocoding.GeocodeJobRequest
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeJobResponse.html b/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeJobResponse.html deleted file mode 100644 index 4dffdaece..000000000 --- a/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeJobResponse.html +++ /dev/null @@ -1,178 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.geocoding.GeocodeJobResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.geocoding.GeocodeJobResponse

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeJobResponseValue.html b/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeJobResponseValue.html deleted file mode 100644 index 0c7f3a5d9..000000000 --- a/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeJobResponseValue.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.geocoding.GeocodeJobResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.geocoding.GeocodeJobResponseValue

-
-
No usage of com.textkernel.tx.models.api.geocoding.GeocodeJobResponseValue
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeOptions.html b/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeOptions.html deleted file mode 100644 index b0950a0c9..000000000 --- a/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeOptions.html +++ /dev/null @@ -1,192 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.geocoding.GeocodeOptions (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.geocoding.GeocodeOptions

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeOptionsBase.html b/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeOptionsBase.html deleted file mode 100644 index 81e2c4f5a..000000000 --- a/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeOptionsBase.html +++ /dev/null @@ -1,195 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.geocoding.GeocodeOptionsBase (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.geocoding.GeocodeOptionsBase

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeProvider.html b/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeProvider.html deleted file mode 100644 index 0abb6ef31..000000000 --- a/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeProvider.html +++ /dev/null @@ -1,214 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.geocoding.GeocodeProvider (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.geocoding.GeocodeProvider

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeResumeRequest.html b/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeResumeRequest.html deleted file mode 100644 index 77428d213..000000000 --- a/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeResumeRequest.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.geocoding.GeocodeResumeRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.geocoding.GeocodeResumeRequest

-
-
No usage of com.textkernel.tx.models.api.geocoding.GeocodeResumeRequest
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeResumeResponse.html b/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeResumeResponse.html deleted file mode 100644 index 8f2b05dd1..000000000 --- a/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeResumeResponse.html +++ /dev/null @@ -1,178 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.geocoding.GeocodeResumeResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.geocoding.GeocodeResumeResponse

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeResumeResponseValue.html b/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeResumeResponseValue.html deleted file mode 100644 index eb9f3514d..000000000 --- a/docs/com/textkernel/tx/models/api/geocoding/class-use/GeocodeResumeResponseValue.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.geocoding.GeocodeResumeResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.geocoding.GeocodeResumeResponseValue

-
-
No usage of com.textkernel.tx.models.api.geocoding.GeocodeResumeResponseValue
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/geocoding/package-frame.html b/docs/com/textkernel/tx/models/api/geocoding/package-frame.html deleted file mode 100644 index 8ddf56ae3..000000000 --- a/docs/com/textkernel/tx/models/api/geocoding/package-frame.html +++ /dev/null @@ -1,42 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.geocoding (Textkernel Tx Java SDK 2.3.3 API) - - - - - -

com.textkernel.tx.models.api.geocoding

-
-

Classes

- -

Enums

- -
- - diff --git a/docs/com/textkernel/tx/models/api/geocoding/package-summary.html b/docs/com/textkernel/tx/models/api/geocoding/package-summary.html deleted file mode 100644 index 203c1b69c..000000000 --- a/docs/com/textkernel/tx/models/api/geocoding/package-summary.html +++ /dev/null @@ -1,265 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.geocoding (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package com.textkernel.tx.models.api.geocoding

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/geocoding/package-tree.html b/docs/com/textkernel/tx/models/api/geocoding/package-tree.html deleted file mode 100644 index 5332d24d6..000000000 --- a/docs/com/textkernel/tx/models/api/geocoding/package-tree.html +++ /dev/null @@ -1,184 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.geocoding Class Hierarchy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package com.textkernel.tx.models.api.geocoding

-Package Hierarchies: - -
-
-

Class Hierarchy

- -

Enum Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/geocoding/package-use.html b/docs/com/textkernel/tx/models/api/geocoding/package-use.html deleted file mode 100644 index 44834dd51..000000000 --- a/docs/com/textkernel/tx/models/api/geocoding/package-use.html +++ /dev/null @@ -1,295 +0,0 @@ - - - - - - -Uses of Package com.textkernel.tx.models.api.geocoding (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Package
com.textkernel.tx.models.api.geocoding

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/CreateIndexRequest.html b/docs/com/textkernel/tx/models/api/indexes/CreateIndexRequest.html deleted file mode 100644 index 73fc2c9ae..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/CreateIndexRequest.html +++ /dev/null @@ -1,279 +0,0 @@ - - - - - - -CreateIndexRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.indexes
-

Class CreateIndexRequest

-
-
- -
-
    -
  • -
    -
    -
    public class CreateIndexRequest
-extends Object
    -
    Request body to create an index
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        IndexType

        -
        public IndexType IndexType
        -
        The type of documents this index will contain
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        CreateIndexRequest

        -
        public CreateIndexRequest()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/CreateIndexResponse.html b/docs/com/textkernel/tx/models/api/indexes/CreateIndexResponse.html deleted file mode 100644 index 52b786e2c..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/CreateIndexResponse.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - -CreateIndexResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api.indexes
-

Class CreateIndexResponse

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    ITxResponse
    -
    -
    -
    -
    public class CreateIndexResponse
-extends ApiResponse<Object>
    -
    The response body from a CreateIndex API call
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        CreateIndexResponse

        -
        public CreateIndexResponse()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/DeleteDocumentResponse.html b/docs/com/textkernel/tx/models/api/indexes/DeleteDocumentResponse.html deleted file mode 100644 index 413dc2359..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/DeleteDocumentResponse.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - -DeleteDocumentResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api.indexes
-

Class DeleteDocumentResponse

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    ITxResponse
    -
    -
    -
    -
    public class DeleteDocumentResponse
-extends ApiResponse<Object>
    -
    The response body from a DeleteDocument API call
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        DeleteDocumentResponse

        -
        public DeleteDocumentResponse()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/DeleteIndexResponse.html b/docs/com/textkernel/tx/models/api/indexes/DeleteIndexResponse.html deleted file mode 100644 index f867dd569..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/DeleteIndexResponse.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - -DeleteIndexResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api.indexes
-

Class DeleteIndexResponse

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    ITxResponse
    -
    -
    -
    -
    public class DeleteIndexResponse
-extends ApiResponse<Object>
    -
    The response body from a DeleteIndex API call
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        DeleteIndexResponse

        -
        public DeleteIndexResponse()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/DeleteMultipleDocumentsResponse.html b/docs/com/textkernel/tx/models/api/indexes/DeleteMultipleDocumentsResponse.html deleted file mode 100644 index 1fb822ef0..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/DeleteMultipleDocumentsResponse.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - -DeleteMultipleDocumentsResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api.indexes
-

Class DeleteMultipleDocumentsResponse

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    ITxResponse
    -
    -
    -
    -
    public class DeleteMultipleDocumentsResponse
-extends ApiResponse<Object>
    -
    The response body from a DeleteMultipleDocuments API call
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        DeleteMultipleDocumentsResponse

        -
        public DeleteMultipleDocumentsResponse()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/GetAllIndexesResponse.html b/docs/com/textkernel/tx/models/api/indexes/GetAllIndexesResponse.html deleted file mode 100644 index 6a101dbf8..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/GetAllIndexesResponse.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - -GetAllIndexesResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api.indexes
-

Class GetAllIndexesResponse

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    ITxResponse
    -
    -
    -
    -
    public class GetAllIndexesResponse
-extends ApiResponse<List<Index>>
    -
    The response body from a GetAllIndexes API call
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        GetAllIndexesResponse

        -
        public GetAllIndexesResponse()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/GetIndexResponse.html b/docs/com/textkernel/tx/models/api/indexes/GetIndexResponse.html deleted file mode 100644 index 4e5ad850d..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/GetIndexResponse.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - -GetIndexResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api.indexes
-

Class GetIndexResponse

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    ITxResponse
    -
    -
    -
    -
    public class GetIndexResponse
-extends ApiResponse<Index>
    -
    The response body from a GetIndex API call
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        GetIndexResponse

        -
        public GetIndexResponse()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/GetJobResponse.html b/docs/com/textkernel/tx/models/api/indexes/GetJobResponse.html deleted file mode 100644 index bdfc2dfae..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/GetJobResponse.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - -GetJobResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api.indexes
-

Class GetJobResponse

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    ITxResponse
    -
    -
    -
    -
    public class GetJobResponse
-extends ApiResponse<ParsedJob>
    -
    The response body from a GetJob API call
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        GetJobResponse

        -
        public GetJobResponse()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/GetResumeResponse.html b/docs/com/textkernel/tx/models/api/indexes/GetResumeResponse.html deleted file mode 100644 index 881b982fc..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/GetResumeResponse.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - -GetResumeResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api.indexes
-

Class GetResumeResponse

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        GetResumeResponse

        -
        public GetResumeResponse()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/IndexDocumentRequest.html b/docs/com/textkernel/tx/models/api/indexes/IndexDocumentRequest.html deleted file mode 100644 index e21165781..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/IndexDocumentRequest.html +++ /dev/null @@ -1,283 +0,0 @@ - - - - - - -IndexDocumentRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.indexes
-

Class IndexDocumentRequest

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        UserDefinedTags

        -
        public List<String> UserDefinedTags
        -
        The user-defined tags the document should have
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        IndexDocumentRequest

        -
        public IndexDocumentRequest()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/IndexDocumentResponse.html b/docs/com/textkernel/tx/models/api/indexes/IndexDocumentResponse.html deleted file mode 100644 index ea9c18c50..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/IndexDocumentResponse.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - -IndexDocumentResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api.indexes
-

Class IndexDocumentResponse

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    ITxResponse
    -
    -
    -
    -
    public class IndexDocumentResponse
-extends ApiResponse<Object>
    -
    The response body from a IndexDocument API call
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        IndexDocumentResponse

        -
        public IndexDocumentResponse()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/IndexJobInfo.html b/docs/com/textkernel/tx/models/api/indexes/IndexJobInfo.html deleted file mode 100644 index 4fdc0563d..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/IndexJobInfo.html +++ /dev/null @@ -1,291 +0,0 @@ - - - - - - -IndexJobInfo (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.indexes
-

Class IndexJobInfo

-
-
- -
-
    -
  • -
    -
    -
    public class IndexJobInfo
-extends IndexMultipleDocumentInfo
    -
    Information for adding a single job to an index as part of a 'batch upload'
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        JobData

        -
        public ParsedJob JobData
        -
        A job to index
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        IndexJobInfo

        -
        public IndexJobInfo()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/IndexJobRequest.html b/docs/com/textkernel/tx/models/api/indexes/IndexJobRequest.html deleted file mode 100644 index 3c080bc0e..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/IndexJobRequest.html +++ /dev/null @@ -1,291 +0,0 @@ - - - - - - -IndexJobRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.indexes
-

Class IndexJobRequest

-
-
- -
-
    -
  • -
    -
    -
    public class IndexJobRequest
-extends IndexDocumentRequest
    -
    Request body for an 'index job' request
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        JobData

        -
        public ParsedJob JobData
        -
        A job to index
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        IndexJobRequest

        -
        public IndexJobRequest()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/IndexMultipleDocumentInfo.html b/docs/com/textkernel/tx/models/api/indexes/IndexMultipleDocumentInfo.html deleted file mode 100644 index 3a8f3d3d1..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/IndexMultipleDocumentInfo.html +++ /dev/null @@ -1,300 +0,0 @@ - - - - - - -IndexMultipleDocumentInfo (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.indexes
-

Class IndexMultipleDocumentInfo

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        DocumentId

        -
        public String DocumentId
        -
        The id to assign to the new document. This is restricted to alphanumeric with dashes and underscores. - All values will be converted to lower-case.
        -
        • -
      - - - -
        -
      • -

        UserDefinedTags

        -
        public List<String> UserDefinedTags
        -
        The user-defined tags the document should have
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        IndexMultipleDocumentInfo

        -
        public IndexMultipleDocumentInfo()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/IndexMultipleDocumentsResponse.html b/docs/com/textkernel/tx/models/api/indexes/IndexMultipleDocumentsResponse.html deleted file mode 100644 index 543126209..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/IndexMultipleDocumentsResponse.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - -IndexMultipleDocumentsResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api.indexes
-

Class IndexMultipleDocumentsResponse

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        IndexMultipleDocumentsResponse

        -
        public IndexMultipleDocumentsResponse()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/IndexMultipleDocumentsResponseValue.html b/docs/com/textkernel/tx/models/api/indexes/IndexMultipleDocumentsResponseValue.html deleted file mode 100644 index d2a446779..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/IndexMultipleDocumentsResponseValue.html +++ /dev/null @@ -1,298 +0,0 @@ - - - - - - -IndexMultipleDocumentsResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.indexes
-

Class IndexMultipleDocumentsResponseValue

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        DocumentId

        -
        public String DocumentId
        -
        Id of the specific document represented in the response
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        IndexMultipleDocumentsResponseValue

        -
        public IndexMultipleDocumentsResponseValue()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/IndexMultipleJobsRequest.html b/docs/com/textkernel/tx/models/api/indexes/IndexMultipleJobsRequest.html deleted file mode 100644 index f3275fb6a..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/IndexMultipleJobsRequest.html +++ /dev/null @@ -1,279 +0,0 @@ - - - - - - -IndexMultipleJobsRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.indexes
-

Class IndexMultipleJobsRequest

-
-
- -
-
    -
  • -
    -
    -
    public class IndexMultipleJobsRequest
-extends Object
    -
    Request body for an 'index multiple jobs' request
    -
    • -
-
-
- -
-
-
    -
  • - - - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        IndexMultipleJobsRequest

        -
        public IndexMultipleJobsRequest()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/IndexMultipleResumesRequest.html b/docs/com/textkernel/tx/models/api/indexes/IndexMultipleResumesRequest.html deleted file mode 100644 index 9822c56a2..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/IndexMultipleResumesRequest.html +++ /dev/null @@ -1,279 +0,0 @@ - - - - - - -IndexMultipleResumesRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.indexes
-

Class IndexMultipleResumesRequest

-
-
- -
-
    -
  • -
    -
    -
    public class IndexMultipleResumesRequest
-extends Object
    -
    Request body for an 'index multiple resumes' request
    -
    • -
-
-
- -
-
-
    -
  • - - - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        IndexMultipleResumesRequest

        -
        public IndexMultipleResumesRequest()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/IndexResumeInfo.html b/docs/com/textkernel/tx/models/api/indexes/IndexResumeInfo.html deleted file mode 100644 index b8d6088f5..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/IndexResumeInfo.html +++ /dev/null @@ -1,291 +0,0 @@ - - - - - - -IndexResumeInfo (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.indexes
-

Class IndexResumeInfo

-
-
- -
-
    -
  • -
    -
    -
    public class IndexResumeInfo
-extends IndexMultipleDocumentInfo
    -
    Information for adding a single resume to an index as part of a 'batch upload'
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        ResumeData

        -
        public ParsedResume ResumeData
        -
        A resume to index
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        IndexResumeInfo

        -
        public IndexResumeInfo()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/IndexResumeRequest.html b/docs/com/textkernel/tx/models/api/indexes/IndexResumeRequest.html deleted file mode 100644 index cd53bc4b8..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/IndexResumeRequest.html +++ /dev/null @@ -1,291 +0,0 @@ - - - - - - -IndexResumeRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.indexes
-

Class IndexResumeRequest

-
-
- -
-
    -
  • -
    -
    -
    public class IndexResumeRequest
-extends IndexDocumentRequest
    -
    Request body for an 'index resume' request
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        ResumeData

        -
        public ParsedResume ResumeData
        -
        A resume to index
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        IndexResumeRequest

        -
        public IndexResumeRequest()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/IndexSingleDocumentInfo.html b/docs/com/textkernel/tx/models/api/indexes/IndexSingleDocumentInfo.html deleted file mode 100644 index 32a958baa..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/IndexSingleDocumentInfo.html +++ /dev/null @@ -1,291 +0,0 @@ - - - - - - -IndexSingleDocumentInfo (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.indexes
-

Class IndexSingleDocumentInfo

-
-
- -
-
    -
  • -
    -
    -
    public class IndexSingleDocumentInfo
-extends IndexMultipleDocumentInfo
    -
    Information for adding a document to an index
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        IndexId

        -
        public String IndexId
        -
        The id for the index where the document should be added (case-insensitive).
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        IndexSingleDocumentInfo

        -
        public IndexSingleDocumentInfo()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/IndexedDocumentInfo.html b/docs/com/textkernel/tx/models/api/indexes/IndexedDocumentInfo.html deleted file mode 100644 index 4e853c197..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/IndexedDocumentInfo.html +++ /dev/null @@ -1,295 +0,0 @@ - - - - - - -IndexedDocumentInfo (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.indexes
-

Class IndexedDocumentInfo

-
-
- -
-
    -
  • -
    -
    -
    public class IndexedDocumentInfo
-extends Object
    -
    A small container for identifying an indexed document
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        IndexId

        -
        public String IndexId
        -
        The id for the index that contains the document (case-insensitive).
        -
        • -
      - - - -
        -
      • -

        DocumentId

        -
        public String DocumentId
        -
        The id of the document (case-insensitive)
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        IndexedDocumentInfo

        -
        public IndexedDocumentInfo()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/UpdateUserDefinedTagsRequest.html b/docs/com/textkernel/tx/models/api/indexes/UpdateUserDefinedTagsRequest.html deleted file mode 100644 index 1b34213a7..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/UpdateUserDefinedTagsRequest.html +++ /dev/null @@ -1,296 +0,0 @@ - - - - - - -UpdateUserDefinedTagsRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.indexes
-

Class UpdateUserDefinedTagsRequest

-
-
- -
-
    -
  • -
    -
    -
    public class UpdateUserDefinedTagsRequest
-extends Object
    -
    Request body to update (add/remove/overwrite) user-defined tags on an indexed - document
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        UserDefinedTags

        -
        public List<String> UserDefinedTags
        -
        The user-defined tags to add/delete/etc
        -
        • -
      - - - -
        -
      • -

        Method

        -
        public UserDefinedTagsMethod Method
        -
        Which method to use for the specified user-defined tags
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        UpdateUserDefinedTagsRequest

        -
        public UpdateUserDefinedTagsRequest()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/UpdateUserDefinedTagsResponse.html b/docs/com/textkernel/tx/models/api/indexes/UpdateUserDefinedTagsResponse.html deleted file mode 100644 index 5b4b5fcb9..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/UpdateUserDefinedTagsResponse.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - -UpdateUserDefinedTagsResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api.indexes
-

Class UpdateUserDefinedTagsResponse

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    ITxResponse
    -
    -
    -
    -
    public class UpdateUserDefinedTagsResponse
-extends ApiResponse<Object>
    -
    The response body from a UpdateUserDefinedTags API call
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        UpdateUserDefinedTagsResponse

        -
        public UpdateUserDefinedTagsResponse()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/UserDefinedTagsMethod.html b/docs/com/textkernel/tx/models/api/indexes/UserDefinedTagsMethod.html deleted file mode 100644 index 639ea031f..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/UserDefinedTagsMethod.html +++ /dev/null @@ -1,365 +0,0 @@ - - - - - - -UserDefinedTagsMethod (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.indexes
-

Enum UserDefinedTagsMethod

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Enum Constant Detail

      - - - -
        -
      • -

        Delete

        -
        public static final UserDefinedTagsMethod Delete
        -
        Deletes the specified user-defined tags from a document
        -
        • -
      - - - -
        -
      • -

        Add

        -
        public static final UserDefinedTagsMethod Add
        -
        Adds the specified user-defined tags to a document (in addition to any existing)
        -
        • -
      - - - -
        -
      • -

        Overwrite

        -
        public static final UserDefinedTagsMethod Overwrite
        -
        Overwrites any existing user-defined tags with the specified tags
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        values

        -
        public static UserDefinedTagsMethod[] values()
        -
        Returns an array containing the constants of this enum type, in -the order they are declared. This method may be used to iterate -over the constants as follows: -
        -for (UserDefinedTagsMethod c : UserDefinedTagsMethod.values())
-    System.out.println(c);
-
        -
        -
        Returns:
        -
        an array containing the constants of this enum type, in the order they are declared
        -
        -
        • -
      - - - -
        -
      • -

        valueOf

        -
        public static UserDefinedTagsMethod valueOf(String name)
        -
        Returns the enum constant of this type with the specified name. -The string must match exactly an identifier used to declare an -enum constant in this type. (Extraneous whitespace characters are -not permitted.)
        -
        -
        Parameters:
        -
        name - the name of the enum constant to be returned.
        -
        Returns:
        -
        the enum constant with the specified name
        -
        Throws:
        -
        IllegalArgumentException - if this enum type has no constant with the specified name
        -
        NullPointerException - if the argument is null
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/class-use/CreateIndexRequest.html b/docs/com/textkernel/tx/models/api/indexes/class-use/CreateIndexRequest.html deleted file mode 100644 index c333eae16..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/class-use/CreateIndexRequest.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.indexes.CreateIndexRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.indexes.CreateIndexRequest

-
-
No usage of com.textkernel.tx.models.api.indexes.CreateIndexRequest
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/class-use/CreateIndexResponse.html b/docs/com/textkernel/tx/models/api/indexes/class-use/CreateIndexResponse.html deleted file mode 100644 index 760b780e1..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/class-use/CreateIndexResponse.html +++ /dev/null @@ -1,169 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.indexes.CreateIndexResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.indexes.CreateIndexResponse

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/class-use/DeleteDocumentResponse.html b/docs/com/textkernel/tx/models/api/indexes/class-use/DeleteDocumentResponse.html deleted file mode 100644 index 39fa9e185..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/class-use/DeleteDocumentResponse.html +++ /dev/null @@ -1,169 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.indexes.DeleteDocumentResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.indexes.DeleteDocumentResponse

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/class-use/DeleteIndexResponse.html b/docs/com/textkernel/tx/models/api/indexes/class-use/DeleteIndexResponse.html deleted file mode 100644 index 89d159c62..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/class-use/DeleteIndexResponse.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.indexes.DeleteIndexResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.indexes.DeleteIndexResponse

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/class-use/DeleteMultipleDocumentsResponse.html b/docs/com/textkernel/tx/models/api/indexes/class-use/DeleteMultipleDocumentsResponse.html deleted file mode 100644 index 42ea5a041..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/class-use/DeleteMultipleDocumentsResponse.html +++ /dev/null @@ -1,169 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.indexes.DeleteMultipleDocumentsResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.indexes.DeleteMultipleDocumentsResponse

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/class-use/GetAllIndexesResponse.html b/docs/com/textkernel/tx/models/api/indexes/class-use/GetAllIndexesResponse.html deleted file mode 100644 index 6705477af..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/class-use/GetAllIndexesResponse.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.indexes.GetAllIndexesResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.indexes.GetAllIndexesResponse

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/class-use/GetIndexResponse.html b/docs/com/textkernel/tx/models/api/indexes/class-use/GetIndexResponse.html deleted file mode 100644 index 376f5c937..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/class-use/GetIndexResponse.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.indexes.GetIndexResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.indexes.GetIndexResponse

-
-
No usage of com.textkernel.tx.models.api.indexes.GetIndexResponse
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/class-use/GetJobResponse.html b/docs/com/textkernel/tx/models/api/indexes/class-use/GetJobResponse.html deleted file mode 100644 index df9c30e8c..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/class-use/GetJobResponse.html +++ /dev/null @@ -1,169 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.indexes.GetJobResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.indexes.GetJobResponse

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/class-use/GetResumeResponse.html b/docs/com/textkernel/tx/models/api/indexes/class-use/GetResumeResponse.html deleted file mode 100644 index 2e768b137..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/class-use/GetResumeResponse.html +++ /dev/null @@ -1,169 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.indexes.GetResumeResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.indexes.GetResumeResponse

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/class-use/IndexDocumentRequest.html b/docs/com/textkernel/tx/models/api/indexes/class-use/IndexDocumentRequest.html deleted file mode 100644 index 674bd0269..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/class-use/IndexDocumentRequest.html +++ /dev/null @@ -1,174 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.indexes.IndexDocumentRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.indexes.IndexDocumentRequest

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/class-use/IndexDocumentResponse.html b/docs/com/textkernel/tx/models/api/indexes/class-use/IndexDocumentResponse.html deleted file mode 100644 index 5e01a376a..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/class-use/IndexDocumentResponse.html +++ /dev/null @@ -1,180 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.indexes.IndexDocumentResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.indexes.IndexDocumentResponse

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/class-use/IndexJobInfo.html b/docs/com/textkernel/tx/models/api/indexes/class-use/IndexJobInfo.html deleted file mode 100644 index f4784b3b6..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/class-use/IndexJobInfo.html +++ /dev/null @@ -1,193 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.indexes.IndexJobInfo (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.indexes.IndexJobInfo

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/class-use/IndexJobRequest.html b/docs/com/textkernel/tx/models/api/indexes/class-use/IndexJobRequest.html deleted file mode 100644 index d8482de43..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/class-use/IndexJobRequest.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.indexes.IndexJobRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.indexes.IndexJobRequest

-
-
No usage of com.textkernel.tx.models.api.indexes.IndexJobRequest
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/class-use/IndexMultipleDocumentInfo.html b/docs/com/textkernel/tx/models/api/indexes/class-use/IndexMultipleDocumentInfo.html deleted file mode 100644 index 00d9186fb..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/class-use/IndexMultipleDocumentInfo.html +++ /dev/null @@ -1,180 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.indexes.IndexMultipleDocumentInfo (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.indexes.IndexMultipleDocumentInfo

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/class-use/IndexMultipleDocumentsResponse.html b/docs/com/textkernel/tx/models/api/indexes/class-use/IndexMultipleDocumentsResponse.html deleted file mode 100644 index 202add668..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/class-use/IndexMultipleDocumentsResponse.html +++ /dev/null @@ -1,176 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.indexes.IndexMultipleDocumentsResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.indexes.IndexMultipleDocumentsResponse

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/class-use/IndexMultipleDocumentsResponseValue.html b/docs/com/textkernel/tx/models/api/indexes/class-use/IndexMultipleDocumentsResponseValue.html deleted file mode 100644 index 97635e81f..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/class-use/IndexMultipleDocumentsResponseValue.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.indexes.IndexMultipleDocumentsResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.indexes.IndexMultipleDocumentsResponseValue

-
-
No usage of com.textkernel.tx.models.api.indexes.IndexMultipleDocumentsResponseValue
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/class-use/IndexMultipleJobsRequest.html b/docs/com/textkernel/tx/models/api/indexes/class-use/IndexMultipleJobsRequest.html deleted file mode 100644 index c3458bca1..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/class-use/IndexMultipleJobsRequest.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.indexes.IndexMultipleJobsRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.indexes.IndexMultipleJobsRequest

-
-
No usage of com.textkernel.tx.models.api.indexes.IndexMultipleJobsRequest
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/class-use/IndexMultipleResumesRequest.html b/docs/com/textkernel/tx/models/api/indexes/class-use/IndexMultipleResumesRequest.html deleted file mode 100644 index 0830f9bce..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/class-use/IndexMultipleResumesRequest.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.indexes.IndexMultipleResumesRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.indexes.IndexMultipleResumesRequest

-
-
No usage of com.textkernel.tx.models.api.indexes.IndexMultipleResumesRequest
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/class-use/IndexResumeInfo.html b/docs/com/textkernel/tx/models/api/indexes/class-use/IndexResumeInfo.html deleted file mode 100644 index ad1c58b90..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/class-use/IndexResumeInfo.html +++ /dev/null @@ -1,193 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.indexes.IndexResumeInfo (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.indexes.IndexResumeInfo

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/class-use/IndexResumeRequest.html b/docs/com/textkernel/tx/models/api/indexes/class-use/IndexResumeRequest.html deleted file mode 100644 index 5c7a0f34a..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/class-use/IndexResumeRequest.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.indexes.IndexResumeRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.indexes.IndexResumeRequest

-
-
No usage of com.textkernel.tx.models.api.indexes.IndexResumeRequest
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/class-use/IndexSingleDocumentInfo.html b/docs/com/textkernel/tx/models/api/indexes/class-use/IndexSingleDocumentInfo.html deleted file mode 100644 index 18368180d..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/class-use/IndexSingleDocumentInfo.html +++ /dev/null @@ -1,270 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.indexes.IndexSingleDocumentInfo (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.indexes.IndexSingleDocumentInfo

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/class-use/IndexedDocumentInfo.html b/docs/com/textkernel/tx/models/api/indexes/class-use/IndexedDocumentInfo.html deleted file mode 100644 index b5483ddb4..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/class-use/IndexedDocumentInfo.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.indexes.IndexedDocumentInfo (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.indexes.IndexedDocumentInfo

-
-
No usage of com.textkernel.tx.models.api.indexes.IndexedDocumentInfo
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/class-use/UpdateUserDefinedTagsRequest.html b/docs/com/textkernel/tx/models/api/indexes/class-use/UpdateUserDefinedTagsRequest.html deleted file mode 100644 index e8866f79f..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/class-use/UpdateUserDefinedTagsRequest.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.indexes.UpdateUserDefinedTagsRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.indexes.UpdateUserDefinedTagsRequest

-
-
No usage of com.textkernel.tx.models.api.indexes.UpdateUserDefinedTagsRequest
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/class-use/UpdateUserDefinedTagsResponse.html b/docs/com/textkernel/tx/models/api/indexes/class-use/UpdateUserDefinedTagsResponse.html deleted file mode 100644 index 6a33d77d8..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/class-use/UpdateUserDefinedTagsResponse.html +++ /dev/null @@ -1,180 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.indexes.UpdateUserDefinedTagsResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.indexes.UpdateUserDefinedTagsResponse

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/class-use/UserDefinedTagsMethod.html b/docs/com/textkernel/tx/models/api/indexes/class-use/UserDefinedTagsMethod.html deleted file mode 100644 index 50af5a23e..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/class-use/UserDefinedTagsMethod.html +++ /dev/null @@ -1,226 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.indexes.UserDefinedTagsMethod (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.indexes.UserDefinedTagsMethod

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/package-frame.html b/docs/com/textkernel/tx/models/api/indexes/package-frame.html deleted file mode 100644 index 0e342e7be..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/package-frame.html +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.indexes (Textkernel Tx Java SDK 2.3.3 API) - - - - - -

com.textkernel.tx.models.api.indexes

-
-

Classes

- -

Enums

- -
- - diff --git a/docs/com/textkernel/tx/models/api/indexes/package-summary.html b/docs/com/textkernel/tx/models/api/indexes/package-summary.html deleted file mode 100644 index 5477765da..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/package-summary.html +++ /dev/null @@ -1,302 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.indexes (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package com.textkernel.tx.models.api.indexes

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/package-tree.html b/docs/com/textkernel/tx/models/api/indexes/package-tree.html deleted file mode 100644 index 20cfd628c..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/package-tree.html +++ /dev/null @@ -1,188 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.indexes Class Hierarchy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package com.textkernel.tx.models.api.indexes

-Package Hierarchies: - -
-
-

Class Hierarchy

- -

Enum Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/indexes/package-use.html b/docs/com/textkernel/tx/models/api/indexes/package-use.html deleted file mode 100644 index fadd4a0aa..000000000 --- a/docs/com/textkernel/tx/models/api/indexes/package-use.html +++ /dev/null @@ -1,309 +0,0 @@ - - - - - - -Uses of Package com.textkernel.tx.models.api.indexes (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Package
com.textkernel.tx.models.api.indexes

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/jobdescription/GenerateJobRequest.html b/docs/com/textkernel/tx/models/api/jobdescription/GenerateJobRequest.html deleted file mode 100644 index db0e1fcb7..000000000 --- a/docs/com/textkernel/tx/models/api/jobdescription/GenerateJobRequest.html +++ /dev/null @@ -1,358 +0,0 @@ - - - - - - -GenerateJobRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.jobdescription
-

Class GenerateJobRequest

-
-
- -
-
    -
  • -
    -
    -
    public class GenerateJobRequest
-extends Object
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        JobTitle

        -
        public String JobTitle
        -
        The title of the job.
        -
        • -
      - - - - - - - -
        -
      • -

        Tone

        -
        public JobTone Tone
        -
        The tone of the job description.
        -
        • -
      - - - -
        -
      • -

        Language

        -
        public String Language
        -
        Language of the job description, in ISO 639-1 code format.
        -
        • -
      - - - -
        -
      • -

        Location

        -
        public String Location
        -
        Location of the job.
        -
        • -
      - - - -
        -
      • -

        Organization

        -
        public String Organization
        -
        The organization offering the job.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        GenerateJobRequest

        -
        public GenerateJobRequest()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/jobdescription/GenerateJobResponse.html b/docs/com/textkernel/tx/models/api/jobdescription/GenerateJobResponse.html deleted file mode 100644 index a207889c7..000000000 --- a/docs/com/textkernel/tx/models/api/jobdescription/GenerateJobResponse.html +++ /dev/null @@ -1,270 +0,0 @@ - - - - - - -GenerateJobResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api.jobdescription
-

Class GenerateJobResponse

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        GenerateJobResponse

        -
        public GenerateJobResponse()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/jobdescription/GenerateJobResponseValue.html b/docs/com/textkernel/tx/models/api/jobdescription/GenerateJobResponseValue.html deleted file mode 100644 index fd75c6465..000000000 --- a/docs/com/textkernel/tx/models/api/jobdescription/GenerateJobResponseValue.html +++ /dev/null @@ -1,279 +0,0 @@ - - - - - - -GenerateJobResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.jobdescription
-

Class GenerateJobResponseValue

-
-
- -
-
    -
  • -
    -
    -
    public class GenerateJobResponseValue
-extends Object
    -
    The ApiResponse.Value from a 'Generate Job' response
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        JobDescription

        -
        public String JobDescription
        -
        The generated job description
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        GenerateJobResponseValue

        -
        public GenerateJobResponseValue()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/jobdescription/GenerateJobSkill.html b/docs/com/textkernel/tx/models/api/jobdescription/GenerateJobSkill.html deleted file mode 100644 index 8a9d2e8cd..000000000 --- a/docs/com/textkernel/tx/models/api/jobdescription/GenerateJobSkill.html +++ /dev/null @@ -1,294 +0,0 @@ - - - - - - -GenerateJobSkill (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.jobdescription
-

Class GenerateJobSkill

-
-
- -
-
    -
  • -
    -
    -
    public class GenerateJobSkill
-extends Object
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Name

        -
        public String Name
        -
        The name of the skill
        -
        • -
      - - - -
        -
      • -

        Priority

        -
        public SkillPriority Priority
        -
        Priority of the skill
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        GenerateJobSkill

        -
        public GenerateJobSkill()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/jobdescription/JobTone.html b/docs/com/textkernel/tx/models/api/jobdescription/JobTone.html deleted file mode 100644 index c4de86648..000000000 --- a/docs/com/textkernel/tx/models/api/jobdescription/JobTone.html +++ /dev/null @@ -1,365 +0,0 @@ - - - - - - -JobTone (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.jobdescription
-

Enum JobTone

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Enum Constant Detail

      - - - -
        -
      • -

        Professional

        -
        public static final JobTone Professional
        -
        A professional tone (typical)
        -
        • -
      - - - -
        -
      • -

        Casual

        -
        public static final JobTone Casual
        -
        A casual tone
        -
        • -
      - - - -
        -
      • -

        Funny

        -
        public static final JobTone Funny
        -
        A funny tone
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        values

        -
        public static JobTone[] values()
        -
        Returns an array containing the constants of this enum type, in -the order they are declared. This method may be used to iterate -over the constants as follows: -
        -for (JobTone c : JobTone.values())
-    System.out.println(c);
-
        -
        -
        Returns:
        -
        an array containing the constants of this enum type, in the order they are declared
        -
        -
        • -
      - - - -
        -
      • -

        valueOf

        -
        public static JobTone valueOf(String name)
        -
        Returns the enum constant of this type with the specified name. -The string must match exactly an identifier used to declare an -enum constant in this type. (Extraneous whitespace characters are -not permitted.)
        -
        -
        Parameters:
        -
        name - the name of the enum constant to be returned.
        -
        Returns:
        -
        the enum constant with the specified name
        -
        Throws:
        -
        IllegalArgumentException - if this enum type has no constant with the specified name
        -
        NullPointerException - if the argument is null
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/jobdescription/SkillPriority.html b/docs/com/textkernel/tx/models/api/jobdescription/SkillPriority.html deleted file mode 100644 index 9fc336e13..000000000 --- a/docs/com/textkernel/tx/models/api/jobdescription/SkillPriority.html +++ /dev/null @@ -1,350 +0,0 @@ - - - - - - -SkillPriority (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.jobdescription
-

Enum SkillPriority

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Enum Constant Detail

      - - - -
        -
      • -

        NiceToHave

        -
        public static final SkillPriority NiceToHave
        -
        Skill is not required
        -
        • -
      - - - -
        -
      • -

        MustHave

        -
        public static final SkillPriority MustHave
        -
        Skill is required
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        values

        -
        public static SkillPriority[] values()
        -
        Returns an array containing the constants of this enum type, in -the order they are declared. This method may be used to iterate -over the constants as follows: -
        -for (SkillPriority c : SkillPriority.values())
-    System.out.println(c);
-
        -
        -
        Returns:
        -
        an array containing the constants of this enum type, in the order they are declared
        -
        -
        • -
      - - - -
        -
      • -

        valueOf

        -
        public static SkillPriority valueOf(String name)
        -
        Returns the enum constant of this type with the specified name. -The string must match exactly an identifier used to declare an -enum constant in this type. (Extraneous whitespace characters are -not permitted.)
        -
        -
        Parameters:
        -
        name - the name of the enum constant to be returned.
        -
        Returns:
        -
        the enum constant with the specified name
        -
        Throws:
        -
        IllegalArgumentException - if this enum type has no constant with the specified name
        -
        NullPointerException - if the argument is null
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/jobdescription/SuggestSkillsFromJobTitleRequest.html b/docs/com/textkernel/tx/models/api/jobdescription/SuggestSkillsFromJobTitleRequest.html deleted file mode 100644 index 03d757b74..000000000 --- a/docs/com/textkernel/tx/models/api/jobdescription/SuggestSkillsFromJobTitleRequest.html +++ /dev/null @@ -1,311 +0,0 @@ - - - - - - -SuggestSkillsFromJobTitleRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.jobdescription
-

Class SuggestSkillsFromJobTitleRequest

-
-
- -
-
    -
  • -
    -
    -
    public class SuggestSkillsFromJobTitleRequest
-extends Object
    -
    Request body for 'Suggest Skills for Job Title' request
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        JobTitle

        -
        public String JobTitle
        -
        The title of the job for which skills are being suggested.
        -
        • -
      - - - -
        -
      • -

        Language

        -
        public String Language
        -
        Language of the suggested skills in ISO 639-1 code format.
        -
        • -
      - - - -
        -
      • -

        Limit

        -
        public Integer Limit
        -
        Maximum number of skills to suggest. Must be within [1 - 50]. Default is 10.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        SuggestSkillsFromJobTitleRequest

        -
        public SuggestSkillsFromJobTitleRequest()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/jobdescription/SuggestSkillsFromJobTitleResponse.html b/docs/com/textkernel/tx/models/api/jobdescription/SuggestSkillsFromJobTitleResponse.html deleted file mode 100644 index 792516482..000000000 --- a/docs/com/textkernel/tx/models/api/jobdescription/SuggestSkillsFromJobTitleResponse.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - -SuggestSkillsFromJobTitleResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api.jobdescription
-

Class SuggestSkillsFromJobTitleResponse

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        SuggestSkillsFromJobTitleResponse

        -
        public SuggestSkillsFromJobTitleResponse()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/jobdescription/SuggestSkillsFromJobTitleResponseValue.html b/docs/com/textkernel/tx/models/api/jobdescription/SuggestSkillsFromJobTitleResponseValue.html deleted file mode 100644 index 339dd6888..000000000 --- a/docs/com/textkernel/tx/models/api/jobdescription/SuggestSkillsFromJobTitleResponseValue.html +++ /dev/null @@ -1,279 +0,0 @@ - - - - - - -SuggestSkillsFromJobTitleResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.jobdescription
-

Class SuggestSkillsFromJobTitleResponseValue

-
-
- -
-
    -
  • -
    -
    -
    public class SuggestSkillsFromJobTitleResponseValue
-extends Object
    -
    The ApiResponse.Value from a 'Suggest Skills from Job Title' response
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        SuggestedSkills

        -
        public List<String> SuggestedSkills
        -
        List of skills suggested for the job title.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        SuggestSkillsFromJobTitleResponseValue

        -
        public SuggestSkillsFromJobTitleResponseValue()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/jobdescription/class-use/GenerateJobRequest.html b/docs/com/textkernel/tx/models/api/jobdescription/class-use/GenerateJobRequest.html deleted file mode 100644 index 5ff01ce97..000000000 --- a/docs/com/textkernel/tx/models/api/jobdescription/class-use/GenerateJobRequest.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.jobdescription.GenerateJobRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.jobdescription.GenerateJobRequest

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/jobdescription/class-use/GenerateJobResponse.html b/docs/com/textkernel/tx/models/api/jobdescription/class-use/GenerateJobResponse.html deleted file mode 100644 index 674eac0b0..000000000 --- a/docs/com/textkernel/tx/models/api/jobdescription/class-use/GenerateJobResponse.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.jobdescription.GenerateJobResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.jobdescription.GenerateJobResponse

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/jobdescription/class-use/GenerateJobResponseValue.html b/docs/com/textkernel/tx/models/api/jobdescription/class-use/GenerateJobResponseValue.html deleted file mode 100644 index a67359633..000000000 --- a/docs/com/textkernel/tx/models/api/jobdescription/class-use/GenerateJobResponseValue.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.jobdescription.GenerateJobResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.jobdescription.GenerateJobResponseValue

-
-
No usage of com.textkernel.tx.models.api.jobdescription.GenerateJobResponseValue
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/jobdescription/class-use/GenerateJobSkill.html b/docs/com/textkernel/tx/models/api/jobdescription/class-use/GenerateJobSkill.html deleted file mode 100644 index a26851081..000000000 --- a/docs/com/textkernel/tx/models/api/jobdescription/class-use/GenerateJobSkill.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.jobdescription.GenerateJobSkill (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.jobdescription.GenerateJobSkill

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/jobdescription/class-use/JobTone.html b/docs/com/textkernel/tx/models/api/jobdescription/class-use/JobTone.html deleted file mode 100644 index b5ace57f9..000000000 --- a/docs/com/textkernel/tx/models/api/jobdescription/class-use/JobTone.html +++ /dev/null @@ -1,190 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.jobdescription.JobTone (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.jobdescription.JobTone

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/jobdescription/class-use/SkillPriority.html b/docs/com/textkernel/tx/models/api/jobdescription/class-use/SkillPriority.html deleted file mode 100644 index d170402a2..000000000 --- a/docs/com/textkernel/tx/models/api/jobdescription/class-use/SkillPriority.html +++ /dev/null @@ -1,190 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.jobdescription.SkillPriority (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.jobdescription.SkillPriority

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/jobdescription/class-use/SuggestSkillsFromJobTitleRequest.html b/docs/com/textkernel/tx/models/api/jobdescription/class-use/SuggestSkillsFromJobTitleRequest.html deleted file mode 100644 index c93e572ef..000000000 --- a/docs/com/textkernel/tx/models/api/jobdescription/class-use/SuggestSkillsFromJobTitleRequest.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.jobdescription.SuggestSkillsFromJobTitleRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.jobdescription.SuggestSkillsFromJobTitleRequest

-
-
No usage of com.textkernel.tx.models.api.jobdescription.SuggestSkillsFromJobTitleRequest
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/jobdescription/class-use/SuggestSkillsFromJobTitleResponse.html b/docs/com/textkernel/tx/models/api/jobdescription/class-use/SuggestSkillsFromJobTitleResponse.html deleted file mode 100644 index 83ee5ea78..000000000 --- a/docs/com/textkernel/tx/models/api/jobdescription/class-use/SuggestSkillsFromJobTitleResponse.html +++ /dev/null @@ -1,176 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.jobdescription.SuggestSkillsFromJobTitleResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.jobdescription.SuggestSkillsFromJobTitleResponse

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/jobdescription/class-use/SuggestSkillsFromJobTitleResponseValue.html b/docs/com/textkernel/tx/models/api/jobdescription/class-use/SuggestSkillsFromJobTitleResponseValue.html deleted file mode 100644 index f1c91d38c..000000000 --- a/docs/com/textkernel/tx/models/api/jobdescription/class-use/SuggestSkillsFromJobTitleResponseValue.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.jobdescription.SuggestSkillsFromJobTitleResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.jobdescription.SuggestSkillsFromJobTitleResponseValue

-
-
No usage of com.textkernel.tx.models.api.jobdescription.SuggestSkillsFromJobTitleResponseValue
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/jobdescription/package-frame.html b/docs/com/textkernel/tx/models/api/jobdescription/package-frame.html deleted file mode 100644 index 4a9d665f4..000000000 --- a/docs/com/textkernel/tx/models/api/jobdescription/package-frame.html +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.jobdescription (Textkernel Tx Java SDK 2.3.3 API) - - - - - -

com.textkernel.tx.models.api.jobdescription

-
-

Classes

- -

Enums

- -
- - diff --git a/docs/com/textkernel/tx/models/api/jobdescription/package-summary.html b/docs/com/textkernel/tx/models/api/jobdescription/package-summary.html deleted file mode 100644 index c14328fc8..000000000 --- a/docs/com/textkernel/tx/models/api/jobdescription/package-summary.html +++ /dev/null @@ -1,199 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.jobdescription (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package com.textkernel.tx.models.api.jobdescription

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/jobdescription/package-tree.html b/docs/com/textkernel/tx/models/api/jobdescription/package-tree.html deleted file mode 100644 index b5f29e0ab..000000000 --- a/docs/com/textkernel/tx/models/api/jobdescription/package-tree.html +++ /dev/null @@ -1,162 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.jobdescription Class Hierarchy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package com.textkernel.tx.models.api.jobdescription

-Package Hierarchies: - -
-
-

Class Hierarchy

- -

Enum Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/jobdescription/package-use.html b/docs/com/textkernel/tx/models/api/jobdescription/package-use.html deleted file mode 100644 index 64a5d0afa..000000000 --- a/docs/com/textkernel/tx/models/api/jobdescription/package-use.html +++ /dev/null @@ -1,196 +0,0 @@ - - - - - - -Uses of Package com.textkernel.tx.models.api.jobdescription (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Package
com.textkernel.tx.models.api.jobdescription

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/BaseScoredResponseValue.html b/docs/com/textkernel/tx/models/api/matching/BaseScoredResponseValue.html deleted file mode 100644 index 42d080f1d..000000000 --- a/docs/com/textkernel/tx/models/api/matching/BaseScoredResponseValue.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - - -BaseScoredResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.matching
-

Class BaseScoredResponseValue<T>

-
-
- -
- -
-
- -
-
- -
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/BaseSearchMatchResponseValue.html b/docs/com/textkernel/tx/models/api/matching/BaseSearchMatchResponseValue.html deleted file mode 100644 index 4daa1b0b1..000000000 --- a/docs/com/textkernel/tx/models/api/matching/BaseSearchMatchResponseValue.html +++ /dev/null @@ -1,315 +0,0 @@ - - - - - - -BaseSearchMatchResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.matching
-

Class BaseSearchMatchResponseValue<T>

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Matches

        -
        public List<T> Matches
        -
        The list of matches for the search/match
        -
        • -
      - - - -
        -
      • -

        CurrentCount

        -
        public int CurrentCount
        -
        The number of results returned in this response
        -
        • -
      - - - -
        -
      • -

        TotalCount

        -
        public int TotalCount
        -
        The total number of results that fit the query/criteria
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        BaseSearchMatchResponseValue

        -
        public BaseSearchMatchResponseValue()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/CategoryWeights.html b/docs/com/textkernel/tx/models/api/matching/CategoryWeights.html deleted file mode 100644 index c137b9647..000000000 --- a/docs/com/textkernel/tx/models/api/matching/CategoryWeights.html +++ /dev/null @@ -1,519 +0,0 @@ - - - - - - -CategoryWeights (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.matching
-

Class CategoryWeights

-
-
- -
-
    -
  • -
    -
    -
    public class CategoryWeights
-extends Object
    -
    Weights for each category used in matching/scoring
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Field Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      Fields 
      Modifier and TypeField and Description
      doubleCertifications -
      The weight of the Certifications category relative to other categories.
      -
      booleanCertificationsHasData -
      If false, the Certifications category has no data and should be ignored/hidden.
      -
      doubleEducation -
      The weight of the Education category relative to other categories.
      -
      booleanEducationHasData -
      If false, the Education category has no data and should be ignored/hidden.
      -
      doubleExecutiveType -
      The weight of the ExecutiveType category relative to other categories.
      -
      booleanExecutiveTypeHasData -
      If false, the ExecutiveType category has no data and should be ignored/hidden.
      -
      doubleIndustries -
      The weight of the Industries/Taxonomies category relative to other categories.
      -
      booleanIndustriesHasData -
      If false, the Industries/Taxonomies category has no data and should be ignored/hidden.
      -
      doubleJobTitles -
      The weight of the JobTitles category relative to other categories.
      -
      booleanJobTitlesHasData -
      If false, the JobTitles category has no data and should be ignored/hidden.
      -
      doubleLanguages -
      The weight of the Languages category relative to other categories.
      -
      booleanLanguagesHasData -
      If false, the Languages category has no data and should be ignored/hidden.
      -
      doubleManagementLevel -
      The weight of the ManagementLevel category relative to other categories.
      -
      booleanManagementLevelHasData -
      If false, the ManagementLevel category has no data and should be ignored/hidden.
      -
      doubleSkills -
      The weight of the Skills category relative to other categories.
      -
      booleanSkillsHasData -
      If false, the Skills category has no data and should be ignored/hidden.
      -
      -
      • -
    - -
      -
    • - - -

      Constructor Summary

      - - - - - - - - -
      Constructors 
      Constructor and Description
      CategoryWeights() 
      -
      • -
    - - -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Education

        -
        public double Education
        -
        The weight of the Education category relative to other categories.
        -
        • -
      - - - -
        -
      • -

        JobTitles

        -
        public double JobTitles
        -
        The weight of the JobTitles category relative to other categories.
        -
        • -
      - - - -
        -
      • -

        Skills

        -
        public double Skills
        -
        The weight of the Skills category relative to other categories.
        -
        • -
      - - - -
        -
      • -

        Industries

        -
        public double Industries
        -
        The weight of the Industries/Taxonomies category relative to other categories.
        -
        • -
      - - - -
        -
      • -

        Languages

        -
        public double Languages
        -
        The weight of the Languages category relative to other categories.
        -
        • -
      - - - -
        -
      • -

        Certifications

        -
        public double Certifications
        -
        The weight of the Certifications category relative to other categories.
        -
        • -
      - - - -
        -
      • -

        ExecutiveType

        -
        public double ExecutiveType
        -
        The weight of the ExecutiveType category relative to other categories.
        -
        • -
      - - - -
        -
      • -

        ManagementLevel

        -
        public double ManagementLevel
        -
        The weight of the ManagementLevel category relative to other categories.
        -
        • -
      - - - -
        -
      • -

        EducationHasData

        -
        public boolean EducationHasData
        -
        If false, the Education category has no data and should be ignored/hidden.
        -
        • -
      - - - -
        -
      • -

        JobTitlesHasData

        -
        public boolean JobTitlesHasData
        -
        If false, the JobTitles category has no data and should be ignored/hidden.
        -
        • -
      - - - -
        -
      • -

        SkillsHasData

        -
        public boolean SkillsHasData
        -
        If false, the Skills category has no data and should be ignored/hidden.
        -
        • -
      - - - -
        -
      • -

        IndustriesHasData

        -
        public boolean IndustriesHasData
        -
        If false, the Industries/Taxonomies category has no data and should be ignored/hidden.
        -
        • -
      - - - -
        -
      • -

        LanguagesHasData

        -
        public boolean LanguagesHasData
        -
        If false, the Languages category has no data and should be ignored/hidden.
        -
        • -
      - - - -
        -
      • -

        CertificationsHasData

        -
        public boolean CertificationsHasData
        -
        If false, the Certifications category has no data and should be ignored/hidden.
        -
        • -
      - - - -
        -
      • -

        ExecutiveTypeHasData

        -
        public boolean ExecutiveTypeHasData
        -
        If false, the ExecutiveType category has no data and should be ignored/hidden.
        -
        • -
      - - - -
        -
      • -

        ManagementLevelHasData

        -
        public boolean ManagementLevelHasData
        -
        If false, the ManagementLevel category has no data and should be ignored/hidden.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        CategoryWeights

        -
        public CategoryWeights()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/MatchJobRequest.html b/docs/com/textkernel/tx/models/api/matching/MatchJobRequest.html deleted file mode 100644 index f595485d9..000000000 --- a/docs/com/textkernel/tx/models/api/matching/MatchJobRequest.html +++ /dev/null @@ -1,303 +0,0 @@ - - - - - - -MatchJobRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.matching
-

Class MatchJobRequest

-
-
- -
-
    -
  • -
    -
    -
    public class MatchJobRequest
-extends MatchRequest
    -
    Request body for a Match request
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        JobData

        -
        public ParsedJob JobData
        -
        The job to match. This should be generated by parsing a job with the Job Parser.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        MatchJobRequest

        -
        public MatchJobRequest()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/MatchResponse.html b/docs/com/textkernel/tx/models/api/matching/MatchResponse.html deleted file mode 100644 index 993a022c6..000000000 --- a/docs/com/textkernel/tx/models/api/matching/MatchResponse.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - -MatchResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api.matching
-

Class MatchResponse

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        MatchResponse

        -
        public MatchResponse()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/MatchResponseValue.html b/docs/com/textkernel/tx/models/api/matching/MatchResponseValue.html deleted file mode 100644 index 2aed665f7..000000000 --- a/docs/com/textkernel/tx/models/api/matching/MatchResponseValue.html +++ /dev/null @@ -1,272 +0,0 @@ - - - - - - -MatchResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api.matching
-

Class MatchResponseValue

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        MatchResponseValue

        -
        public MatchResponseValue()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/MatchResumeRequest.html b/docs/com/textkernel/tx/models/api/matching/MatchResumeRequest.html deleted file mode 100644 index b8526164a..000000000 --- a/docs/com/textkernel/tx/models/api/matching/MatchResumeRequest.html +++ /dev/null @@ -1,303 +0,0 @@ - - - - - - -MatchResumeRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.matching
-

Class MatchResumeRequest

-
-
- -
-
    -
  • -
    -
    -
    public class MatchResumeRequest
-extends MatchRequest
    -
    Request body for a Match request
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        ResumeData

        -
        public ParsedResume ResumeData
        -
        The resume to match. This should be generated by parsing a resume with the Resume Parser.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        MatchResumeRequest

        -
        public MatchResumeRequest()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/SearchRequest.html b/docs/com/textkernel/tx/models/api/matching/SearchRequest.html deleted file mode 100644 index ff4ef2b45..000000000 --- a/docs/com/textkernel/tx/models/api/matching/SearchRequest.html +++ /dev/null @@ -1,291 +0,0 @@ - - - - - - -SearchRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.matching
-

Class SearchRequest

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        PaginationSettings

        -
        public PaginationSettings PaginationSettings
        -
        Used to choose which results to return from the list.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        SearchRequest

        -
        public SearchRequest()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/SearchResponse.html b/docs/com/textkernel/tx/models/api/matching/SearchResponse.html deleted file mode 100644 index 372eb7e69..000000000 --- a/docs/com/textkernel/tx/models/api/matching/SearchResponse.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - -SearchResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api.matching
-

Class SearchResponse

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        SearchResponse

        -
        public SearchResponse()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/SearchResponseValue.html b/docs/com/textkernel/tx/models/api/matching/SearchResponseValue.html deleted file mode 100644 index 7a7e7e55f..000000000 --- a/docs/com/textkernel/tx/models/api/matching/SearchResponseValue.html +++ /dev/null @@ -1,260 +0,0 @@ - - - - - - -SearchResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api.matching
-

Class SearchResponseValue

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        SearchResponseValue

        -
        public SearchResponseValue()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/class-use/BaseScoredResponseValue.html b/docs/com/textkernel/tx/models/api/matching/class-use/BaseScoredResponseValue.html deleted file mode 100644 index a06683bca..000000000 --- a/docs/com/textkernel/tx/models/api/matching/class-use/BaseScoredResponseValue.html +++ /dev/null @@ -1,192 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.BaseScoredResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.BaseScoredResponseValue

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/class-use/BaseSearchMatchResponseValue.html b/docs/com/textkernel/tx/models/api/matching/class-use/BaseSearchMatchResponseValue.html deleted file mode 100644 index 319ff8e2d..000000000 --- a/docs/com/textkernel/tx/models/api/matching/class-use/BaseSearchMatchResponseValue.html +++ /dev/null @@ -1,204 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.BaseSearchMatchResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.BaseSearchMatchResponseValue

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/class-use/CategoryWeights.html b/docs/com/textkernel/tx/models/api/matching/class-use/CategoryWeights.html deleted file mode 100644 index 1141c31c7..000000000 --- a/docs/com/textkernel/tx/models/api/matching/class-use/CategoryWeights.html +++ /dev/null @@ -1,344 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.CategoryWeights (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.CategoryWeights

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/class-use/MatchJobRequest.html b/docs/com/textkernel/tx/models/api/matching/class-use/MatchJobRequest.html deleted file mode 100644 index c5cd0768b..000000000 --- a/docs/com/textkernel/tx/models/api/matching/class-use/MatchJobRequest.html +++ /dev/null @@ -1,165 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.MatchJobRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.MatchJobRequest

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/class-use/MatchResponse.html b/docs/com/textkernel/tx/models/api/matching/class-use/MatchResponse.html deleted file mode 100644 index b7a1a2b7b..000000000 --- a/docs/com/textkernel/tx/models/api/matching/class-use/MatchResponse.html +++ /dev/null @@ -1,196 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.MatchResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.MatchResponse

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/class-use/MatchResponseValue.html b/docs/com/textkernel/tx/models/api/matching/class-use/MatchResponseValue.html deleted file mode 100644 index 0dfd4a86f..000000000 --- a/docs/com/textkernel/tx/models/api/matching/class-use/MatchResponseValue.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.MatchResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.MatchResponseValue

-
-
No usage of com.textkernel.tx.models.api.matching.MatchResponseValue
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/class-use/MatchResumeRequest.html b/docs/com/textkernel/tx/models/api/matching/class-use/MatchResumeRequest.html deleted file mode 100644 index dd25839b2..000000000 --- a/docs/com/textkernel/tx/models/api/matching/class-use/MatchResumeRequest.html +++ /dev/null @@ -1,165 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.MatchResumeRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.MatchResumeRequest

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/class-use/SearchRequest.html b/docs/com/textkernel/tx/models/api/matching/class-use/SearchRequest.html deleted file mode 100644 index 3474cbb69..000000000 --- a/docs/com/textkernel/tx/models/api/matching/class-use/SearchRequest.html +++ /dev/null @@ -1,165 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.SearchRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.SearchRequest

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/class-use/SearchResponse.html b/docs/com/textkernel/tx/models/api/matching/class-use/SearchResponse.html deleted file mode 100644 index 13ac9c448..000000000 --- a/docs/com/textkernel/tx/models/api/matching/class-use/SearchResponse.html +++ /dev/null @@ -1,171 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.SearchResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.SearchResponse

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/class-use/SearchResponseValue.html b/docs/com/textkernel/tx/models/api/matching/class-use/SearchResponseValue.html deleted file mode 100644 index 9ef89c8de..000000000 --- a/docs/com/textkernel/tx/models/api/matching/class-use/SearchResponseValue.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.SearchResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.SearchResponseValue

-
-
No usage of com.textkernel.tx.models.api.matching.SearchResponseValue
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/package-frame.html b/docs/com/textkernel/tx/models/api/matching/package-frame.html deleted file mode 100644 index 429be8a73..000000000 --- a/docs/com/textkernel/tx/models/api/matching/package-frame.html +++ /dev/null @@ -1,30 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.matching (Textkernel Tx Java SDK 2.3.3 API) - - - - - -

com.textkernel.tx.models.api.matching

-
-

Classes

- -
- - diff --git a/docs/com/textkernel/tx/models/api/matching/package-summary.html b/docs/com/textkernel/tx/models/api/matching/package-summary.html deleted file mode 100644 index 7d8f45499..000000000 --- a/docs/com/textkernel/tx/models/api/matching/package-summary.html +++ /dev/null @@ -1,200 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.matching (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package com.textkernel.tx.models.api.matching

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/package-tree.html b/docs/com/textkernel/tx/models/api/matching/package-tree.html deleted file mode 100644 index d5e414aee..000000000 --- a/docs/com/textkernel/tx/models/api/matching/package-tree.html +++ /dev/null @@ -1,166 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.matching Class Hierarchy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package com.textkernel.tx.models.api.matching

-Package Hierarchies: - -
-
-

Class Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/package-use.html b/docs/com/textkernel/tx/models/api/matching/package-use.html deleted file mode 100644 index d5ba05063..000000000 --- a/docs/com/textkernel/tx/models/api/matching/package-use.html +++ /dev/null @@ -1,285 +0,0 @@ - - - - - - -Uses of Package com.textkernel.tx.models.api.matching (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Package
com.textkernel.tx.models.api.matching

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/request/DistanceUnit.html b/docs/com/textkernel/tx/models/api/matching/request/DistanceUnit.html deleted file mode 100644 index 0bc46a4a2..000000000 --- a/docs/com/textkernel/tx/models/api/matching/request/DistanceUnit.html +++ /dev/null @@ -1,344 +0,0 @@ - - - - - - -DistanceUnit (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.matching.request
-

Enum DistanceUnit

-
-
- -
- -
-
- -
-
-
    -
  • - - - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        values

        -
        public static DistanceUnit[] values()
        -
        Returns an array containing the constants of this enum type, in -the order they are declared. This method may be used to iterate -over the constants as follows: -
        -for (DistanceUnit c : DistanceUnit.values())
-    System.out.println(c);
-
        -
        -
        Returns:
        -
        an array containing the constants of this enum type, in the order they are declared
        -
        -
        • -
      - - - -
        -
      • -

        valueOf

        -
        public static DistanceUnit valueOf(String name)
        -
        Returns the enum constant of this type with the specified name. -The string must match exactly an identifier used to declare an -enum constant in this type. (Extraneous whitespace characters are -not permitted.)
        -
        -
        Parameters:
        -
        name - the name of the enum constant to be returned.
        -
        Returns:
        -
        the enum constant with the specified name
        -
        Throws:
        -
        IllegalArgumentException - if this enum type has no constant with the specified name
        -
        NullPointerException - if the argument is null
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/request/FilterCriteria.html b/docs/com/textkernel/tx/models/api/matching/request/FilterCriteria.html deleted file mode 100644 index 8bb4efaa7..000000000 --- a/docs/com/textkernel/tx/models/api/matching/request/FilterCriteria.html +++ /dev/null @@ -1,884 +0,0 @@ - - - - - - -FilterCriteria (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.matching.request
-

Class FilterCriteria

-
-
- -
-
    -
  • -
    -
    -
    public class FilterCriteria
-extends Object
    -
    Criteria for filtering search/match results
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        RevisionDateRange

        -
        public RevisionDateRange RevisionDateRange
        -
        When specified, the revision date of documents must fall within this range.
        -
        • -
      - - - -
        -
      • -

        DocumentIds

        -
        public List<String> DocumentIds
        -
        Results must have one of the specified document ids (case-insensitive).
        -
        • -
      - - - - - - - -
        -
      • -

        UserDefinedTagsMustAllExist

        -
        public boolean UserDefinedTagsMustAllExist
        -
        When true, all of the user-defined tags in UserDefinedTags must be found. - By default, this is false, which means that at least one of the UserDefinedTags must be found.
        -
        • -
      - - - -
        -
      • -

        LocationCriteria

        -
        public LocationCriteria LocationCriteria
        -
        Use to filter results based on location.
        -
        • -
      - - - -
        -
      • -

        SearchExpression

        -
        public String SearchExpression
        -
        Full-text boolean semantic expresion. For full details on the syntax and supported - operations refer to https://developer.textkernel.com/tx-platform/v10/ai-matching/overview/querying/#ai-filtering-fulltext
        -
        • -
      - - - -
        -
      • -

        HasPatents

        -
        public boolean HasPatents
        -
        If true, results must have/require patent experience.
        -
        • -
      - - - -
        -
      • -

        HasSecurityCredentials

        -
        public boolean HasSecurityCredentials
        -
        If true, results must have/require security credentials.
        -
        • -
      - - - -
        -
      • -

        SecurityCredentials

        -
        public List<String> SecurityCredentials
        -
        Results must have/require at least one of the security credentials specified. - Supports (*, ?) wildcard characters after the third character in the term as defined - in https://developer.textkernel.com/tx-platform/v10/ai-matching/overview/querying/#ai-filtering-special-operators
        -
        • -
      - - - -
        -
      • -

        IsAuthor

        -
        public boolean IsAuthor
        -
        If true, results must have/require experience as an author.
        -
        • -
      - - - -
        -
      • -

        IsPublicSpeaker

        -
        public boolean IsPublicSpeaker
        -
        If true, results must have/require public speaking experience.
        -
        • -
      - - - -
        -
      • -

        IsMilitary

        -
        public boolean IsMilitary
        -
        If true, results must have/require military experience.
        -
        • -
      - - - -
        -
      • -

        SchoolNames

        -
        public List<String> SchoolNames
        -
        Results must have at least one of the specified school names. Supports (*, ?) wildcard - characters after the third character in the term as defined in - https://developer.textkernel.com/tx-platform/v10/ai-matching/overview/querying/#ai-filtering-special-operators
        -
        • -
      - - - -
        -
      • -

        DegreeNames

        -
        public List<String> DegreeNames
        -
        Results must have at least one of the specified degree names. Supports (*, ?) wildcard - characters after the third character in the term as defined in - hhttps://developer.textkernel.com/tx-platform/v10/ai-matching/overview/querying/#ai-filtering-special-operators
        -
        • -
      - - - -
        -
      • -

        DegreeTypes

        -
        public List<String> DegreeTypes
        -
        Results must have at least one of the specified degree types. One of: -
          -
        • specialeducation
          • -
        • someHighSchoolOrEquivalent
          • -
        • ged
          • -
        • secondary
          • -
        • highSchoolOrEquivalent
          • -
        • certification
          • -
        • vocational
          • -
        • someCollege
          • -
        • HND_HNC_OrEquivalent
          • -
        • associates
          • -
        • international
          • -
        • bachelors
          • -
        • somePostgraduate
          • -
        • masters
          • -
        • intermediategraduate
          • -
        • professional
          • -
        • postprofessional
          • -
        • doctorate
          • -
        • postdoctorate
          • -
        -
        • -
      - - - -
        -
      • -

        Employers

        -
        public List<String> Employers
        -
        Results must have at least one of the specified employers. Supports (*, ?) wildcard - characters after the third character in the term as defined in - https://developer.textkernel.com/tx-platform/v10/ai-matching/overview/querying/#ai-filtering-special-operators
        -
        • -
      - - - -
        -
      • -

        EmployersMustAllBeCurrentEmployer

        -
        public boolean EmployersMustAllBeCurrentEmployer
        -
        When true, at least one employer in Employers must be found in the current time frame.
        -
        • -
      - - - -
        -
      • -

        MonthsExperience

        -
        public IntegerRange MonthsExperience
        -
        When specified, total work experience must fall within this range.
        -
        • -
      - - - -
        -
      • -

        DocumentLanguages

        -
        public List<String> DocumentLanguages
        -
        Results must be written in one of the specified languages. (2-letter ISO 639-1 language codes)
        -
        • -
      - - - -
        -
      • -

        Skills

        -
        public List<SkillFilter> Skills
        -
        Results must have/require at least one of the specified skills.
        -
        • -
      - - - -
        -
      • -

        SkillsMustAllExist

        -
        public boolean SkillsMustAllExist
        -
        When true, all of the skills in Skills must be found. By default, this is false, - which means that only one of the Skills must be found.
        -
        • -
      - - - -
        -
      • -

        IsTopStudent

        -
        public boolean IsTopStudent
        -
        Results must have an education with a normalized GPA of .75 or higher (for example, 3.0/4.0 or higher).
        -
        • -
      - - - -
        -
      • -

        IsCurrentStudent

        -
        public boolean IsCurrentStudent
        -
        Results must have an education section listed as '- current'.
        -
        • -
      - - - -
        -
      • -

        IsRecentGraduate

        -
        public boolean IsRecentGraduate
        -
        Results must have graduated within the last 18 months.
        -
        • -
      - - - -
        -
      • -

        JobTitles

        -
        public List<JobTitleFilter> JobTitles
        -
        Results must have at least one of the specified job titles.
        -
        • -
      - - - -
        -
      • -

        ExecutiveType

        -
        public List<String> ExecutiveType
        -
        Results must have at least one of the following types of executive experience: -
          -
        • None
          • -
        • Executive
          • -
        • Admin
          • -
        • Accounting
          • -
        • Operations
          • -
        • Financial
          • -
        • Marketing
          • -
        • Business_Dev
          • -
        • IT
          • -
        • General
          • -
        • Learning
          • -
        -
        • -
      - - - -
        -
      • -

        Certifications

        -
        public List<String> Certifications
        -
        Results must have at least one of the specified certifications. Supports (*, ?) wildcard - characters after the third character in the term as defined in - https://developer.textkernel.com/tx-platform/v10/ai-matching/overview/querying/#ai-filtering-special-operators
        -
        • -
      - - - -
        -
      • -

        MonthsManagementExperience

        -
        public IntegerRange MonthsManagementExperience
        -
        Results must have management experience within this months range.
        -
        • -
      - - - -
        -
      • -

        CurrentManagementLevel

        -
        public String CurrentManagementLevel
        -
        Results must currently have at least one of the following management levels: -
          -
        • None
          • -
        • Low
          • -
        • Mid
          • -
        • High
          • -
        -
        • -
      - - - -
        -
      • -

        LanguagesKnown

        -
        public List<String> LanguagesKnown
        -
        Results must have/require these language competencies (2-letter ISO 639-1 language codes). -

        Either all or at least one are required depending on the value of LanguagesKnownMustAllExist

        -
        • -
      - - - -
        -
      • -

        LanguagesKnownMustAllExist

        -
        public boolean LanguagesKnownMustAllExist
        -
        When true, all of the languages in LanguagesKnown must be found. - By default, this is false, which means that only one of the LanguagesKnown must be found.
        -
        • -
      - - - -
        -
      • -

        Taxonomies

        -
        public List<String> Taxonomies
        -
        Results must contain at least one of the specified best-fit taxonomy IDs or best-fit subtaxonomy IDs. -

        See Taxonomy.getDefaults()

        -
        • -
      - - - - - - - - -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        FilterCriteria

        -
        public FilterCriteria()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/request/FilterLocation.html b/docs/com/textkernel/tx/models/api/matching/request/FilterLocation.html deleted file mode 100644 index 2182f1d96..000000000 --- a/docs/com/textkernel/tx/models/api/matching/request/FilterLocation.html +++ /dev/null @@ -1,343 +0,0 @@ - - - - - - -FilterLocation (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.matching.request
-

Class FilterLocation

-
-
- -
-
    -
  • -
    -
    -
    public class FilterLocation
-extends Object
    -
    A location used for filtering results by exact location or radius searching
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        CountryCode

        -
        public String CountryCode
        -
        The 2-letter ISO 3166 country code
        -
        • -
      - - - -
        -
      • -

        PostalCode

        -
        public String PostalCode
        -
        The Postal or Zip code
        -
        • -
      - - - -
        -
      • -

        Region

        -
        public String Region
        -
        The Region/District/State
        -
        • -
      - - - -
        -
      • -

        Municipality

        -
        public String Municipality
        -
        The City/Municipality/Town
        -
        • -
      - - - -
        -
      • -

        GeoPoint

        -
        public GeoCoordinates GeoPoint
        -
        The geocordinates to be used in the location
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        FilterLocation

        -
        public FilterLocation()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/request/IntegerRange.html b/docs/com/textkernel/tx/models/api/matching/request/IntegerRange.html deleted file mode 100644 index 967f2ced3..000000000 --- a/docs/com/textkernel/tx/models/api/matching/request/IntegerRange.html +++ /dev/null @@ -1,295 +0,0 @@ - - - - - - -IntegerRange (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.matching.request
-

Class IntegerRange

-
-
- -
-
    -
  • -
    -
    -
    public class IntegerRange
-extends Object
    -
    A range of integers
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Minimum

        -
        public int Minimum
        -
        The minimum for this range
        -
        • -
      - - - -
        -
      • -

        Maximum

        -
        public int Maximum
        -
        The maximum for this range
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        IntegerRange

        -
        public IntegerRange()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/request/JobTitleFilter.html b/docs/com/textkernel/tx/models/api/matching/request/JobTitleFilter.html deleted file mode 100644 index 2454a09a3..000000000 --- a/docs/com/textkernel/tx/models/api/matching/request/JobTitleFilter.html +++ /dev/null @@ -1,296 +0,0 @@ - - - - - - -JobTitleFilter (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.matching.request
-

Class JobTitleFilter

-
-
- -
-
    -
  • -
    -
    -
    public class JobTitleFilter
-extends Object
    -
    Criteria for filtering on a specific job title
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Title

        -
        public String Title
        -
        The name of the Job Title. Supports (*, ?) wildcard characters after the third character - in the term as defined in https://developer.textkernel.com/tx-platform/v10/ai-matching/overview/querying/#ai-filtering-special-operators
        -
        • -
      - - - -
        -
      • -

        IsCurrent

        -
        public boolean IsCurrent
        -
        Whether or not the job title must be a current job title
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        JobTitleFilter

        -
        public JobTitleFilter()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/request/LocationCriteria.html b/docs/com/textkernel/tx/models/api/matching/request/LocationCriteria.html deleted file mode 100644 index c659fb01b..000000000 --- a/docs/com/textkernel/tx/models/api/matching/request/LocationCriteria.html +++ /dev/null @@ -1,345 +0,0 @@ - - - - - - -LocationCriteria (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.matching.request
-

Class LocationCriteria

-
-
- -
-
    -
  • -
    -
    -
    public class LocationCriteria
-extends Object
    -
    Criteria for distance/range filtering
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Locations

        -
        public List<FilterLocation> Locations
        -
        Results must be found within a certain distance of one of these specified locations.
        -
        • -
      - - - -
        -
      • -

        Distance

        -
        public Integer Distance
        -
        The distance from Locations within which to find results.
        -
        • -
      - - - -
        -
      • -

        DistanceUnit

        -
        public DistanceUnit DistanceUnit
        -
        The units for the specified distance.
        -
        • -
      - - - - - - - -
        -
      • -

        GeocodeProviderKey

        -
        public String GeocodeProviderKey
        -
        Your private API key for the geocoding provider. If using GeocodeProvider.Bing you must specify your own API key. -

        If using GeocodeProvider.Google, you can optionally provide your own API key

        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        LocationCriteria

        -
        public LocationCriteria()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/request/MatchByDocumentIdOptions.html b/docs/com/textkernel/tx/models/api/matching/request/MatchByDocumentIdOptions.html deleted file mode 100644 index 11f19ce9e..000000000 --- a/docs/com/textkernel/tx/models/api/matching/request/MatchByDocumentIdOptions.html +++ /dev/null @@ -1,272 +0,0 @@ - - - - - - -MatchByDocumentIdOptions (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api.matching.request
-

Class MatchByDocumentIdOptions

-
-
- -
-
    -
  • -
    -
    -
    public class MatchByDocumentIdOptions
-extends MatchRequest
    -
    Request body for a Match request
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        MatchByDocumentIdOptions

        -
        public MatchByDocumentIdOptions()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/request/MatchRequest.html b/docs/com/textkernel/tx/models/api/matching/request/MatchRequest.html deleted file mode 100644 index 12f46f66f..000000000 --- a/docs/com/textkernel/tx/models/api/matching/request/MatchRequest.html +++ /dev/null @@ -1,316 +0,0 @@ - - - - - - -MatchRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.matching.request
-

Class MatchRequest

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Take

        -
        public int Take
        -
        The number of results to return.
        -
        • -
      - - - -
        -
      • -

        PreferredCategoryWeights

        -
        public CategoryWeights PreferredCategoryWeights
        -
        The weights you want to use for scoring. It is important to specify these, otherwise default values will be used. -

        These weights will be used except in the case - that you provided a non-zero weight for a category that is irrelevant in the source document. - For example, this can happen when the source document contains no languages. -

        - See also: BaseScoredResponseValue.AppliedCategoryWeights

        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        MatchRequest

        -
        public MatchRequest()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/request/PaginationSettings.html b/docs/com/textkernel/tx/models/api/matching/request/PaginationSettings.html deleted file mode 100644 index 0366ec6af..000000000 --- a/docs/com/textkernel/tx/models/api/matching/request/PaginationSettings.html +++ /dev/null @@ -1,295 +0,0 @@ - - - - - - -PaginationSettings (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.matching.request
-

Class PaginationSettings

-
-
- -
-
    -
  • -
    -
    -
    public class PaginationSettings
-extends Object
    -
    Settings for pagination of results
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Take

        -
        public Integer Take
        -
        How many results to return
        -
        • -
      - - - -
        -
      • -

        Skip

        -
        public Integer Skip
        -
        How many results to skip. For example: (skip 5, take 10) means return results 6-15
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        PaginationSettings

        -
        public PaginationSettings()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/request/RevisionDateRange.html b/docs/com/textkernel/tx/models/api/matching/request/RevisionDateRange.html deleted file mode 100644 index 3ceeb4f29..000000000 --- a/docs/com/textkernel/tx/models/api/matching/request/RevisionDateRange.html +++ /dev/null @@ -1,295 +0,0 @@ - - - - - - -RevisionDateRange (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.matching.request
-

Class RevisionDateRange

-
-
- -
-
    -
  • -
    -
    -
    public class RevisionDateRange
-extends Object
    -
    A range of revision dates in ISO 8601 (yyyy-MM-dd) format
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Minimum

        -
        public String Minimum
        -
        the minimum (oldest) date in ISO 8601 (yyyy-MM-dd) format
        -
        • -
      - - - -
        -
      • -

        Maximum

        -
        public String Maximum
        -
        the maximum (most recent) date in ISO 8601 (yyyy-MM-dd) format
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        RevisionDateRange

        -
        public RevisionDateRange()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/request/SearchMatchRequestBase.html b/docs/com/textkernel/tx/models/api/matching/request/SearchMatchRequestBase.html deleted file mode 100644 index fab900809..000000000 --- a/docs/com/textkernel/tx/models/api/matching/request/SearchMatchRequestBase.html +++ /dev/null @@ -1,315 +0,0 @@ - - - - - - -SearchMatchRequestBase (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.matching.request
-

Class SearchMatchRequestBase

-
-
- -
-
    -
  • -
    -
    Direct Known Subclasses:
    -
    MatchRequest, SearchRequest
    -
    -
    -
    -
    public abstract class SearchMatchRequestBase
-extends Object
    -
    Base class for match/search requests
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        IndexIdsToSearchInto

        -
        public List<String> IndexIdsToSearchInto
        -
        The ids of the indexes in which you want to find results (case-insensitive).
        -
        • -
      - - - -
        -
      • -

        Settings

        -
        public SearchMatchSettings Settings
        -
        The settings to use during searching/matching queries
        -
        • -
      - - - -
        -
      • -

        FilterCriteria

        -
        public FilterCriteria FilterCriteria
        -
        Required criteria for the result set.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        SearchMatchRequestBase

        -
        public SearchMatchRequestBase()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/request/SearchMatchSettings.html b/docs/com/textkernel/tx/models/api/matching/request/SearchMatchSettings.html deleted file mode 100644 index 4462b254f..000000000 --- a/docs/com/textkernel/tx/models/api/matching/request/SearchMatchSettings.html +++ /dev/null @@ -1,320 +0,0 @@ - - - - - - -SearchMatchSettings (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.matching.request
-

Class SearchMatchSettings

-
-
- -
-
    -
  • -
    -
    -
    public class SearchMatchSettings
-extends Object
    -
    Settings for searching/matching
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        PositionTitlesMustHaveAnExactMatch

        -
        public boolean PositionTitlesMustHaveAnExactMatch
        -
        Set to true to turn off variation matches in job titles.
        -
        • -
      - - - -
        -
      • -

        NormalizeJobTitles

        -
        public boolean NormalizeJobTitles
        -
        Normalize the first three job titles specified in FilterCriteria.JobTitles and automatically include them in the query - (additional charges apply). -

        - You will only benefit from using this parameter if the data in your index was parsed with ProfessionsSettings.Normalize enabled. -

        - Normalized job titles help identify more matches by looking beyond the exact job title. Normalization uses lists - of synonyms behind the scenes. For example, a search for "HR Advisor" will also return results for "Human Resources Consultant". -

        - When matching, the normalized job title is automatically included in the query if the data in your index was parsed with ProfessionsSettings.Normalize enabled.

        -
        • -
      - - - -
        -
      • -

        NormalizeJobTitlesLanguage

        -
        public String NormalizeJobTitlesLanguage
        -
        Specify the language (ISO 639-1 code) of the Job Title to be normalized. This defaults to en. See list of supoprted languages.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        SearchMatchSettings

        -
        public SearchMatchSettings()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/request/SkillExperienceLevel.html b/docs/com/textkernel/tx/models/api/matching/request/SkillExperienceLevel.html deleted file mode 100644 index dcd5d3634..000000000 --- a/docs/com/textkernel/tx/models/api/matching/request/SkillExperienceLevel.html +++ /dev/null @@ -1,365 +0,0 @@ - - - - - - -SkillExperienceLevel (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.matching.request
-

Enum SkillExperienceLevel

-
-
- -
- -
-
- -
-
-
    -
  • - - - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        values

        -
        public static SkillExperienceLevel[] values()
        -
        Returns an array containing the constants of this enum type, in -the order they are declared. This method may be used to iterate -over the constants as follows: -
        -for (SkillExperienceLevel c : SkillExperienceLevel.values())
-    System.out.println(c);
-
        -
        -
        Returns:
        -
        an array containing the constants of this enum type, in the order they are declared
        -
        -
        • -
      - - - -
        -
      • -

        valueOf

        -
        public static SkillExperienceLevel valueOf(String name)
        -
        Returns the enum constant of this type with the specified name. -The string must match exactly an identifier used to declare an -enum constant in this type. (Extraneous whitespace characters are -not permitted.)
        -
        -
        Parameters:
        -
        name - the name of the enum constant to be returned.
        -
        Returns:
        -
        the enum constant with the specified name
        -
        Throws:
        -
        IllegalArgumentException - if this enum type has no constant with the specified name
        -
        NullPointerException - if the argument is null
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/request/SkillFilter.html b/docs/com/textkernel/tx/models/api/matching/request/SkillFilter.html deleted file mode 100644 index 6198c1737..000000000 --- a/docs/com/textkernel/tx/models/api/matching/request/SkillFilter.html +++ /dev/null @@ -1,312 +0,0 @@ - - - - - - -SkillFilter (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.matching.request
-

Class SkillFilter

-
-
- -
-
    -
  • -
    -
    -
    public class SkillFilter
-extends Object
    -
    Filter for a specific skill
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        SkillName

        -
        public String SkillName
        -
        The name of the skill. Supports (*, ?) wildcard characters after the third character in the term - as defined in https://developer.textkernel.com/tx-platform/v10/ai-matching/overview/querying/#ai-filtering-special-operators
        -
        • -
      - - - -
        -
      • -

        ExperienceLevel

        -
        public SkillExperienceLevel ExperienceLevel
        -
        The experience level of the skill
        -
        • -
      - - - -
        -
      • -

        IsCurrent

        -
        public boolean IsCurrent
        -
        Whether or not the skill must be a current skill
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        SkillFilter

        -
        public SkillFilter()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/request/class-use/DistanceUnit.html b/docs/com/textkernel/tx/models/api/matching/request/class-use/DistanceUnit.html deleted file mode 100644 index 3d8e5ef07..000000000 --- a/docs/com/textkernel/tx/models/api/matching/request/class-use/DistanceUnit.html +++ /dev/null @@ -1,190 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.request.DistanceUnit (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.request.DistanceUnit

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/request/class-use/FilterCriteria.html b/docs/com/textkernel/tx/models/api/matching/request/class-use/FilterCriteria.html deleted file mode 100644 index 5e6981893..000000000 --- a/docs/com/textkernel/tx/models/api/matching/request/class-use/FilterCriteria.html +++ /dev/null @@ -1,272 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.request.FilterCriteria (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.request.FilterCriteria

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/request/class-use/FilterLocation.html b/docs/com/textkernel/tx/models/api/matching/request/class-use/FilterLocation.html deleted file mode 100644 index 1ff08b95c..000000000 --- a/docs/com/textkernel/tx/models/api/matching/request/class-use/FilterLocation.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.request.FilterLocation (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.request.FilterLocation

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/request/class-use/IntegerRange.html b/docs/com/textkernel/tx/models/api/matching/request/class-use/IntegerRange.html deleted file mode 100644 index 3e34c199c..000000000 --- a/docs/com/textkernel/tx/models/api/matching/request/class-use/IntegerRange.html +++ /dev/null @@ -1,186 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.request.IntegerRange (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.request.IntegerRange

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/request/class-use/JobTitleFilter.html b/docs/com/textkernel/tx/models/api/matching/request/class-use/JobTitleFilter.html deleted file mode 100644 index 3f0773192..000000000 --- a/docs/com/textkernel/tx/models/api/matching/request/class-use/JobTitleFilter.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.request.JobTitleFilter (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.request.JobTitleFilter

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/request/class-use/LocationCriteria.html b/docs/com/textkernel/tx/models/api/matching/request/class-use/LocationCriteria.html deleted file mode 100644 index e6be2aefe..000000000 --- a/docs/com/textkernel/tx/models/api/matching/request/class-use/LocationCriteria.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.request.LocationCriteria (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.request.LocationCriteria

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/request/class-use/MatchByDocumentIdOptions.html b/docs/com/textkernel/tx/models/api/matching/request/class-use/MatchByDocumentIdOptions.html deleted file mode 100644 index 29ecce13b..000000000 --- a/docs/com/textkernel/tx/models/api/matching/request/class-use/MatchByDocumentIdOptions.html +++ /dev/null @@ -1,165 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.request.MatchByDocumentIdOptions (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.request.MatchByDocumentIdOptions

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/request/class-use/MatchRequest.html b/docs/com/textkernel/tx/models/api/matching/request/class-use/MatchRequest.html deleted file mode 100644 index cbb41ce26..000000000 --- a/docs/com/textkernel/tx/models/api/matching/request/class-use/MatchRequest.html +++ /dev/null @@ -1,198 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.request.MatchRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.request.MatchRequest

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/request/class-use/PaginationSettings.html b/docs/com/textkernel/tx/models/api/matching/request/class-use/PaginationSettings.html deleted file mode 100644 index 3421379c9..000000000 --- a/docs/com/textkernel/tx/models/api/matching/request/class-use/PaginationSettings.html +++ /dev/null @@ -1,204 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.request.PaginationSettings (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.request.PaginationSettings

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/request/class-use/RevisionDateRange.html b/docs/com/textkernel/tx/models/api/matching/request/class-use/RevisionDateRange.html deleted file mode 100644 index b2ed4515b..000000000 --- a/docs/com/textkernel/tx/models/api/matching/request/class-use/RevisionDateRange.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.request.RevisionDateRange (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.request.RevisionDateRange

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/request/class-use/SearchMatchRequestBase.html b/docs/com/textkernel/tx/models/api/matching/request/class-use/SearchMatchRequestBase.html deleted file mode 100644 index 015a63847..000000000 --- a/docs/com/textkernel/tx/models/api/matching/request/class-use/SearchMatchRequestBase.html +++ /dev/null @@ -1,210 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.request.SearchMatchRequestBase (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.request.SearchMatchRequestBase

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/request/class-use/SearchMatchSettings.html b/docs/com/textkernel/tx/models/api/matching/request/class-use/SearchMatchSettings.html deleted file mode 100644 index 3c2a9ddb3..000000000 --- a/docs/com/textkernel/tx/models/api/matching/request/class-use/SearchMatchSettings.html +++ /dev/null @@ -1,332 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.request.SearchMatchSettings (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.request.SearchMatchSettings

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/request/class-use/SkillExperienceLevel.html b/docs/com/textkernel/tx/models/api/matching/request/class-use/SkillExperienceLevel.html deleted file mode 100644 index 79e05a092..000000000 --- a/docs/com/textkernel/tx/models/api/matching/request/class-use/SkillExperienceLevel.html +++ /dev/null @@ -1,190 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.request.SkillExperienceLevel (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.request.SkillExperienceLevel

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/request/class-use/SkillFilter.html b/docs/com/textkernel/tx/models/api/matching/request/class-use/SkillFilter.html deleted file mode 100644 index a6221c44c..000000000 --- a/docs/com/textkernel/tx/models/api/matching/request/class-use/SkillFilter.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.request.SkillFilter (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.request.SkillFilter

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/request/package-frame.html b/docs/com/textkernel/tx/models/api/matching/request/package-frame.html deleted file mode 100644 index d4c44b978..000000000 --- a/docs/com/textkernel/tx/models/api/matching/request/package-frame.html +++ /dev/null @@ -1,37 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.matching.request (Textkernel Tx Java SDK 2.3.3 API) - - - - - -

com.textkernel.tx.models.api.matching.request

-
-

Classes

- -

Enums

- -
- - diff --git a/docs/com/textkernel/tx/models/api/matching/request/package-summary.html b/docs/com/textkernel/tx/models/api/matching/request/package-summary.html deleted file mode 100644 index c13ab101a..000000000 --- a/docs/com/textkernel/tx/models/api/matching/request/package-summary.html +++ /dev/null @@ -1,235 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.matching.request (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package com.textkernel.tx.models.api.matching.request

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/request/package-tree.html b/docs/com/textkernel/tx/models/api/matching/request/package-tree.html deleted file mode 100644 index 6c9fb29a7..000000000 --- a/docs/com/textkernel/tx/models/api/matching/request/package-tree.html +++ /dev/null @@ -1,169 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.matching.request Class Hierarchy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package com.textkernel.tx.models.api.matching.request

-Package Hierarchies: - -
-
-

Class Hierarchy

- -

Enum Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/request/package-use.html b/docs/com/textkernel/tx/models/api/matching/request/package-use.html deleted file mode 100644 index 194fc0598..000000000 --- a/docs/com/textkernel/tx/models/api/matching/request/package-use.html +++ /dev/null @@ -1,320 +0,0 @@ - - - - - - -Uses of Package com.textkernel.tx.models.api.matching.request (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Package
com.textkernel.tx.models.api.matching.request

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/response/CategoryScoreData.html b/docs/com/textkernel/tx/models/api/matching/response/CategoryScoreData.html deleted file mode 100644 index 4319909b2..000000000 --- a/docs/com/textkernel/tx/models/api/matching/response/CategoryScoreData.html +++ /dev/null @@ -1,299 +0,0 @@ - - - - - - -CategoryScoreData (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.matching.response
-

Class CategoryScoreData

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        UnweightedScore

        -
        public double UnweightedScore
        -
        An unweighted score from 0-100. This is the percentage match of this category.
        -
        • -
      - - - -
        -
      • -

        Evidence

        -
        public List<CategoryScoreEvidence> Evidence
        -
        Detailed written explanation about each data point found or not found.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        CategoryScoreData

        -
        public CategoryScoreData()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/response/CategoryScoreEvidence.html b/docs/com/textkernel/tx/models/api/matching/response/CategoryScoreEvidence.html deleted file mode 100644 index 55c74b559..000000000 --- a/docs/com/textkernel/tx/models/api/matching/response/CategoryScoreEvidence.html +++ /dev/null @@ -1,300 +0,0 @@ - - - - - - -CategoryScoreEvidence (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.matching.response
-

Class CategoryScoreEvidence

-
-
- -
-
    -
  • -
    -
    -
    public class CategoryScoreEvidence
-extends Object
    -
    Contains information about why the score is a certain value
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Fact

        -
        public String Fact
        -
        Information regarding the outcome of one or more of the data points in the query.
        -
        • -
      - - - -
        -
      • -

        Type

        -
        public String Type
        -
        The sentiment of the Fact. This also indicates if this evidence led to a higher or lower score. One of: -
          -
        • Negative
          • -
        • Positive
          • -
        • Mixed
          • -
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        CategoryScoreEvidence

        -
        public CategoryScoreEvidence()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/response/DocumentTaxonomies.html b/docs/com/textkernel/tx/models/api/matching/response/DocumentTaxonomies.html deleted file mode 100644 index 84f57d6c6..000000000 --- a/docs/com/textkernel/tx/models/api/matching/response/DocumentTaxonomies.html +++ /dev/null @@ -1,295 +0,0 @@ - - - - - - -DocumentTaxonomies (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.matching.response
-

Class DocumentTaxonomies

-
-
- -
-
    -
  • -
    -
    -
    public class DocumentTaxonomies
-extends Object
    -
    Primary and secondary taxonomy (industry)
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Primary

        -
        public TaxonomyEvidence Primary
        -
        Best fit taxonomy (industry) evidence.
        -
        • -
      - - - -
        -
      • -

        Secondary

        -
        public TaxonomyEvidence Secondary
        -
        Second best fit taxonomy (industry) evidence.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        DocumentTaxonomies

        -
        public DocumentTaxonomies()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/response/EducationScoreData.html b/docs/com/textkernel/tx/models/api/matching/response/EducationScoreData.html deleted file mode 100644 index 5a4c60240..000000000 --- a/docs/com/textkernel/tx/models/api/matching/response/EducationScoreData.html +++ /dev/null @@ -1,328 +0,0 @@ - - - - - - -EducationScoreData (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.matching.response
-

Class EducationScoreData

-
-
- -
-
    -
  • -
    -
    -
    public class EducationScoreData
-extends CategoryScoreData
    -
    Details about the score for the Education category
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        ExpectedEducation

        -
        public String ExpectedEducation
        -
        Requested level of education.
        -
        • -
      - - - -
        -
      • -

        ActualEducation

        -
        public String ActualEducation
        -
        Actual level of education found.
        -
        • -
      - - - - -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        EducationScoreData

        -
        public EducationScoreData()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/response/EnrichedScoreData.html b/docs/com/textkernel/tx/models/api/matching/response/EnrichedScoreData.html deleted file mode 100644 index 5d56522d4..000000000 --- a/docs/com/textkernel/tx/models/api/matching/response/EnrichedScoreData.html +++ /dev/null @@ -1,391 +0,0 @@ - - - - - - -EnrichedScoreData (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.matching.response
-

Class EnrichedScoreData

-
-
- -
-
    -
  • -
    -
    -
    public class EnrichedScoreData
-extends Object
    -
    Contains metadata/evidence about scores for a specific match/score result
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Languages

        -
        public SimpleCategoryScoreData Languages
        -
        Detailed match information for the Languages category.
        -
        • -
      - - - -
        -
      • -

        Certifications

        -
        public SimpleCategoryScoreData Certifications
        -
        Detailed match information for the Certifications category.
        -
        • -
      - - - -
        -
      • -

        ExecutiveType

        -
        public SimpleCategoryScoreData ExecutiveType
        -
        Detailed match information for the ExecutiveType category.
        -
        • -
      - - - -
        -
      • -

        Education

        -
        public EducationScoreData Education
        -
        Detailed match information for the Education category.
        -
        • -
      - - - -
        -
      • -

        Taxonomies

        -
        public TaxonomiesScoreData Taxonomies
        -
        Detailed match information for the Taxonomies category.
        -
        • -
      - - - -
        -
      • -

        JobTitles

        -
        public JobTitlesScoreData JobTitles
        -
        Detailed match information for the JobTitles category.
        -
        • -
      - - - -
        -
      • -

        Skills

        -
        public SkillsScoreData Skills
        -
        Detailed match information for the Skills category.
        -
        • -
      - - - -
        -
      • -

        ManagementLevel

        -
        public ManagementLevelScoreData ManagementLevel
        -
        Detailed match information for the ManagementLevel category.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        EnrichedScoreData

        -
        public EnrichedScoreData()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/response/FoundJobTitle.html b/docs/com/textkernel/tx/models/api/matching/response/FoundJobTitle.html deleted file mode 100644 index efd2ecec6..000000000 --- a/docs/com/textkernel/tx/models/api/matching/response/FoundJobTitle.html +++ /dev/null @@ -1,311 +0,0 @@ - - - - - - -FoundJobTitle (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.matching.response
-

Class FoundJobTitle

-
-
- -
-
    -
  • -
    -
    -
    public class FoundJobTitle
-extends Object
    -
    Information about a job title match
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        RawTerm

        -
        public String RawTerm
        -
        Exact term found.
        -
        • -
      - - - -
        -
      • -

        VariationOf

        -
        public String VariationOf
        -
        Original term that the variation was derived from (or null if the RawTerm was an exact match)
        -
        • -
      - - - -
        -
      • -

        IsCurrent

        -
        public boolean IsCurrent
        -
        true when the job title found is in the current time-frame.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        FoundJobTitle

        -
        public FoundJobTitle()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/response/FoundSkill.html b/docs/com/textkernel/tx/models/api/matching/response/FoundSkill.html deleted file mode 100644 index ef52b116e..000000000 --- a/docs/com/textkernel/tx/models/api/matching/response/FoundSkill.html +++ /dev/null @@ -1,295 +0,0 @@ - - - - - - -FoundSkill (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.matching.response
-

Class FoundSkill

-
-
- -
-
    -
  • -
    -
    -
    public class FoundSkill
-extends Object
    -
    Information about a skill match
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Skill

        -
        public String Skill
        -
        Name of the skill found.
        -
        • -
      - - - -
        -
      • -

        IsCurrent

        -
        public boolean IsCurrent
        -
        true when the skill is found in the current time-frame.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        FoundSkill

        -
        public FoundSkill()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/response/JobTitlesScoreData.html b/docs/com/textkernel/tx/models/api/matching/response/JobTitlesScoreData.html deleted file mode 100644 index 30fc3a0cb..000000000 --- a/docs/com/textkernel/tx/models/api/matching/response/JobTitlesScoreData.html +++ /dev/null @@ -1,307 +0,0 @@ - - - - - - -JobTitlesScoreData (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.matching.response
-

Class JobTitlesScoreData

-
-
- -
-
    -
  • -
    -
    -
    public class JobTitlesScoreData
-extends CategoryScoreData
    -
    Details about the score for the Job Titles category
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        NotFound

        -
        public List<String> NotFound
        -
        List of terms requested, but not found.
        -
        • -
      - - - -
        -
      • -

        Found

        -
        public List<FoundJobTitle> Found
        -
        List of job titles found in both documents.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        JobTitlesScoreData

        -
        public JobTitlesScoreData()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/response/ManagementLevelScoreData.html b/docs/com/textkernel/tx/models/api/matching/response/ManagementLevelScoreData.html deleted file mode 100644 index 1364d2926..000000000 --- a/docs/com/textkernel/tx/models/api/matching/response/ManagementLevelScoreData.html +++ /dev/null @@ -1,323 +0,0 @@ - - - - - - -ManagementLevelScoreData (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.matching.response
-

Class ManagementLevelScoreData

-
-
- -
-
    -
  • -
    -
    -
    public class ManagementLevelScoreData
-extends CategoryScoreData
    -
    Details about the score for the Management Level category
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Actual

        -
        public String Actual
        -
        Actual management level found.
        -
        • -
      - - - -
        -
      • -

        Desired

        -
        public String Desired
        -
        Requested management level.
        -
        • -
      - - - -
        -
      • -

        AmountOfExperienceMatches

        -
        public boolean AmountOfExperienceMatches
        -
        true when the duration of management experience matches in the source and target documents.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ManagementLevelScoreData

        -
        public ManagementLevelScoreData()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/response/MatchResult.html b/docs/com/textkernel/tx/models/api/matching/response/MatchResult.html deleted file mode 100644 index e093c84ec..000000000 --- a/docs/com/textkernel/tx/models/api/matching/response/MatchResult.html +++ /dev/null @@ -1,368 +0,0 @@ - - - - - - -MatchResult (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.matching.response
-

Class MatchResult

-
-
- -
-
    -
  • -
    -
    -
    public class MatchResult
-extends SearchResult
    -
    A single result containing information about the bimetric score between a target and source document
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        SovScore

        -
        public int SovScore
        -
        An integer score representing the overall fit of the match. - This is the result of a proprietary algorithm that combines the - WeightedScore and the ReverseCompatibilityScore - into one overall score. Results are sorted by this parameter in descending order.
        -
        • -
      - - - -
        -
      • -

        WeightedScore

        -
        public int WeightedScore
        -
        An integer score from 0-100 representing how well the current document matched the source document. - This calculation is the sum of the unweighted category scores multiplied by their respective applied weight. - A score of 100 means that all of the data points in the source document were found in the target document, - but the target document may have had many extra data points. -

        See also:

        -
        • -
      - - - -
        -
      • -

        ReverseCompatibilityScore

        -
        public int ReverseCompatibilityScore
        -
        An integer score from 0-100 which represents how well the target document matched to the source document. - This is equivalent to the WeightedScore if you ran the match/score with the source and - target documents swapped. A score of 100 means that all of the data points in the target document were found - in the source document, but the source document may have had many extra data points.
        -
        • -
      - - - - - - - - -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        MatchResult

        -
        public MatchResult()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/response/SearchResult.html b/docs/com/textkernel/tx/models/api/matching/response/SearchResult.html deleted file mode 100644 index 8251a0215..000000000 --- a/docs/com/textkernel/tx/models/api/matching/response/SearchResult.html +++ /dev/null @@ -1,299 +0,0 @@ - - - - - - -SearchResult (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.matching.response
-

Class SearchResult

-
-
- -
-
    -
  • -
    -
    Direct Known Subclasses:
    -
    MatchResult
    -
    -
    -
    -
    public class SearchResult
-extends Object
    -
    A single result from a search query
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Id

        -
        public String Id
        -
        The document id of the search/match result
        -
        • -
      - - - -
        -
      • -

        IndexId

        -
        public String IndexId
        -
        The id of the index containing the document
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        SearchResult

        -
        public SearchResult()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/response/SimpleCategoryScoreData.html b/docs/com/textkernel/tx/models/api/matching/response/SimpleCategoryScoreData.html deleted file mode 100644 index eb0d9c717..000000000 --- a/docs/com/textkernel/tx/models/api/matching/response/SimpleCategoryScoreData.html +++ /dev/null @@ -1,307 +0,0 @@ - - - - - - -SimpleCategoryScoreData (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.matching.response
-

Class SimpleCategoryScoreData

-
-
- -
-
    -
  • -
    -
    -
    public class SimpleCategoryScoreData
-extends CategoryScoreData
    -
    Details about the score for a specific category
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Found

        -
        public List<String> Found
        -
        List of terms found in both source and target documents
        -
        • -
      - - - -
        -
      • -

        NotFound

        -
        public List<String> NotFound
        -
        List of terms requested but not found
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        SimpleCategoryScoreData

        -
        public SimpleCategoryScoreData()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/response/SkillsScoreData.html b/docs/com/textkernel/tx/models/api/matching/response/SkillsScoreData.html deleted file mode 100644 index f9f547571..000000000 --- a/docs/com/textkernel/tx/models/api/matching/response/SkillsScoreData.html +++ /dev/null @@ -1,307 +0,0 @@ - - - - - - -SkillsScoreData (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.matching.response
-

Class SkillsScoreData

-
-
- -
-
    -
  • -
    -
    -
    public class SkillsScoreData
-extends CategoryScoreData
    -
    Details about the score for the Skills category
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        NotFound

        -
        public List<String> NotFound
        -
        List of terms requested, but not found.
        -
        • -
      - - - -
        -
      • -

        Found

        -
        public List<FoundSkill> Found
        -
        List of skills found in both source and target documents
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        SkillsScoreData

        -
        public SkillsScoreData()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/response/TaxonomiesScoreData.html b/docs/com/textkernel/tx/models/api/matching/response/TaxonomiesScoreData.html deleted file mode 100644 index a4105dce2..000000000 --- a/docs/com/textkernel/tx/models/api/matching/response/TaxonomiesScoreData.html +++ /dev/null @@ -1,307 +0,0 @@ - - - - - - -TaxonomiesScoreData (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.matching.response
-

Class TaxonomiesScoreData

-
-
- -
-
    -
  • -
    -
    -
    public class TaxonomiesScoreData
-extends CategoryScoreData
    -
    Details about the score for the Taxonomies category
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        ActualTaxonomies

        -
        public DocumentTaxonomies ActualTaxonomies
        -
        Taxonomies/industries found.
        -
        • -
      - - - -
        -
      • -

        DesiredTaxonomies

        -
        public DocumentTaxonomies DesiredTaxonomies
        -
        Taxonomies/industries requested.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        TaxonomiesScoreData

        -
        public TaxonomiesScoreData()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/response/TaxonomyEvidence.html b/docs/com/textkernel/tx/models/api/matching/response/TaxonomyEvidence.html deleted file mode 100644 index 9f9366e78..000000000 --- a/docs/com/textkernel/tx/models/api/matching/response/TaxonomyEvidence.html +++ /dev/null @@ -1,295 +0,0 @@ - - - - - - -TaxonomyEvidence (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.matching.response
-

Class TaxonomyEvidence

-
-
- -
-
    -
  • -
    -
    -
    public class TaxonomyEvidence
-extends Object
    -
    A taxonomy/subtaxonomy (industry/specialization) pair
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Taxonomy

        -
        public TaxonomyInfo Taxonomy
        -
        Parent taxonomy (industry)
        -
        • -
      - - - -
        -
      • -

        Subtaxonomy

        -
        public TaxonomyInfo Subtaxonomy
        -
        Child subtaxonomy (specialization)
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        TaxonomyEvidence

        -
        public TaxonomyEvidence()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/response/TaxonomyInfo.html b/docs/com/textkernel/tx/models/api/matching/response/TaxonomyInfo.html deleted file mode 100644 index e97d57ab3..000000000 --- a/docs/com/textkernel/tx/models/api/matching/response/TaxonomyInfo.html +++ /dev/null @@ -1,311 +0,0 @@ - - - - - - -TaxonomyInfo (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.matching.response
-

Class TaxonomyInfo

-
-
- -
-
    -
  • -
    -
    -
    public class TaxonomyInfo
-extends Object
    -
    Evidence for a specific taxonomy/subtaxonomy
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Name

        -
        public String Name
        -
        Taxonomy/subtaxonomy name
        -
        • -
      - - - -
        -
      • -

        Id

        -
        public String Id
        -
        Id for the taxonomy/subtaxonomy
        -
        • -
      - - - -
        -
      • -

        Matched

        -
        public boolean Matched
        -
        true when this taxonomy/subtaxonomy is found in both source and target documents
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        TaxonomyInfo

        -
        public TaxonomyInfo()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/response/class-use/CategoryScoreData.html b/docs/com/textkernel/tx/models/api/matching/response/class-use/CategoryScoreData.html deleted file mode 100644 index 100ca842c..000000000 --- a/docs/com/textkernel/tx/models/api/matching/response/class-use/CategoryScoreData.html +++ /dev/null @@ -1,198 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.response.CategoryScoreData (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.response.CategoryScoreData

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/response/class-use/CategoryScoreEvidence.html b/docs/com/textkernel/tx/models/api/matching/response/class-use/CategoryScoreEvidence.html deleted file mode 100644 index 1a129e1b9..000000000 --- a/docs/com/textkernel/tx/models/api/matching/response/class-use/CategoryScoreEvidence.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.response.CategoryScoreEvidence (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.response.CategoryScoreEvidence

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/response/class-use/DocumentTaxonomies.html b/docs/com/textkernel/tx/models/api/matching/response/class-use/DocumentTaxonomies.html deleted file mode 100644 index ed0476b6e..000000000 --- a/docs/com/textkernel/tx/models/api/matching/response/class-use/DocumentTaxonomies.html +++ /dev/null @@ -1,174 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.response.DocumentTaxonomies (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.response.DocumentTaxonomies

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/response/class-use/EducationScoreData.html b/docs/com/textkernel/tx/models/api/matching/response/class-use/EducationScoreData.html deleted file mode 100644 index ef866e85d..000000000 --- a/docs/com/textkernel/tx/models/api/matching/response/class-use/EducationScoreData.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.response.EducationScoreData (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.response.EducationScoreData

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/response/class-use/EnrichedScoreData.html b/docs/com/textkernel/tx/models/api/matching/response/class-use/EnrichedScoreData.html deleted file mode 100644 index 9af72d24a..000000000 --- a/docs/com/textkernel/tx/models/api/matching/response/class-use/EnrichedScoreData.html +++ /dev/null @@ -1,204 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.response.EnrichedScoreData (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.response.EnrichedScoreData

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/response/class-use/FoundJobTitle.html b/docs/com/textkernel/tx/models/api/matching/response/class-use/FoundJobTitle.html deleted file mode 100644 index 1b526ca8b..000000000 --- a/docs/com/textkernel/tx/models/api/matching/response/class-use/FoundJobTitle.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.response.FoundJobTitle (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.response.FoundJobTitle

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/response/class-use/FoundSkill.html b/docs/com/textkernel/tx/models/api/matching/response/class-use/FoundSkill.html deleted file mode 100644 index 318459cc4..000000000 --- a/docs/com/textkernel/tx/models/api/matching/response/class-use/FoundSkill.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.response.FoundSkill (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.response.FoundSkill

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/response/class-use/JobTitlesScoreData.html b/docs/com/textkernel/tx/models/api/matching/response/class-use/JobTitlesScoreData.html deleted file mode 100644 index b0951b5a0..000000000 --- a/docs/com/textkernel/tx/models/api/matching/response/class-use/JobTitlesScoreData.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.response.JobTitlesScoreData (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.response.JobTitlesScoreData

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/response/class-use/ManagementLevelScoreData.html b/docs/com/textkernel/tx/models/api/matching/response/class-use/ManagementLevelScoreData.html deleted file mode 100644 index f24e5358a..000000000 --- a/docs/com/textkernel/tx/models/api/matching/response/class-use/ManagementLevelScoreData.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.response.ManagementLevelScoreData (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.response.ManagementLevelScoreData

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/response/class-use/MatchResult.html b/docs/com/textkernel/tx/models/api/matching/response/class-use/MatchResult.html deleted file mode 100644 index aa5aadf6d..000000000 --- a/docs/com/textkernel/tx/models/api/matching/response/class-use/MatchResult.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.response.MatchResult (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.response.MatchResult

-
-
No usage of com.textkernel.tx.models.api.matching.response.MatchResult
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/response/class-use/SearchResult.html b/docs/com/textkernel/tx/models/api/matching/response/class-use/SearchResult.html deleted file mode 100644 index ade7350d5..000000000 --- a/docs/com/textkernel/tx/models/api/matching/response/class-use/SearchResult.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.response.SearchResult (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.response.SearchResult

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/response/class-use/SimpleCategoryScoreData.html b/docs/com/textkernel/tx/models/api/matching/response/class-use/SimpleCategoryScoreData.html deleted file mode 100644 index e8ad09aed..000000000 --- a/docs/com/textkernel/tx/models/api/matching/response/class-use/SimpleCategoryScoreData.html +++ /dev/null @@ -1,180 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.response.SimpleCategoryScoreData (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.response.SimpleCategoryScoreData

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/response/class-use/SkillsScoreData.html b/docs/com/textkernel/tx/models/api/matching/response/class-use/SkillsScoreData.html deleted file mode 100644 index f64a3c1c2..000000000 --- a/docs/com/textkernel/tx/models/api/matching/response/class-use/SkillsScoreData.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.response.SkillsScoreData (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.response.SkillsScoreData

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/response/class-use/TaxonomiesScoreData.html b/docs/com/textkernel/tx/models/api/matching/response/class-use/TaxonomiesScoreData.html deleted file mode 100644 index bbf01f644..000000000 --- a/docs/com/textkernel/tx/models/api/matching/response/class-use/TaxonomiesScoreData.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.response.TaxonomiesScoreData (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.response.TaxonomiesScoreData

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/response/class-use/TaxonomyEvidence.html b/docs/com/textkernel/tx/models/api/matching/response/class-use/TaxonomyEvidence.html deleted file mode 100644 index ccb256748..000000000 --- a/docs/com/textkernel/tx/models/api/matching/response/class-use/TaxonomyEvidence.html +++ /dev/null @@ -1,174 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.response.TaxonomyEvidence (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.response.TaxonomyEvidence

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/response/class-use/TaxonomyInfo.html b/docs/com/textkernel/tx/models/api/matching/response/class-use/TaxonomyInfo.html deleted file mode 100644 index 96e88e4ea..000000000 --- a/docs/com/textkernel/tx/models/api/matching/response/class-use/TaxonomyInfo.html +++ /dev/null @@ -1,174 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.response.TaxonomyInfo (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.response.TaxonomyInfo

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/response/package-frame.html b/docs/com/textkernel/tx/models/api/matching/response/package-frame.html deleted file mode 100644 index 438ebbdbb..000000000 --- a/docs/com/textkernel/tx/models/api/matching/response/package-frame.html +++ /dev/null @@ -1,36 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.matching.response (Textkernel Tx Java SDK 2.3.3 API) - - - - - -

com.textkernel.tx.models.api.matching.response

-
-

Classes

- -
- - diff --git a/docs/com/textkernel/tx/models/api/matching/response/package-summary.html b/docs/com/textkernel/tx/models/api/matching/response/package-summary.html deleted file mode 100644 index c4a0e5883..000000000 --- a/docs/com/textkernel/tx/models/api/matching/response/package-summary.html +++ /dev/null @@ -1,236 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.matching.response (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package com.textkernel.tx.models.api.matching.response

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/response/package-tree.html b/docs/com/textkernel/tx/models/api/matching/response/package-tree.html deleted file mode 100644 index 6134dcb07..000000000 --- a/docs/com/textkernel/tx/models/api/matching/response/package-tree.html +++ /dev/null @@ -1,160 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.matching.response Class Hierarchy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package com.textkernel.tx.models.api.matching.response

-Package Hierarchies: - -
-
-

Class Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/response/package-use.html b/docs/com/textkernel/tx/models/api/matching/response/package-use.html deleted file mode 100644 index 52f78cbb7..000000000 --- a/docs/com/textkernel/tx/models/api/matching/response/package-use.html +++ /dev/null @@ -1,252 +0,0 @@ - - - - - - -Uses of Package com.textkernel.tx.models.api.matching.response (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Package
com.textkernel.tx.models.api.matching.response

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/FilterToShow.html b/docs/com/textkernel/tx/models/api/matching/ui/FilterToShow.html deleted file mode 100644 index faf16e914..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/FilterToShow.html +++ /dev/null @@ -1,343 +0,0 @@ - - - - - - -FilterToShow (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.matching.ui
-

Class FilterToShow

-
-
- -
-
    -
  • -
    -
    -
    public class FilterToShow
-extends Object
    -
    Used to change the order or titles of the filters in the Matching UI
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Field Summary

      - - - - - - - - - - - - - - -
      Fields 
      Modifier and TypeField and Description
      StringFilterId -
      One of: - - JOB_TITLES - EXPERIENCE - SKILLS - INDUSTRIES - BOOLEAN - LANGUAGES - CERTIFICATIONS - EXECUTIVE_TYPES - LOCATION - EDUCATION - EMPLOYERS - TAGS - METADATA - UNCOMMON -
      -
      StringTitle -
      An optional value to override the title that is shown for a specific filter.
      -
      -
      • -
    - -
      -
    • - - -

      Constructor Summary

      - - - - - - - - -
      Constructors 
      Constructor and Description
      FilterToShow() 
      -
      • -
    - - -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        FilterId

        -
        public String FilterId
        -
        One of: -
          -
        • JOB_TITLES
          • -
        • EXPERIENCE
          • -
        • SKILLS
          • -
        • INDUSTRIES
          • -
        • BOOLEAN
          • -
        • LANGUAGES
          • -
        • CERTIFICATIONS
          • -
        • EXECUTIVE_TYPES
          • -
        • LOCATION
          • -
        • EDUCATION
          • -
        • EMPLOYERS
          • -
        • TAGS
          • -
        • METADATA
          • -
        • UNCOMMON
          • -
        -
        • -
      - - - -
        -
      • -

        Title

        -
        public String Title
        -
        An optional value to override the title that is shown for a specific filter. If not specified, the defaults are as below: -
          -
        • Job Titles
          • -
        • Experience
          • -
        • Skills
          • -
        • Industries
          • -
        • Boolean or Semantic Search
          • -
        • Spoken Languages
          • -
        • Certifications
          • -
        • Executive Types
          • -
        • Location
          • -
        • Education
          • -
        • Employers
          • -
        • User-Defined Tags
          • -
        • Document Metadata
          • -
        • Uncommon Filters
          • -
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        FilterToShow

        -
        public FilterToShow()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/GenerateUIResponse.html b/docs/com/textkernel/tx/models/api/matching/ui/GenerateUIResponse.html deleted file mode 100644 index 8cc5634e6..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/GenerateUIResponse.html +++ /dev/null @@ -1,302 +0,0 @@ - - - - - - -GenerateUIResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.matching.ui
-

Class GenerateUIResponse

-
-
- -
-
    -
  • -
    -
    -
    public class GenerateUIResponse
-extends Object
    -
    The response body from a request to generate the Matching UI
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        url

        -
        public String url
        -
        The URL to navigate to (or set as the src for an iFrame) that will - display the Matching UI. This URL will be valid for at least 24 hours. -
        NOTE: for security purposes, you should redirect a user to the session - immediately after generating the session for that user -
        For more info, see https://developer.textkernel.com/tx-platform/v10/matching-ui/overview/#authentication
        -
        • -
      - - - -
        -
      • -

        expires_in

        -
        public int expires_in
        -
        The number of seconds until the URL auto-authentication expires. If you try - to use this URL after that period of time, the user will be asked to - login (if not already authenticated)
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        GenerateUIResponse

        -
        public GenerateUIResponse()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/Style.html b/docs/com/textkernel/tx/models/api/matching/ui/Style.html deleted file mode 100644 index a77e6bae0..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/Style.html +++ /dev/null @@ -1,345 +0,0 @@ - - - - - - -Style (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.matching.ui
-

Class Style

-
-
- -
-
    -
  • -
    -
    -
    public class Style
-extends Object
    -
    Options for styling the Matching UI
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        PrimaryColor

        -
        public String PrimaryColor
        -
        An HTML color used to generate several related colors for various UI elements. For example: #077799.
        -
        • -
      - - - -
        -
      • -

        HeaderColor

        -
        public String HeaderColor
        -
        An HTML color used for the background of the section/accordian headers. For example: #077799.
        -
        • -
      - - - -
        -
      • -

        SquareCorners

        -
        public boolean SquareCorners
        -
        true to use square corners for UI elements. Default is false for rounded corners.
        -
        • -
      - - - -
        -
      • -

        FontFamily

        -
        public String FontFamily
        -
        A CSS font-family to use for all UI elements. For example: Arial.
        -
        • -
      - - - -
        -
      • -

        FontUrl

        -
        public String FontUrl
        -
        If you'd like to use a non-standard font, specify the URL where that font can be downloaded here. For example: - https://fonts.googleapis.com/css2?family=Montserrat:wght@400;500;600;700&display=swap. Note that you also - need to define the FontFamily if you use this option.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        Style

        -
        public Style()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/UIOptions.html b/docs/com/textkernel/tx/models/api/matching/ui/UIOptions.html deleted file mode 100644 index bb642aac7..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/UIOptions.html +++ /dev/null @@ -1,510 +0,0 @@ - - - - - - -UIOptions (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.matching.ui
-

Class UIOptions

-
-
- -
-
    -
  • -
    -
    -
    public class UIOptions
-extends Object
    -
    Options for creating the Matching UI
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Username

        -
        public String Username
        -
        The username of the user for which you are generating a Matching UI session. -
        If you do not provide this, the user will be required to login when they view the page
        -
        • -
      - - - -
        -
      • -

        Style

        -
        public Style Style
        -
        Specifies custom style options for the Matching UI session.
        -
        • -
      - - - -
        -
      • -

        ShowFilterCriteria

        -
        public boolean ShowFilterCriteria
        -
        true to allow the user to see/modify the filter criteria (default = true).
        -
        • -
      - - - -
        -
      • -

        FiltersToShow

        -
        public List<FilterToShow> FiltersToShow
        -
        If specified, only allows the user to see/modify certain filter categories. - Also, the order specified here is the order in which the filters will appear in the UI.
        -
        • -
      - - - -
        -
      • -

        ExecuteImmediately

        -
        public boolean ExecuteImmediately
        -
        true to execute the query as soon as the page loads (default = false). This is only applicable for Searching. - All matches/bimetric scoring are executed immediately even if this is false.
        -
        • -
      - - - -
        -
      • -

        ShowBanner

        -
        public boolean ShowBanner
        -
        true to show the banner containing your account logo inside the matching UI (default = true).
        -
        • -
      - - - -
        -
      • -

        ShowWeights

        -
        public boolean ShowWeights
        -
        true to allow the user to see/modify the category weights (default = true).
        -
        • -
      - - - -
        -
      • -

        ShowDetailsButton

        -
        public boolean ShowDetailsButton
        -
        true to show a button that opens the 'details' popup containing detailed job/resume info (default = true).
        -
        • -
      - - - -
        -
      • -

        ShowFindSimilar

        -
        public boolean ShowFindSimilar
        -
        true to add a button in the Actions menu that matches other jobs/resumes similar to the current one (default = true).
        -
        • -
      - - - -
        -
      • -

        ShowWebSourcing

        -
        public boolean ShowWebSourcing
        -
        true to include custom web sourcing in search/match results. Cannot be used for bimetric scoring (default = false).
        -
        • -
      - - - -
        -
      • -

        ShowJobBoards

        -
        public boolean ShowJobBoards
        -
        true to include job boards in search/match results. Cannot be used for bimetric scoring (default = true). - Must add credentials in the Tx Console
        -
        • -
      - - - -
        -
      • -

        ShowSavedSearches

        -
        public boolean ShowSavedSearches
        -
        true to allow the user to save custom searches or select from pre-made criteria templates (default = false).
        -
        • -
      - - - - - - - -
        -
      • -

        UserDefinedTagsPicklists

        -
        public List<UserDefinedTagsPicklist> UserDefinedTagsPicklists
        -
        Picklists shown in the UI for your users to filter on your user-defined tags. -
        See also: https://developer.textkernel.com/tx-platform/v10/ai-matching/overview/user-defined-tags/
        -
        • -
      - - - -
        -
      • -

        SkillsAutoCompleteCustomSkillsList

        -
        public List<String> SkillsAutoCompleteCustomSkillsList
        -
        If you are using custom skills, provide your custom skills list names here. The builtin skills lists are always included.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        UIOptions

        -
        public UIOptions()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/UserDefinedTagOption.html b/docs/com/textkernel/tx/models/api/matching/ui/UserDefinedTagOption.html deleted file mode 100644 index 1598be93d..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/UserDefinedTagOption.html +++ /dev/null @@ -1,295 +0,0 @@ - - - - - - -UserDefinedTagOption (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.matching.ui
-

Class UserDefinedTagOption

-
-
- -
-
    -
  • -
    -
    -
    public class UserDefinedTagOption
-extends Object
    -
    A label/value pair for user-defined tags in the UI
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Value

        -
        public String Value
        -
        The value of the tag.
        -
        • -
      - - - -
        -
      • -

        Text

        -
        public String Text
        -
        The text that will be shown to the user for the tag.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        UserDefinedTagOption

        -
        public UserDefinedTagOption()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/UserDefinedTagsPicklist.html b/docs/com/textkernel/tx/models/api/matching/ui/UserDefinedTagsPicklist.html deleted file mode 100644 index 57846feec..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/UserDefinedTagsPicklist.html +++ /dev/null @@ -1,295 +0,0 @@ - - - - - - -UserDefinedTagsPicklist (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.matching.ui
-

Class UserDefinedTagsPicklist

-
-
- -
-
    -
  • -
    -
    -
    public class UserDefinedTagsPicklist
-extends Object
    -
    A picklist to show to a user for filtering on user-defined tags
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Label

        -
        public String Label
        -
        The label for this picklist in the UI
        -
        • -
      - - - -
        -
      • -

        Options

        -
        public List<UserDefinedTagOption> Options
        -
        A list of user-defined tags that the user will be able to pick from
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        UserDefinedTagsPicklist

        -
        public UserDefinedTagsPicklist()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/class-use/FilterToShow.html b/docs/com/textkernel/tx/models/api/matching/ui/class-use/FilterToShow.html deleted file mode 100644 index 67a772e12..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/class-use/FilterToShow.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.ui.FilterToShow (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.ui.FilterToShow

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/class-use/GenerateUIResponse.html b/docs/com/textkernel/tx/models/api/matching/ui/class-use/GenerateUIResponse.html deleted file mode 100644 index 3308830c4..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/class-use/GenerateUIResponse.html +++ /dev/null @@ -1,223 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.ui.GenerateUIResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.ui.GenerateUIResponse

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/class-use/Style.html b/docs/com/textkernel/tx/models/api/matching/ui/class-use/Style.html deleted file mode 100644 index 64d599df2..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/class-use/Style.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.ui.Style (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.ui.Style

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/class-use/UIOptions.html b/docs/com/textkernel/tx/models/api/matching/ui/class-use/UIOptions.html deleted file mode 100644 index 476ddda4f..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/class-use/UIOptions.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.ui.UIOptions (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.ui.UIOptions

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/class-use/UserDefinedTagOption.html b/docs/com/textkernel/tx/models/api/matching/ui/class-use/UserDefinedTagOption.html deleted file mode 100644 index 1fd321873..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/class-use/UserDefinedTagOption.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.ui.UserDefinedTagOption (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.ui.UserDefinedTagOption

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/class-use/UserDefinedTagsPicklist.html b/docs/com/textkernel/tx/models/api/matching/ui/class-use/UserDefinedTagsPicklist.html deleted file mode 100644 index cf541814d..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/class-use/UserDefinedTagsPicklist.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.ui.UserDefinedTagsPicklist (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.ui.UserDefinedTagsPicklist

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/hooks/ClientSideHook.html b/docs/com/textkernel/tx/models/api/matching/ui/hooks/ClientSideHook.html deleted file mode 100644 index 0e24a4255..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/hooks/ClientSideHook.html +++ /dev/null @@ -1,311 +0,0 @@ - - - - - - -ClientSideHook (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.matching.ui.hooks
-

Class ClientSideHook

-
-
- -
-
    -
  • -
    -
    -
    public class ClientSideHook
-extends UserActionHook
    -
    A hook that does some client-side action (opening a tab/window, running some javascript)
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        JsAction

        -
        public JsAction JsAction
        -
        A Javascript action to perform when the user clicks the button. This will post a Javascript - message back to the parent/opener window so that the integrator can run some Javascript. -
        This uses window.postMessage() -
        NOTE: you can use this or UrlAction but not both
        -
        • -
      - - - -
        -
      • -

        UrlAction

        -
        public UrlAction UrlAction
        -
        A URL action to perform when the user clicks the button. This can open a new window or redirect an existing window to a URL. -
        NOTE: you can use this or JsAction but not both
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ClientSideHook

        -
        public ClientSideHook()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/hooks/JsAction.html b/docs/com/textkernel/tx/models/api/matching/ui/hooks/JsAction.html deleted file mode 100644 index 3dc4b642b..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/hooks/JsAction.html +++ /dev/null @@ -1,318 +0,0 @@ - - - - - - -JsAction (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.matching.ui.hooks
-

Class JsAction

-
-
- -
-
    -
  • -
    -
    -
    public class JsAction
-extends Object
    -
    An action performed in Javascript
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Field Summary

      - - - - - - - - - - - - - - - - - - -
      Fields 
      Modifier and TypeField and Description
      ObjectData -
      Any data you want to be sent (in addition to document information) in the 'message' - parameter for the window.postMessage() call.
      -
      StringTarget -
      One of "parent" or "opener", depending if you use an iFrame to show the Matching UI - in your system, or if you open it in a separate tab/window.
      -
      StringTargetOrigin -
      The 'targetOrigin' parameter for the window.postMessage() call.
      -
      -
      • -
    - -
      -
    • - - -

      Constructor Summary

      - - - - - - - - -
      Constructors 
      Constructor and Description
      JsAction() 
      -
      • -
    - - -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Data

        -
        public Object Data
        -
        Any data you want to be sent (in addition to document information) in the 'message' - parameter for the window.postMessage() call. For more information see - https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage
        -
        • -
      - - - -
        -
      • -

        TargetOrigin

        -
        public String TargetOrigin
        -
        The 'targetOrigin' parameter for the window.postMessage() call. For more information see - https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage -
        NOTE: while this is optional, it is recommended for security purposes in the window.postMessage() protocol
        -
        • -
      - - - -
        -
      • -

        Target

        -
        public String Target
        -
        One of "parent" or "opener", depending if you use an iFrame to show the Matching UI - in your system, or if you open it in a separate tab/window.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        JsAction

        -
        public JsAction()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/hooks/ServerSideHook.html b/docs/com/textkernel/tx/models/api/matching/ui/hooks/ServerSideHook.html deleted file mode 100644 index a1f2b2896..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/hooks/ServerSideHook.html +++ /dev/null @@ -1,313 +0,0 @@ - - - - - - -ServerSideHook (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.matching.ui.hooks
-

Class ServerSideHook

-
-
- -
-
    -
  • -
    -
    Direct Known Subclasses:
    -
    SourcingHook
    -
    -
    -
    -
    public class ServerSideHook
-extends UserActionHook
    -
    A hook that does some server-side action (performs an HTTP POST to your server)
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Url

        -
        public String Url
        -
        The URL for an HTTP POST call to perform some action in your system.
        -
        • -
      - - - -
        -
      • -

        CustomInfo

        -
        public Object CustomInfo
        -
        Any data from your system that you need to associate with this session/action. - This is sent (in addition to document information) in the POST body. -
        For more information see https://developer.textkernel.com/tx-platform/v10/matching-ui/overview/#ui-match-hooks
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ServerSideHook

        -
        public ServerSideHook()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/hooks/SourcingHook.html b/docs/com/textkernel/tx/models/api/matching/ui/hooks/SourcingHook.html deleted file mode 100644 index 90785e672..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/hooks/SourcingHook.html +++ /dev/null @@ -1,273 +0,0 @@ - - - - - - -SourcingHook (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api.matching.ui.hooks
-

Class SourcingHook

-
-
- -
-
    -
  • -
    -
    -
    public class SourcingHook
-extends ServerSideHook
    -
    A hook that does some server-side action for sourcing results (performs and HTTP POST to your server) -
    NOTE: Bulk actions are not supported for Sourcing hooks, yet. Setting UserActionHook.IsBulk will have no effect.
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        SourcingHook

        -
        public SourcingHook()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/hooks/UrlAction.html b/docs/com/textkernel/tx/models/api/matching/ui/hooks/UrlAction.html deleted file mode 100644 index 8a661e0f2..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/hooks/UrlAction.html +++ /dev/null @@ -1,301 +0,0 @@ - - - - - - -UrlAction (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.matching.ui.hooks
-

Class UrlAction

-
-
- -
-
    -
  • -
    -
    -
    public class UrlAction
-extends Object
    -
    An action performed with a URL (opening a new window, displaying some webpage)
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Url

        -
        public String Url
        -
        The URL to show (either in another tab/window or in an iFrame inside the Matching UI). -
        NOTE: the UI will do a string.replace() on this URL to replace {id} with the document - id (that this action was performed on) and {indexId} with the index id (containing the document the action - was performed on). -
        - For example: https://my-ats.com/contact-info/{id} gets transformed to https://my-ats.com/contact-info/34879
        -
        • -
      - - - -
        -
      • -

        Target

        -
        public String Target
        -
        Use "tx" to open a popup inside the Matching UI and display the webpage. - Any other value will be used just like the target attribute on a normal anchor tag ("_blank" for a new tab/window, etc).
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        UrlAction

        -
        public UrlAction()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/hooks/UserActionHook.html b/docs/com/textkernel/tx/models/api/matching/ui/hooks/UserActionHook.html deleted file mode 100644 index 437e6b5db..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/hooks/UserActionHook.html +++ /dev/null @@ -1,302 +0,0 @@ - - - - - - -UserActionHook (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.matching.ui.hooks
-

Class UserActionHook

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        LinkText

        -
        public String LinkText
        -
        Text to display on the button for the user action.
        -
        • -
      - - - -
        -
      • -

        IsBulk

        -
        public boolean IsBulk
        -
        Set to true to allow users to select multiple documents and perform this action on all of them at once. -
        NOTE: this can only be set to true when you use a JsAction. UrlActions are not supported. -
        See https://developer.textkernel.com/tx-platform/v10/matching-ui/overview/#ui-match-hooks for more info. -
        This value is not supported for Sourcing hooks, yet
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        UserActionHook

        -
        public UserActionHook()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/hooks/UserActionHookCollection.html b/docs/com/textkernel/tx/models/api/matching/ui/hooks/UserActionHookCollection.html deleted file mode 100644 index b8ae3a5c8..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/hooks/UserActionHookCollection.html +++ /dev/null @@ -1,324 +0,0 @@ - - - - - - -UserActionHookCollection (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.matching.ui.hooks
-

Class UserActionHookCollection

-
-
- -
-
    -
  • -
    -
    -
    public class UserActionHookCollection
-extends Object
    -
    A collection of Matching UI User Action Hooks
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Client

        -
        public List<ClientSideHook> Client
        -
        The client-side User Action Hooks - for a Matching UI session. These can be used to do some client-side action (opening a tab/window, running some javascript) - when a user clicks a button on a particular match result.
        -
        • -
      - - - -
        -
      • -

        Server

        -
        public List<ServerSideHook> Server
        -
        The server-side (HTTP POST) - User Action Hooks - for a Matching UI session. These can be used to do some server-side action (performs an HTTP POST to your server) - when a user clicks a button on a particular match result.
        -
        • -
      - - - -
        -
      • -

        Sourcing

        -
        public List<SourcingHook> Sourcing
        -
        The server-side (HTTP POST) - User Action Hooks - for 'Sourcing' results during a Matching UI session. These can be used to do some server-side action (performs an HTTP POST to your server) - when a user clicks a button on a particular 'Sourcing' result.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        UserActionHookCollection

        -
        public UserActionHookCollection()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/hooks/class-use/ClientSideHook.html b/docs/com/textkernel/tx/models/api/matching/ui/hooks/class-use/ClientSideHook.html deleted file mode 100644 index 528f2ddaf..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/hooks/class-use/ClientSideHook.html +++ /dev/null @@ -1,169 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.ui.hooks.ClientSideHook (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.ui.hooks.ClientSideHook

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/hooks/class-use/JsAction.html b/docs/com/textkernel/tx/models/api/matching/ui/hooks/class-use/JsAction.html deleted file mode 100644 index 04bfafd28..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/hooks/class-use/JsAction.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.ui.hooks.JsAction (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.ui.hooks.JsAction

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/hooks/class-use/ServerSideHook.html b/docs/com/textkernel/tx/models/api/matching/ui/hooks/class-use/ServerSideHook.html deleted file mode 100644 index ac9161948..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/hooks/class-use/ServerSideHook.html +++ /dev/null @@ -1,186 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.ui.hooks.ServerSideHook (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.ui.hooks.ServerSideHook

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/hooks/class-use/SourcingHook.html b/docs/com/textkernel/tx/models/api/matching/ui/hooks/class-use/SourcingHook.html deleted file mode 100644 index 66a39594b..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/hooks/class-use/SourcingHook.html +++ /dev/null @@ -1,170 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.ui.hooks.SourcingHook (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.ui.hooks.SourcingHook

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/hooks/class-use/UrlAction.html b/docs/com/textkernel/tx/models/api/matching/ui/hooks/class-use/UrlAction.html deleted file mode 100644 index fb02a0425..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/hooks/class-use/UrlAction.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.ui.hooks.UrlAction (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.ui.hooks.UrlAction

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/hooks/class-use/UserActionHook.html b/docs/com/textkernel/tx/models/api/matching/ui/hooks/class-use/UserActionHook.html deleted file mode 100644 index 6706e7abc..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/hooks/class-use/UserActionHook.html +++ /dev/null @@ -1,181 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.ui.hooks.UserActionHook (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.ui.hooks.UserActionHook

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/hooks/class-use/UserActionHookCollection.html b/docs/com/textkernel/tx/models/api/matching/ui/hooks/class-use/UserActionHookCollection.html deleted file mode 100644 index 95d3cfc33..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/hooks/class-use/UserActionHookCollection.html +++ /dev/null @@ -1,169 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.ui.hooks.UserActionHookCollection (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.ui.hooks.UserActionHookCollection

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/hooks/package-frame.html b/docs/com/textkernel/tx/models/api/matching/ui/hooks/package-frame.html deleted file mode 100644 index f21c8d93b..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/hooks/package-frame.html +++ /dev/null @@ -1,27 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.matching.ui.hooks (Textkernel Tx Java SDK 2.3.3 API) - - - - - -

com.textkernel.tx.models.api.matching.ui.hooks

-
-

Classes

- -
- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/hooks/package-summary.html b/docs/com/textkernel/tx/models/api/matching/ui/hooks/package-summary.html deleted file mode 100644 index bcbce0ce8..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/hooks/package-summary.html +++ /dev/null @@ -1,183 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.matching.ui.hooks (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package com.textkernel.tx.models.api.matching.ui.hooks

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/hooks/package-tree.html b/docs/com/textkernel/tx/models/api/matching/ui/hooks/package-tree.html deleted file mode 100644 index 7c1cec9d3..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/hooks/package-tree.html +++ /dev/null @@ -1,151 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.matching.ui.hooks Class Hierarchy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package com.textkernel.tx.models.api.matching.ui.hooks

-Package Hierarchies: - -
-
-

Class Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/hooks/package-use.html b/docs/com/textkernel/tx/models/api/matching/ui/hooks/package-use.html deleted file mode 100644 index 5d6ca3175..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/hooks/package-use.html +++ /dev/null @@ -1,208 +0,0 @@ - - - - - - -Uses of Package com.textkernel.tx.models.api.matching.ui.hooks (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Package
com.textkernel.tx.models.api.matching.ui.hooks

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/package-frame.html b/docs/com/textkernel/tx/models/api/matching/ui/package-frame.html deleted file mode 100644 index a3c13718b..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/package-frame.html +++ /dev/null @@ -1,26 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.matching.ui (Textkernel Tx Java SDK 2.3.3 API) - - - - - -

com.textkernel.tx.models.api.matching.ui

-
-

Classes

- -
- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/package-summary.html b/docs/com/textkernel/tx/models/api/matching/ui/package-summary.html deleted file mode 100644 index e51162869..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/package-summary.html +++ /dev/null @@ -1,176 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.matching.ui (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package com.textkernel.tx.models.api.matching.ui

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/package-tree.html b/docs/com/textkernel/tx/models/api/matching/ui/package-tree.html deleted file mode 100644 index 8a1e047fb..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/package-tree.html +++ /dev/null @@ -1,144 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.matching.ui Class Hierarchy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package com.textkernel.tx.models.api.matching.ui

-Package Hierarchies: - -
-
-

Class Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/package-use.html b/docs/com/textkernel/tx/models/api/matching/ui/package-use.html deleted file mode 100644 index dae810e94..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/package-use.html +++ /dev/null @@ -1,218 +0,0 @@ - - - - - - -Uses of Package com.textkernel.tx.models.api.matching.ui (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Package
com.textkernel.tx.models.api.matching.ui

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/request/GenerateUIRequest.html b/docs/com/textkernel/tx/models/api/matching/ui/request/GenerateUIRequest.html deleted file mode 100644 index ca9506aa2..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/request/GenerateUIRequest.html +++ /dev/null @@ -1,303 +0,0 @@ - - - - - - -GenerateUIRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.matching.ui.request
-

Class GenerateUIRequest<T>

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        SaasRequest

        -
        public T SaasRequest
        -
        The SaaS request that defines the match/search.
        -
        • -
      -
      • -
    - - -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/request/MatchUISettings.html b/docs/com/textkernel/tx/models/api/matching/ui/request/MatchUISettings.html deleted file mode 100644 index 409b58891..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/request/MatchUISettings.html +++ /dev/null @@ -1,318 +0,0 @@ - - - - - - -MatchUISettings (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.matching.ui.request
-

Class MatchUISettings

-
-
- -
-
    -
  • -
    -
    Direct Known Subclasses:
    -
    GenerateUIRequest
    -
    -
    -
    -
    public class MatchUISettings
-extends Object
    -
    Settings for generating a Matching UI session
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        UIOptions

        -
        public UIOptions UIOptions
        -
        Various options for the Matching UI user experience
        -
        • -
      - - - -
        -
      • -

        ParseOptions

        -
        public BasicParseOptions ParseOptions
        -
        Options for parsing documents from external sources such as job boards - and custom web sourcing. You only need to use this if you are using Sourcing
        -
        • -
      - - - -
        -
      • -

        GeocodeOptions

        -
        public GeocodeOptions GeocodeOptions
        -
        Settings for geocoding within the Matching UI. This is used - when you allow your users to perform radius filtering.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        MatchUISettings

        -
        public MatchUISettings()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/request/UIBimetricScoreJobRequest.html b/docs/com/textkernel/tx/models/api/matching/ui/request/UIBimetricScoreJobRequest.html deleted file mode 100644 index 465d7aea7..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/request/UIBimetricScoreJobRequest.html +++ /dev/null @@ -1,274 +0,0 @@ - - - - - - -UIBimetricScoreJobRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api.matching.ui.request
-

Class UIBimetricScoreJobRequest

-
-
- -
- -
-
- -
-
- -
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/request/UIBimetricScoreResumeRequest.html b/docs/com/textkernel/tx/models/api/matching/ui/request/UIBimetricScoreResumeRequest.html deleted file mode 100644 index 0643bafed..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/request/UIBimetricScoreResumeRequest.html +++ /dev/null @@ -1,274 +0,0 @@ - - - - - - -UIBimetricScoreResumeRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api.matching.ui.request
-

Class UIBimetricScoreResumeRequest

-
-
- -
- -
-
- -
-
- -
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/request/UIMatchByDocumentIdOptions.html b/docs/com/textkernel/tx/models/api/matching/ui/request/UIMatchByDocumentIdOptions.html deleted file mode 100644 index db78cdbee..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/request/UIMatchByDocumentIdOptions.html +++ /dev/null @@ -1,274 +0,0 @@ - - - - - - -UIMatchByDocumentIdOptions (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api.matching.ui.request
-

Class UIMatchByDocumentIdOptions

-
-
- -
- -
-
- -
-
- -
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/request/UIMatchJobRequest.html b/docs/com/textkernel/tx/models/api/matching/ui/request/UIMatchJobRequest.html deleted file mode 100644 index bff8521be..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/request/UIMatchJobRequest.html +++ /dev/null @@ -1,274 +0,0 @@ - - - - - - -UIMatchJobRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api.matching.ui.request
-

Class UIMatchJobRequest

-
-
- -
- -
-
- -
-
- -
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/request/UIMatchResumeRequest.html b/docs/com/textkernel/tx/models/api/matching/ui/request/UIMatchResumeRequest.html deleted file mode 100644 index 0c6e4fb96..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/request/UIMatchResumeRequest.html +++ /dev/null @@ -1,274 +0,0 @@ - - - - - - -UIMatchResumeRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api.matching.ui.request
-

Class UIMatchResumeRequest

-
-
- -
- -
-
- -
-
- -
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/request/UISearchRequest.html b/docs/com/textkernel/tx/models/api/matching/ui/request/UISearchRequest.html deleted file mode 100644 index a7132e900..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/request/UISearchRequest.html +++ /dev/null @@ -1,274 +0,0 @@ - - - - - - -UISearchRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api.matching.ui.request
-

Class UISearchRequest

-
-
- -
- -
-
- -
-
- -
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/request/class-use/GenerateUIRequest.html b/docs/com/textkernel/tx/models/api/matching/ui/request/class-use/GenerateUIRequest.html deleted file mode 100644 index 53aaf3a0c..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/request/class-use/GenerateUIRequest.html +++ /dev/null @@ -1,198 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.ui.request.GenerateUIRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.ui.request.GenerateUIRequest

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/request/class-use/MatchUISettings.html b/docs/com/textkernel/tx/models/api/matching/ui/request/class-use/MatchUISettings.html deleted file mode 100644 index 92ef895bc..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/request/class-use/MatchUISettings.html +++ /dev/null @@ -1,264 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.ui.request.MatchUISettings (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.ui.request.MatchUISettings

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/request/class-use/UIBimetricScoreJobRequest.html b/docs/com/textkernel/tx/models/api/matching/ui/request/class-use/UIBimetricScoreJobRequest.html deleted file mode 100644 index a8a6ea6da..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/request/class-use/UIBimetricScoreJobRequest.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.ui.request.UIBimetricScoreJobRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.ui.request.UIBimetricScoreJobRequest

-
-
No usage of com.textkernel.tx.models.api.matching.ui.request.UIBimetricScoreJobRequest
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/request/class-use/UIBimetricScoreResumeRequest.html b/docs/com/textkernel/tx/models/api/matching/ui/request/class-use/UIBimetricScoreResumeRequest.html deleted file mode 100644 index b7eca4555..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/request/class-use/UIBimetricScoreResumeRequest.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.ui.request.UIBimetricScoreResumeRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.ui.request.UIBimetricScoreResumeRequest

-
-
No usage of com.textkernel.tx.models.api.matching.ui.request.UIBimetricScoreResumeRequest
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/request/class-use/UIMatchByDocumentIdOptions.html b/docs/com/textkernel/tx/models/api/matching/ui/request/class-use/UIMatchByDocumentIdOptions.html deleted file mode 100644 index c9e122723..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/request/class-use/UIMatchByDocumentIdOptions.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.ui.request.UIMatchByDocumentIdOptions (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.ui.request.UIMatchByDocumentIdOptions

-
-
No usage of com.textkernel.tx.models.api.matching.ui.request.UIMatchByDocumentIdOptions
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/request/class-use/UIMatchJobRequest.html b/docs/com/textkernel/tx/models/api/matching/ui/request/class-use/UIMatchJobRequest.html deleted file mode 100644 index 22453a630..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/request/class-use/UIMatchJobRequest.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.ui.request.UIMatchJobRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.ui.request.UIMatchJobRequest

-
-
No usage of com.textkernel.tx.models.api.matching.ui.request.UIMatchJobRequest
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/request/class-use/UIMatchResumeRequest.html b/docs/com/textkernel/tx/models/api/matching/ui/request/class-use/UIMatchResumeRequest.html deleted file mode 100644 index bc7788610..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/request/class-use/UIMatchResumeRequest.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.ui.request.UIMatchResumeRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.ui.request.UIMatchResumeRequest

-
-
No usage of com.textkernel.tx.models.api.matching.ui.request.UIMatchResumeRequest
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/request/class-use/UISearchRequest.html b/docs/com/textkernel/tx/models/api/matching/ui/request/class-use/UISearchRequest.html deleted file mode 100644 index 66538ca9c..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/request/class-use/UISearchRequest.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.matching.ui.request.UISearchRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.matching.ui.request.UISearchRequest

-
-
No usage of com.textkernel.tx.models.api.matching.ui.request.UISearchRequest
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/request/package-frame.html b/docs/com/textkernel/tx/models/api/matching/ui/request/package-frame.html deleted file mode 100644 index 5bd84f108..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/request/package-frame.html +++ /dev/null @@ -1,28 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.matching.ui.request (Textkernel Tx Java SDK 2.3.3 API) - - - - - -

com.textkernel.tx.models.api.matching.ui.request

-
-

Classes

- -
- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/request/package-summary.html b/docs/com/textkernel/tx/models/api/matching/ui/request/package-summary.html deleted file mode 100644 index a16af00bd..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/request/package-summary.html +++ /dev/null @@ -1,188 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.matching.ui.request (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package com.textkernel.tx.models.api.matching.ui.request

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/request/package-tree.html b/docs/com/textkernel/tx/models/api/matching/ui/request/package-tree.html deleted file mode 100644 index 0a56b1b8a..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/request/package-tree.html +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.matching.ui.request Class Hierarchy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package com.textkernel.tx.models.api.matching.ui.request

-Package Hierarchies: - -
-
-

Class Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/matching/ui/request/package-use.html b/docs/com/textkernel/tx/models/api/matching/ui/request/package-use.html deleted file mode 100644 index e11140d4a..000000000 --- a/docs/com/textkernel/tx/models/api/matching/ui/request/package-use.html +++ /dev/null @@ -1,187 +0,0 @@ - - - - - - -Uses of Package com.textkernel.tx.models.api.matching.ui.request (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Package
com.textkernel.tx.models.api.matching.ui.request

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/package-frame.html b/docs/com/textkernel/tx/models/api/package-frame.html deleted file mode 100644 index b9fe4b278..000000000 --- a/docs/com/textkernel/tx/models/api/package-frame.html +++ /dev/null @@ -1,28 +0,0 @@ - - - - - - -com.textkernel.tx.models.api (Textkernel Tx Java SDK 2.3.3 API) - - - - - -

com.textkernel.tx.models.api

-
-

Interfaces

- -

Classes

- -
- - diff --git a/docs/com/textkernel/tx/models/api/package-summary.html b/docs/com/textkernel/tx/models/api/package-summary.html deleted file mode 100644 index 86160c97e..000000000 --- a/docs/com/textkernel/tx/models/api/package-summary.html +++ /dev/null @@ -1,181 +0,0 @@ - - - - - - -com.textkernel.tx.models.api (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package com.textkernel.tx.models.api

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/package-tree.html b/docs/com/textkernel/tx/models/api/package-tree.html deleted file mode 100644 index 90dad20d8..000000000 --- a/docs/com/textkernel/tx/models/api/package-tree.html +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - -com.textkernel.tx.models.api Class Hierarchy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package com.textkernel.tx.models.api

-Package Hierarchies: - -
-
-

Class Hierarchy

- -

Interface Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/package-use.html b/docs/com/textkernel/tx/models/api/package-use.html deleted file mode 100644 index 00d2dafb2..000000000 --- a/docs/com/textkernel/tx/models/api/package-use.html +++ /dev/null @@ -1,550 +0,0 @@ - - - - - - -Uses of Package com.textkernel.tx.models.api (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Package
com.textkernel.tx.models.api

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/parsing/BaseParseResponseValue.html b/docs/com/textkernel/tx/models/api/parsing/BaseParseResponseValue.html deleted file mode 100644 index 66003e325..000000000 --- a/docs/com/textkernel/tx/models/api/parsing/BaseParseResponseValue.html +++ /dev/null @@ -1,385 +0,0 @@ - - - - - - -BaseParseResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.parsing
-

Class BaseParseResponseValue

-
-
- -
- -
-
- -
-
-
    -
  • - - - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        BaseParseResponseValue

        -
        public BaseParseResponseValue()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/parsing/BasicParseOptions.html b/docs/com/textkernel/tx/models/api/parsing/BasicParseOptions.html deleted file mode 100644 index beceeb885..000000000 --- a/docs/com/textkernel/tx/models/api/parsing/BasicParseOptions.html +++ /dev/null @@ -1,358 +0,0 @@ - - - - - - -BasicParseOptions (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.parsing
-

Class BasicParseOptions

-
-
- -
-
    -
  • -
    -
    Direct Known Subclasses:
    -
    ParseOptions
    -
    -
    -
    -
    public class BasicParseOptions
-extends Object
    -
    Basic parse options
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Configuration

        -
        public String Configuration
        -
        The configuration settings to use during parsing. See https://developer.textkernel.com/tx-platform/v10/resume-parser/overview/configuration/#config. -

        NOTE: leaving this null/empty will use the default parsing settings which is recommended in most cases.

        -
        • -
      - - - -
        -
      • -

        SkillsData

        -
        @Deprecated
-public List<String> SkillsData
        -
        Deprecated. use SkillsSettings instead
        -
        If you want to use custom skills lists during parsing, set those here. This not a recommended - feature for most customers. For more information, reach out to service@textkernel.com
        -
        • -
      - - - -
        -
      • -

        NormalizerData

        -
        @Deprecated
-public String NormalizerData
        -
        Deprecated. use SkillsSettings and ProfessionsSettings instead
        -
        If you want to use custom normalizations during parsing, set those here. This not a recommended - feature for most customers. For more information, reach out to service@textkernel.com
        -
        • -
      - - - -
        -
      • -

        SkillsSettings

        -
        public SkillsSettings SkillsSettings
        -
        Enable skills normalization and enhanced candidate summarization, and specify the version of the skills taxonomy for this parsing transaction.
        -
        • -
      - - - -
        -
      • -

        ProfessionsSettings

        -
        public ProfessionsSettings ProfessionsSettings
        -
        Enable normalization of job titles using our proprietary taxonomy and international standards.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        BasicParseOptions

        -
        public BasicParseOptions()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/parsing/ConversionMetadata.html b/docs/com/textkernel/tx/models/api/parsing/ConversionMetadata.html deleted file mode 100644 index 1f6de52bd..000000000 --- a/docs/com/textkernel/tx/models/api/parsing/ConversionMetadata.html +++ /dev/null @@ -1,345 +0,0 @@ - - - - - - -ConversionMetadata (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.parsing
-

Class ConversionMetadata

-
-
- -
-
    -
  • -
    -
    -
    public class ConversionMetadata
-extends Object
    -
    Information about a document conversion
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        DetectedType

        -
        public String DetectedType
        -
        The file type that was detected
        -
        • -
      - - - -
        -
      • -

        SuggestedFileExtension

        -
        public String SuggestedFileExtension
        -
        The suggested extension based on the DetectedType
        -
        • -
      - - - -
        -
      • -

        OutputValidityCode

        -
        public String OutputValidityCode
        -
        The computed validity based on the source text. This will indicate whether a document - looks like a legitimate resume/job or not. See https://developer.textkernel.com/tx-platform/v10/resume-parser/overview/document-conversion-code/
        -
        • -
      - - - - - - - -
        -
      • -

        DocumentHash

        -
        public String DocumentHash
        -
        The MD5 hash of the document bytes
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ConversionMetadata

        -
        public ConversionMetadata()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/parsing/Conversions.html b/docs/com/textkernel/tx/models/api/parsing/Conversions.html deleted file mode 100644 index 29ff2fde3..000000000 --- a/docs/com/textkernel/tx/models/api/parsing/Conversions.html +++ /dev/null @@ -1,346 +0,0 @@ - - - - - - -Conversions (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.parsing
-

Class Conversions

-
-
- -
-
    -
  • -
    -
    -
    public class Conversions
-extends Object
    -
    Conversions output by the document converter during a parse transaction
    -
    • -
-
-
- -
-
- -
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/parsing/FlexRequest.html b/docs/com/textkernel/tx/models/api/parsing/FlexRequest.html deleted file mode 100644 index a61f83fe2..000000000 --- a/docs/com/textkernel/tx/models/api/parsing/FlexRequest.html +++ /dev/null @@ -1,329 +0,0 @@ - - - - - - -FlexRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.parsing
-

Class FlexRequest

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Prompt

        -
        public String Prompt
        -
        The prompt to be sent to the LLM Parsing Engine
        -
        • -
      - - - -
        -
      • -

        Identifier

        -
        public String Identifier
        -
        Unique field name to be returned alongside the reply in the response
        -
        • -
      - - - - - - - - -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        FlexRequest

        -
        public FlexRequest()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/parsing/FlexRequestDataType.html b/docs/com/textkernel/tx/models/api/parsing/FlexRequestDataType.html deleted file mode 100644 index d6b525183..000000000 --- a/docs/com/textkernel/tx/models/api/parsing/FlexRequestDataType.html +++ /dev/null @@ -1,395 +0,0 @@ - - - - - - -FlexRequestDataType (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.parsing
-

Enum FlexRequestDataType

-
-
- -
- -
-
- -
-
-
    -
  • - - - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        values

        -
        public static FlexRequestDataType[] values()
        -
        Returns an array containing the constants of this enum type, in -the order they are declared. This method may be used to iterate -over the constants as follows: -
        -for (FlexRequestDataType c : FlexRequestDataType.values())
-    System.out.println(c);
-
        -
        -
        Returns:
        -
        an array containing the constants of this enum type, in the order they are declared
        -
        -
        • -
      - - - -
        -
      • -

        valueOf

        -
        public static FlexRequestDataType valueOf(String name)
        -
        Returns the enum constant of this type with the specified name. -The string must match exactly an identifier used to declare an -enum constant in this type. (Extraneous whitespace characters are -not permitted.)
        -
        -
        Parameters:
        -
        name - the name of the enum constant to be returned.
        -
        Returns:
        -
        the enum constant with the specified name
        -
        Throws:
        -
        IllegalArgumentException - if this enum type has no constant with the specified name
        -
        NullPointerException - if the argument is null
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/parsing/FlexResponse.html b/docs/com/textkernel/tx/models/api/parsing/FlexResponse.html deleted file mode 100644 index 0d991f6da..000000000 --- a/docs/com/textkernel/tx/models/api/parsing/FlexResponse.html +++ /dev/null @@ -1,345 +0,0 @@ - - - - - - -FlexResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.parsing
-

Class FlexResponse

-
-
- -
-
    -
  • -
    -
    -
    public class FlexResponse
-extends Object
    -
    Information about the FlexRequests transaction, if any were provided.
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Code

        -
        public String Code
        -
        See https://developer.textkernel.com/tx-platform/v10/overview/#http-status-codes
        -
        • -
      - - - -
        -
      • -

        Message

        -
        public String Message
        -
        A short human-readable description explaining the Code value
        -
        • -
      - - - - -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        FlexResponse

        -
        public FlexResponse()
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        isSuccess

        -
        public boolean isSuccess()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/parsing/FlexResponseItem.html b/docs/com/textkernel/tx/models/api/parsing/FlexResponseItem.html deleted file mode 100644 index bb8d66907..000000000 --- a/docs/com/textkernel/tx/models/api/parsing/FlexResponseItem.html +++ /dev/null @@ -1,311 +0,0 @@ - - - - - - -FlexResponseItem (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.parsing
-

Class FlexResponseItem

-
-
- -
-
    -
  • -
    -
    -
    public class FlexResponseItem
-extends Object
    -
    Responses to FlexRequests
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Identifier

        -
        public String Identifier
        -
        Unique field name assigned to the respective FlexRequest
        -
        • -
      - - - -
        -
      • -

        Reply

        -
        public String Reply
        -
        Reply to the FlexRequest Prompt
        -
        • -
      - - - - -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        FlexResponseItem

        -
        public FlexResponseItem()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/parsing/ParseJobResponse.html b/docs/com/textkernel/tx/models/api/parsing/ParseJobResponse.html deleted file mode 100644 index 578b23b8a..000000000 --- a/docs/com/textkernel/tx/models/api/parsing/ParseJobResponse.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - -ParseJobResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api.parsing
-

Class ParseJobResponse

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ParseJobResponse

        -
        public ParseJobResponse()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/parsing/ParseJobResponseValue.html b/docs/com/textkernel/tx/models/api/parsing/ParseJobResponseValue.html deleted file mode 100644 index 06ed911ca..000000000 --- a/docs/com/textkernel/tx/models/api/parsing/ParseJobResponseValue.html +++ /dev/null @@ -1,291 +0,0 @@ - - - - - - -ParseJobResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.parsing
-

Class ParseJobResponseValue

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        JobData

        -
        public ParsedJob JobData
        -
        The main output from the Job Parser
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ParseJobResponseValue

        -
        public ParseJobResponseValue()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/parsing/ParseOptions.html b/docs/com/textkernel/tx/models/api/parsing/ParseOptions.html deleted file mode 100644 index cd4837746..000000000 --- a/docs/com/textkernel/tx/models/api/parsing/ParseOptions.html +++ /dev/null @@ -1,428 +0,0 @@ - - - - - - -ParseOptions (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.parsing
-

Class ParseOptions

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        OutputHtml

        -
        public boolean OutputHtml
        -
        true to output the document converted to HTML
        -
        • -
      - - - -
        -
      • -

        HideHtmlImages

        -
        public boolean HideHtmlImages
        -
        true to remove any images in the converted HTML
        -
        • -
      - - - -
        -
      • -

        OutputRtf

        -
        public boolean OutputRtf
        -
        true to output the document converted to RTF
        -
        • -
      - - - -
        -
      • -

        OutputPdf

        -
        public boolean OutputPdf
        -
        true to output the document converted to PDF
        -
        • -
      - - - -
        -
      • -

        OutputCandidateImage

        -
        public boolean OutputCandidateImage
        -
        Only used for resumes. true to extract/output a candidate's image if it is present in the resume.
        -
        • -
      - - - -
        -
      • -

        GeocodeOptions

        -
        public GeocodeOptions GeocodeOptions
        -
        Use this property to also include geocoding in this parse request. The document will be parsed and then geocoded.
        -
        • -
      - - - -
        -
      • -

        IndexingOptions

        -
        public IndexSingleDocumentInfo IndexingOptions
        -
        If you are using AI Matching, use this property to also index the document after it is parsed/geocoded. - This means you only need to send the document to our API once instead of twice for parsing+indexing.
        -
        • -
      - - - -
        -
      • -

        UseLLMParser

        -
        public boolean UseLLMParser
        -
        Only used for resumes. When true, and the document is English, the LLM Parser will be used. - See the overview documentation for more information. - Additional charges will apply.
        -
        • -
      - - - - -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ParseOptions

        -
        public ParseOptions()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/parsing/ParseRequest.html b/docs/com/textkernel/tx/models/api/parsing/ParseRequest.html deleted file mode 100644 index f52078984..000000000 --- a/docs/com/textkernel/tx/models/api/parsing/ParseRequest.html +++ /dev/null @@ -1,338 +0,0 @@ - - - - - - -ParseRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.parsing
-

Class ParseRequest

-
-
- -
-
    -
  • -
    -
    -
    public class ParseRequest
-extends ParseOptions
    -
    The request body for a Parse request
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - - - - - -
        -
      • -

        DocumentLastModified

        -
        public String DocumentLastModified
        -
        Mandatory date - in ISO 8601 (yyyy-MM-dd) format - so that the Parser knows how to interpret dates in the document - that are expressed as "current" or "as of" or similar. It is crucial that we know the date of the resume/CV so - that we can correctly calculate date spans. For example, a resume received on January 5, 2019 should be passed - with a DocumentLastModified of "2019-01-05"; if, however, it was modified on May 7, 2019, the DocumentLastModified should be - passed as "2019-05-07". Failing to pass a DocumentLastModified, or passing DocumentLastModified that are clearly improbable, may - result in rejection of data and/or additional charges, and will utterly decimate the usefulness of AI Matching and - any generated metadata.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ParseRequest

        -
        public ParseRequest(Document doc,
-                    ParseOptions optionsToUse)
        -
        -
        Parameters:
        -
        doc - The document (resume or job) to parse
        -
        optionsToUse - Any non-default options to use (null for default)
        -
        Throws:
        -
        IllegalArgumentException - if the document is null
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/parsing/ParseResumeResponse.html b/docs/com/textkernel/tx/models/api/parsing/ParseResumeResponse.html deleted file mode 100644 index 3433a6b00..000000000 --- a/docs/com/textkernel/tx/models/api/parsing/ParseResumeResponse.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - -ParseResumeResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.api.parsing
-

Class ParseResumeResponse

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ParseResumeResponse

        -
        public ParseResumeResponse()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/parsing/ParseResumeResponseValue.html b/docs/com/textkernel/tx/models/api/parsing/ParseResumeResponseValue.html deleted file mode 100644 index f86c3834c..000000000 --- a/docs/com/textkernel/tx/models/api/parsing/ParseResumeResponseValue.html +++ /dev/null @@ -1,342 +0,0 @@ - - - - - - -ParseResumeResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.parsing
-

Class ParseResumeResponseValue

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        ResumeData

        -
        public ParsedResume ResumeData
        -
        The main output from the Resume Parser
        -
        • -
      - - - - - - - -
        -
      • -

        FlexResponse

        -
        public FlexResponse FlexResponse
        -
        Information about the FlexRequests transaction, if any were provided.
        -
        • -
      - - - -
        -
      • -

        EducationNormalizationResponse

        -
        public ApiResponseInfoLite EducationNormalizationResponse
        -
        Information about the status of education normalization during the parse
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ParseResumeResponseValue

        -
        public ParseResumeResponseValue()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/parsing/ParsingMetadata.html b/docs/com/textkernel/tx/models/api/parsing/ParsingMetadata.html deleted file mode 100644 index 2f9d71c88..000000000 --- a/docs/com/textkernel/tx/models/api/parsing/ParsingMetadata.html +++ /dev/null @@ -1,344 +0,0 @@ - - - - - - -ParsingMetadata (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.parsing
-

Class ParsingMetadata

-
-
- -
-
    -
  • -
    -
    -
    public class ParsingMetadata
-extends Object
    -
    Metadata about a parsing transaction
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        ParserVersion

        -
        public String ParserVersion
        -
        The version of the SaaS parser
        -
        • -
      - - - - - - - -
        -
      • -

        TimedOut

        -
        public boolean TimedOut
        -
        Whether or not the transaction timed out. If this is true, the returned data may be incomplete
        -
        • -
      - - - -
        -
      • -

        TimedOutAtMilliseconds

        -
        public TxPrimitive<Integer> TimedOutAtMilliseconds
        -
        If TimedOut is true, this is how much time was spent parsing before the timeout occurred
        -
        • -
      - - - -
        -
      • -

        LicenseSerialNumber

        -
        public String LicenseSerialNumber
        -
        For self-hosted customers only. The serial number of the current license being used for parsing.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ParsingMetadata

        -
        public ParsingMetadata()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/parsing/ProfessionsSettings.html b/docs/com/textkernel/tx/models/api/parsing/ProfessionsSettings.html deleted file mode 100644 index d9e8aedb6..000000000 --- a/docs/com/textkernel/tx/models/api/parsing/ProfessionsSettings.html +++ /dev/null @@ -1,305 +0,0 @@ - - - - - - -ProfessionsSettings (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.parsing
-

Class ProfessionsSettings

-
-
- -
-
    -
  • -
    -
    -
    public class ProfessionsSettings
-extends Object
    -
    Enable normalization of job titles using our proprietary taxonomy and international standards.
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Normalize

        -
        public boolean Normalize
        -
        When true, the most recent 3 job titles 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 AI Matching, normalized professions are automatically indexed and used if enabled. To also leverage profession - normalization for user-created searches, enable SearchMatchSettings.NormalizeJobTitles. -

        - 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.

        -
        • -
      - - - -
        -
      • -

        Version

        -
        public ProfessionNormalizationVersions Version
        -
        Specifies the versions to use when normalizing professions if more than one is available for a taxonomy.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ProfessionsSettings

        -
        public ProfessionsSettings()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/parsing/SkillsSettings.html b/docs/com/textkernel/tx/models/api/parsing/SkillsSettings.html deleted file mode 100644 index 318861062..000000000 --- a/docs/com/textkernel/tx/models/api/parsing/SkillsSettings.html +++ /dev/null @@ -1,318 +0,0 @@ - - - - - - -SkillsSettings (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.api.parsing
-

Class SkillsSettings

-
-
- -
-
    -
  • -
    -
    -
    public class SkillsSettings
-extends Object
    -
    Enable skills normalization and enhanced candidate summarization, and specify the version of the skills taxonomy for this parsing transaction.
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - - - - - -
        -
      • -

        TaxonomyVersion

        -
        public String TaxonomyVersion
        -
        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.
          • -
        -

        - Benefits of V2 include: -

          -
        • 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).
          • -
        • Improved candidate summary.
          • -
        • 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.
          • -
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        SkillsSettings

        -
        public SkillsSettings()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/parsing/class-use/BaseParseResponseValue.html b/docs/com/textkernel/tx/models/api/parsing/class-use/BaseParseResponseValue.html deleted file mode 100644 index 70cb7b8e9..000000000 --- a/docs/com/textkernel/tx/models/api/parsing/class-use/BaseParseResponseValue.html +++ /dev/null @@ -1,174 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.parsing.BaseParseResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.parsing.BaseParseResponseValue

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/parsing/class-use/BasicParseOptions.html b/docs/com/textkernel/tx/models/api/parsing/class-use/BasicParseOptions.html deleted file mode 100644 index 8e4fb98a1..000000000 --- a/docs/com/textkernel/tx/models/api/parsing/class-use/BasicParseOptions.html +++ /dev/null @@ -1,199 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.parsing.BasicParseOptions (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.parsing.BasicParseOptions

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/parsing/class-use/ConversionMetadata.html b/docs/com/textkernel/tx/models/api/parsing/class-use/ConversionMetadata.html deleted file mode 100644 index 955500206..000000000 --- a/docs/com/textkernel/tx/models/api/parsing/class-use/ConversionMetadata.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.parsing.ConversionMetadata (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.parsing.ConversionMetadata

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/parsing/class-use/Conversions.html b/docs/com/textkernel/tx/models/api/parsing/class-use/Conversions.html deleted file mode 100644 index 17a70b59f..000000000 --- a/docs/com/textkernel/tx/models/api/parsing/class-use/Conversions.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.parsing.Conversions (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.parsing.Conversions

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/parsing/class-use/FlexRequest.html b/docs/com/textkernel/tx/models/api/parsing/class-use/FlexRequest.html deleted file mode 100644 index cdb9b2225..000000000 --- a/docs/com/textkernel/tx/models/api/parsing/class-use/FlexRequest.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.parsing.FlexRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.parsing.FlexRequest

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/parsing/class-use/FlexRequestDataType.html b/docs/com/textkernel/tx/models/api/parsing/class-use/FlexRequestDataType.html deleted file mode 100644 index 7841be887..000000000 --- a/docs/com/textkernel/tx/models/api/parsing/class-use/FlexRequestDataType.html +++ /dev/null @@ -1,190 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.parsing.FlexRequestDataType (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.parsing.FlexRequestDataType

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/parsing/class-use/FlexResponse.html b/docs/com/textkernel/tx/models/api/parsing/class-use/FlexResponse.html deleted file mode 100644 index d0b901ced..000000000 --- a/docs/com/textkernel/tx/models/api/parsing/class-use/FlexResponse.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.parsing.FlexResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.parsing.FlexResponse

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/parsing/class-use/FlexResponseItem.html b/docs/com/textkernel/tx/models/api/parsing/class-use/FlexResponseItem.html deleted file mode 100644 index b0cb47f4e..000000000 --- a/docs/com/textkernel/tx/models/api/parsing/class-use/FlexResponseItem.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.parsing.FlexResponseItem (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.parsing.FlexResponseItem

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/parsing/class-use/ParseJobResponse.html b/docs/com/textkernel/tx/models/api/parsing/class-use/ParseJobResponse.html deleted file mode 100644 index 8d30050a8..000000000 --- a/docs/com/textkernel/tx/models/api/parsing/class-use/ParseJobResponse.html +++ /dev/null @@ -1,224 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.parsing.ParseJobResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.parsing.ParseJobResponse

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/parsing/class-use/ParseJobResponseValue.html b/docs/com/textkernel/tx/models/api/parsing/class-use/ParseJobResponseValue.html deleted file mode 100644 index a30b0f0f9..000000000 --- a/docs/com/textkernel/tx/models/api/parsing/class-use/ParseJobResponseValue.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.parsing.ParseJobResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.parsing.ParseJobResponseValue

-
-
No usage of com.textkernel.tx.models.api.parsing.ParseJobResponseValue
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/parsing/class-use/ParseOptions.html b/docs/com/textkernel/tx/models/api/parsing/class-use/ParseOptions.html deleted file mode 100644 index afcf17366..000000000 --- a/docs/com/textkernel/tx/models/api/parsing/class-use/ParseOptions.html +++ /dev/null @@ -1,180 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.parsing.ParseOptions (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.parsing.ParseOptions

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/parsing/class-use/ParseRequest.html b/docs/com/textkernel/tx/models/api/parsing/class-use/ParseRequest.html deleted file mode 100644 index 5e2c887cc..000000000 --- a/docs/com/textkernel/tx/models/api/parsing/class-use/ParseRequest.html +++ /dev/null @@ -1,174 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.parsing.ParseRequest (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.parsing.ParseRequest

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/parsing/class-use/ParseResumeResponse.html b/docs/com/textkernel/tx/models/api/parsing/class-use/ParseResumeResponse.html deleted file mode 100644 index 427102380..000000000 --- a/docs/com/textkernel/tx/models/api/parsing/class-use/ParseResumeResponse.html +++ /dev/null @@ -1,224 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.parsing.ParseResumeResponse (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.parsing.ParseResumeResponse

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/parsing/class-use/ParseResumeResponseValue.html b/docs/com/textkernel/tx/models/api/parsing/class-use/ParseResumeResponseValue.html deleted file mode 100644 index 3fe70aed5..000000000 --- a/docs/com/textkernel/tx/models/api/parsing/class-use/ParseResumeResponseValue.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.parsing.ParseResumeResponseValue (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.parsing.ParseResumeResponseValue

-
-
No usage of com.textkernel.tx.models.api.parsing.ParseResumeResponseValue
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/parsing/class-use/ParsingMetadata.html b/docs/com/textkernel/tx/models/api/parsing/class-use/ParsingMetadata.html deleted file mode 100644 index a4ddbfe37..000000000 --- a/docs/com/textkernel/tx/models/api/parsing/class-use/ParsingMetadata.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.parsing.ParsingMetadata (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.parsing.ParsingMetadata

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/parsing/class-use/ProfessionsSettings.html b/docs/com/textkernel/tx/models/api/parsing/class-use/ProfessionsSettings.html deleted file mode 100644 index 452615560..000000000 --- a/docs/com/textkernel/tx/models/api/parsing/class-use/ProfessionsSettings.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.parsing.ProfessionsSettings (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.parsing.ProfessionsSettings

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/parsing/class-use/SkillsSettings.html b/docs/com/textkernel/tx/models/api/parsing/class-use/SkillsSettings.html deleted file mode 100644 index f6bda38d8..000000000 --- a/docs/com/textkernel/tx/models/api/parsing/class-use/SkillsSettings.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.api.parsing.SkillsSettings (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.api.parsing.SkillsSettings

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/parsing/package-frame.html b/docs/com/textkernel/tx/models/api/parsing/package-frame.html deleted file mode 100644 index d4af3e969..000000000 --- a/docs/com/textkernel/tx/models/api/parsing/package-frame.html +++ /dev/null @@ -1,40 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.parsing (Textkernel Tx Java SDK 2.3.3 API) - - - - - -

com.textkernel.tx.models.api.parsing

-
-

Classes

- -

Enums

- -
- - diff --git a/docs/com/textkernel/tx/models/api/parsing/package-summary.html b/docs/com/textkernel/tx/models/api/parsing/package-summary.html deleted file mode 100644 index d450c980c..000000000 --- a/docs/com/textkernel/tx/models/api/parsing/package-summary.html +++ /dev/null @@ -1,253 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.parsing (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package com.textkernel.tx.models.api.parsing

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/parsing/package-tree.html b/docs/com/textkernel/tx/models/api/parsing/package-tree.html deleted file mode 100644 index bb982ebaf..000000000 --- a/docs/com/textkernel/tx/models/api/parsing/package-tree.html +++ /dev/null @@ -1,179 +0,0 @@ - - - - - - -com.textkernel.tx.models.api.parsing Class Hierarchy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package com.textkernel.tx.models.api.parsing

-Package Hierarchies: - -
-
-

Class Hierarchy

- -

Enum Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/api/parsing/package-use.html b/docs/com/textkernel/tx/models/api/parsing/package-use.html deleted file mode 100644 index aae06efcc..000000000 --- a/docs/com/textkernel/tx/models/api/parsing/package-use.html +++ /dev/null @@ -1,294 +0,0 @@ - - - - - - -Uses of Package com.textkernel.tx.models.api.parsing (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Package
com.textkernel.tx.models.api.parsing

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/class-use/Document.html b/docs/com/textkernel/tx/models/class-use/Document.html deleted file mode 100644 index 471e91721..000000000 --- a/docs/com/textkernel/tx/models/class-use/Document.html +++ /dev/null @@ -1,165 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.Document (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.Document

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/class-use/GeoCoordinates.html b/docs/com/textkernel/tx/models/class-use/GeoCoordinates.html deleted file mode 100644 index 2e28f68dd..000000000 --- a/docs/com/textkernel/tx/models/class-use/GeoCoordinates.html +++ /dev/null @@ -1,254 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.GeoCoordinates (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.GeoCoordinates

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/class-use/GeocodedCoordinates.html b/docs/com/textkernel/tx/models/class-use/GeocodedCoordinates.html deleted file mode 100644 index 5d038bb82..000000000 --- a/docs/com/textkernel/tx/models/class-use/GeocodedCoordinates.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.GeocodedCoordinates (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.GeocodedCoordinates

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/class-use/Location.html b/docs/com/textkernel/tx/models/class-use/Location.html deleted file mode 100644 index 630ce8e0f..000000000 --- a/docs/com/textkernel/tx/models/class-use/Location.html +++ /dev/null @@ -1,264 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.Location (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.Location

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/class-use/ParsedDocument.html b/docs/com/textkernel/tx/models/class-use/ParsedDocument.html deleted file mode 100644 index 6a388b55e..000000000 --- a/docs/com/textkernel/tx/models/class-use/ParsedDocument.html +++ /dev/null @@ -1,192 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.ParsedDocument (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.ParsedDocument

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/class-use/ParsedDocumentMetadata.html b/docs/com/textkernel/tx/models/class-use/ParsedDocumentMetadata.html deleted file mode 100644 index 71af83879..000000000 --- a/docs/com/textkernel/tx/models/class-use/ParsedDocumentMetadata.html +++ /dev/null @@ -1,192 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.ParsedDocumentMetadata (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.ParsedDocumentMetadata

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/class-use/TxDate.html b/docs/com/textkernel/tx/models/class-use/TxDate.html deleted file mode 100644 index 39d9efe61..000000000 --- a/docs/com/textkernel/tx/models/class-use/TxDate.html +++ /dev/null @@ -1,278 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.TxDate (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.TxDate

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/class-use/TxPrimitive.html b/docs/com/textkernel/tx/models/class-use/TxPrimitive.html deleted file mode 100644 index 6b16abb7b..000000000 --- a/docs/com/textkernel/tx/models/class-use/TxPrimitive.html +++ /dev/null @@ -1,378 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.TxPrimitive (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.TxPrimitive

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/dataenrichment/BasicProfession.html b/docs/com/textkernel/tx/models/dataenrichment/BasicProfession.html deleted file mode 100644 index 2f3dc18f8..000000000 --- a/docs/com/textkernel/tx/models/dataenrichment/BasicProfession.html +++ /dev/null @@ -1,299 +0,0 @@ - - - - - - -BasicProfession (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.dataenrichment
-

Class BasicProfession

-
-
- -
-
    -
  • -
    -
    Direct Known Subclasses:
    -
    Profession
    -
    -
    -
    -
    public class BasicProfession
-extends Object
    -
    A profession ID/description from the Professions Taxonomy.
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - - - - - -
        -
      • -

        Description

        -
        public String Description
        -
        The description of the profession in the desired language.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        BasicProfession

        -
        public BasicProfession()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/dataenrichment/ExtractedSkill.html b/docs/com/textkernel/tx/models/dataenrichment/ExtractedSkill.html deleted file mode 100644 index 8e9e4774d..000000000 --- a/docs/com/textkernel/tx/models/dataenrichment/ExtractedSkill.html +++ /dev/null @@ -1,303 +0,0 @@ - - - - - - -ExtractedSkill (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.dataenrichment
-

Class ExtractedSkill

-
-
- -
-
    -
  • -
    -
    -
    public class ExtractedSkill
-extends SkillAndConfidence
    -
    An extracted, normalized skill from the Skills taxonomy.
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Matches

        -
        public List<SkillMatch> Matches
        -
        A list of matches where this skill was found in the text.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ExtractedSkill

        -
        public ExtractedSkill()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/dataenrichment/LangDescription.html b/docs/com/textkernel/tx/models/dataenrichment/LangDescription.html deleted file mode 100644 index a5700003a..000000000 --- a/docs/com/textkernel/tx/models/dataenrichment/LangDescription.html +++ /dev/null @@ -1,295 +0,0 @@ - - - - - - -LangDescription (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.dataenrichment
-

Class LangDescription

-
-
- -
-
    -
  • -
    -
    -
    public class LangDescription
-extends Object
    -
    The description in thed particular language.
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        IsoCode

        -
        public String IsoCode
        -
        The ISO code for the language of the description.
        -
        • -
      - - - -
        -
      • -

        Description

        -
        public String Description
        -
        The description in the particular language.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        LangDescription

        -
        public LangDescription()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/dataenrichment/NormalizedProfession.html b/docs/com/textkernel/tx/models/dataenrichment/NormalizedProfession.html deleted file mode 100644 index 70150e1b0..000000000 --- a/docs/com/textkernel/tx/models/dataenrichment/NormalizedProfession.html +++ /dev/null @@ -1,303 +0,0 @@ - - - - - - -NormalizedProfession (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.dataenrichment
-

Class NormalizedProfession

-
-
- -
-
    -
  • -
    -
    -
    public class NormalizedProfession
-extends Profession
    -
    A normalized profession and the confidence that the normalization is correct/fitting
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Confidence

        -
        public float Confidence
        -
        A value from [0 - 1] indicating how well the input job title matched to the normalized profession.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        NormalizedProfession

        -
        public NormalizedProfession()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/dataenrichment/NormalizedSkill.html b/docs/com/textkernel/tx/models/dataenrichment/NormalizedSkill.html deleted file mode 100644 index f52b3fa85..000000000 --- a/docs/com/textkernel/tx/models/dataenrichment/NormalizedSkill.html +++ /dev/null @@ -1,303 +0,0 @@ - - - - - - -NormalizedSkill (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.dataenrichment
-

Class NormalizedSkill

-
-
- -
-
    -
  • -
    -
    -
    public class NormalizedSkill
-extends SkillAndConfidence
    -
    A normalized skill object.
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        RawText

        -
        public String RawText
        -
        The raw text that matched to a skill description in the provided language.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        NormalizedSkill

        -
        public NormalizedSkill()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/dataenrichment/Profession.html b/docs/com/textkernel/tx/models/dataenrichment/Profession.html deleted file mode 100644 index 4d5f2932c..000000000 --- a/docs/com/textkernel/tx/models/dataenrichment/Profession.html +++ /dev/null @@ -1,407 +0,0 @@ - - - - - - -Profession (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.dataenrichment
-

Class Profession

-
-
- -
- -
-
- -
-
- -
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/dataenrichment/ProfessionClassification.html b/docs/com/textkernel/tx/models/dataenrichment/ProfessionClassification.html deleted file mode 100644 index 39e661d6e..000000000 --- a/docs/com/textkernel/tx/models/dataenrichment/ProfessionClassification.html +++ /dev/null @@ -1,299 +0,0 @@ - - - - - - -ProfessionClassification (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.dataenrichment
-

Class ProfessionClassification<T>

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        CodeId

        -
        public T CodeId
        -
        The code id of the profession concept.
        -
        • -
      - - - -
        -
      • -

        Description

        -
        public String Description
        -
        The description of the profession concept.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ProfessionClassification

        -
        public ProfessionClassification()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/dataenrichment/ProfessionMultipleDescriptions.html b/docs/com/textkernel/tx/models/dataenrichment/ProfessionMultipleDescriptions.html deleted file mode 100644 index 7e9857f08..000000000 --- a/docs/com/textkernel/tx/models/dataenrichment/ProfessionMultipleDescriptions.html +++ /dev/null @@ -1,306 +0,0 @@ - - - - - - -ProfessionMultipleDescriptions (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.dataenrichment
-

Class ProfessionMultipleDescriptions

-
-
- -
-
    -
  • -
    -
    -
    public class ProfessionMultipleDescriptions
-extends Profession
    -
    A skill object.
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Descriptions

        -
        public List<LangDescription> Descriptions
        -
        A list of descriptions of the skill in all supported/requested languages.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ProfessionMultipleDescriptions

        -
        public ProfessionMultipleDescriptions()
        -
        The description of the skill in the requested language.
        NOTE: if multiple languages were requested, this is simply the first from Descriptions
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/dataenrichment/Skill.html b/docs/com/textkernel/tx/models/dataenrichment/Skill.html deleted file mode 100644 index 8bdee3b9c..000000000 --- a/docs/com/textkernel/tx/models/dataenrichment/Skill.html +++ /dev/null @@ -1,331 +0,0 @@ - - - - - - -Skill (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.dataenrichment
-

Class Skill

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Description

        -
        public String Description
        -
        The description of the skill in the requested language.
        -
        • -
      - - - -
        -
      • -

        Id

        -
        public String Id
        -
        The ID of the skill in the taxonomy.
        -
        • -
      - - - -
        -
      • -

        Type

        -
        public String Type
        -
        Type of skill. Possible values are Professional, IT, Language, Soft, or Certification (only when using v2 endpoints).
        -
        • -
      - - - -
        -
      • -

        IsoCode

        -
        public String IsoCode
        -
        The language ISO 639-1 code. This will only appear for language skills (Type = Language).
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        Skill

        -
        public Skill()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/dataenrichment/SkillAndConfidence.html b/docs/com/textkernel/tx/models/dataenrichment/SkillAndConfidence.html deleted file mode 100644 index 2b6cf2ed8..000000000 --- a/docs/com/textkernel/tx/models/dataenrichment/SkillAndConfidence.html +++ /dev/null @@ -1,295 +0,0 @@ - - - - - - -SkillAndConfidence (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.dataenrichment
-

Class SkillAndConfidence

-
-
- -
-
    -
  • -
    -
    Direct Known Subclasses:
    -
    ExtractedSkill, NormalizedSkill
    -
    -
    -
    -
    public class SkillAndConfidence
-extends Skill
    -
    A skill from the skill taxonomy, and the confidence that this is the correct skill for the given input.
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Confidence

        -
        public float Confidence
        -
        Overall confidence that the skill was normalized to the correct skill.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        SkillAndConfidence

        -
        public SkillAndConfidence()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/dataenrichment/SkillMatch.html b/docs/com/textkernel/tx/models/dataenrichment/SkillMatch.html deleted file mode 100644 index 30c0646b9..000000000 --- a/docs/com/textkernel/tx/models/dataenrichment/SkillMatch.html +++ /dev/null @@ -1,327 +0,0 @@ - - - - - - -SkillMatch (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.dataenrichment
-

Class SkillMatch

-
-
- -
-
    -
  • -
    -
    -
    public class SkillMatch
-extends Object
    -
    A matched skill that was found in the text provided.
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Field Summary

      - - - - - - - - - - - - - - - - - - - - - - -
      Fields 
      Modifier and TypeField and Description
      intBeginSpan -
      The index of the first character of the match (0-based).
      -
      intEndSpan -
      The index of the last character of the match (0-based).
      -
      floatLikelihood -
      Likelihood that the matched term actually refers to a skill in the context of the text.
      -
      StringRawText -
      The actual term that was found as evidence of this skill (the substring from BeginSpan to EndSpan).
      -
      -
      • -
    - -
      -
    • - - -

      Constructor Summary

      - - - - - - - - -
      Constructors 
      Constructor and Description
      SkillMatch() 
      -
      • -
    - - -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        BeginSpan

        -
        public int BeginSpan
        -
        The index of the first character of the match (0-based).
        -
        • -
      - - - -
        -
      • -

        EndSpan

        -
        public int EndSpan
        -
        The index of the last character of the match (0-based).
        -
        • -
      - - - -
        -
      • -

        Likelihood

        -
        public float Likelihood
        -
        Likelihood that the matched term actually refers to a skill in the context of the text.
        -
        • -
      - - - -
        -
      • -

        RawText

        -
        public String RawText
        -
        The actual term that was found as evidence of this skill (the substring from BeginSpan to EndSpan).
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        SkillMatch

        -
        public SkillMatch()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/dataenrichment/SkillMultipleDescriptions.html b/docs/com/textkernel/tx/models/dataenrichment/SkillMultipleDescriptions.html deleted file mode 100644 index 98805b311..000000000 --- a/docs/com/textkernel/tx/models/dataenrichment/SkillMultipleDescriptions.html +++ /dev/null @@ -1,294 +0,0 @@ - - - - - - -SkillMultipleDescriptions (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.dataenrichment
-

Class SkillMultipleDescriptions

-
-
- -
-
    -
  • -
    -
    -
    public class SkillMultipleDescriptions
-extends Skill
    -
    A skill object.
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Descriptions

        -
        public List<LangDescription> Descriptions
        -
        A list of descriptions of the skill in all supported/requested languages.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        SkillMultipleDescriptions

        -
        public SkillMultipleDescriptions()
        -
        The description of the skill in the requested language.
        NOTE: if multiple languages were requested, this is simply the first from Descriptions
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/dataenrichment/Taxonomy.html b/docs/com/textkernel/tx/models/dataenrichment/Taxonomy.html deleted file mode 100644 index a18bfcd74..000000000 --- a/docs/com/textkernel/tx/models/dataenrichment/Taxonomy.html +++ /dev/null @@ -1,283 +0,0 @@ - - - - - - -Taxonomy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.dataenrichment
-

Class Taxonomy

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        CsvOutput

        -
        public String CsvOutput
        -
        If TaxonomyFormat.csv is requested, this string will contain the csv formatted taxonomy output.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        Taxonomy

        -
        public Taxonomy()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/dataenrichment/TaxonomyMetadata.html b/docs/com/textkernel/tx/models/dataenrichment/TaxonomyMetadata.html deleted file mode 100644 index 308fe4d82..000000000 --- a/docs/com/textkernel/tx/models/dataenrichment/TaxonomyMetadata.html +++ /dev/null @@ -1,295 +0,0 @@ - - - - - - -TaxonomyMetadata (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.dataenrichment
-

Class TaxonomyMetadata

-
-
- -
-
    -
  • -
    -
    -
    public class TaxonomyMetadata
-extends Object
    -
    Metadata about the Skills or Professions taxonomies
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        ServiceVersion

        -
        public String ServiceVersion
        -
        The version number of the professions service.
        -
        • -
      - - - -
        -
      • -

        TaxonomyReleaseDate

        -
        public java.time.LocalDate TaxonomyReleaseDate
        -
        The date the taxonomy was released.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        TaxonomyMetadata

        -
        public TaxonomyMetadata()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/dataenrichment/VersionedProfessionClassification.html b/docs/com/textkernel/tx/models/dataenrichment/VersionedProfessionClassification.html deleted file mode 100644 index 7cb68f8d5..000000000 --- a/docs/com/textkernel/tx/models/dataenrichment/VersionedProfessionClassification.html +++ /dev/null @@ -1,291 +0,0 @@ - - - - - - -VersionedProfessionClassification (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.dataenrichment
-

Class VersionedProfessionClassification<T>

-
-
- -
-
    -
  • -
    -
    -
    public class VersionedProfessionClassification<T>
-extends ProfessionClassification<T>
    -
    Object representing a profession concept with taxonomy version
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Version

        -
        public String Version
        -
        The version of the profession taxonomy
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        VersionedProfessionClassification

        -
        public VersionedProfessionClassification()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/dataenrichment/class-use/BasicProfession.html b/docs/com/textkernel/tx/models/dataenrichment/class-use/BasicProfession.html deleted file mode 100644 index 3bf28898c..000000000 --- a/docs/com/textkernel/tx/models/dataenrichment/class-use/BasicProfession.html +++ /dev/null @@ -1,204 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.dataenrichment.BasicProfession (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.dataenrichment.BasicProfession

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/dataenrichment/class-use/ExtractedSkill.html b/docs/com/textkernel/tx/models/dataenrichment/class-use/ExtractedSkill.html deleted file mode 100644 index aefbd215f..000000000 --- a/docs/com/textkernel/tx/models/dataenrichment/class-use/ExtractedSkill.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.dataenrichment.ExtractedSkill (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.dataenrichment.ExtractedSkill

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/dataenrichment/class-use/LangDescription.html b/docs/com/textkernel/tx/models/dataenrichment/class-use/LangDescription.html deleted file mode 100644 index d5edca2f1..000000000 --- a/docs/com/textkernel/tx/models/dataenrichment/class-use/LangDescription.html +++ /dev/null @@ -1,174 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.dataenrichment.LangDescription (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.dataenrichment.LangDescription

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/dataenrichment/class-use/NormalizedProfession.html b/docs/com/textkernel/tx/models/dataenrichment/class-use/NormalizedProfession.html deleted file mode 100644 index fa0bd41c1..000000000 --- a/docs/com/textkernel/tx/models/dataenrichment/class-use/NormalizedProfession.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.dataenrichment.NormalizedProfession (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.dataenrichment.NormalizedProfession

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/dataenrichment/class-use/NormalizedSkill.html b/docs/com/textkernel/tx/models/dataenrichment/class-use/NormalizedSkill.html deleted file mode 100644 index 105b641d5..000000000 --- a/docs/com/textkernel/tx/models/dataenrichment/class-use/NormalizedSkill.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.dataenrichment.NormalizedSkill (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.dataenrichment.NormalizedSkill

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/dataenrichment/class-use/Profession.html b/docs/com/textkernel/tx/models/dataenrichment/class-use/Profession.html deleted file mode 100644 index a47573ab9..000000000 --- a/docs/com/textkernel/tx/models/dataenrichment/class-use/Profession.html +++ /dev/null @@ -1,198 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.dataenrichment.Profession (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.dataenrichment.Profession

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/dataenrichment/class-use/ProfessionClassification.html b/docs/com/textkernel/tx/models/dataenrichment/class-use/ProfessionClassification.html deleted file mode 100644 index 733deb3fe..000000000 --- a/docs/com/textkernel/tx/models/dataenrichment/class-use/ProfessionClassification.html +++ /dev/null @@ -1,225 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.dataenrichment.ProfessionClassification (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.dataenrichment.ProfessionClassification

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/dataenrichment/class-use/ProfessionMultipleDescriptions.html b/docs/com/textkernel/tx/models/dataenrichment/class-use/ProfessionMultipleDescriptions.html deleted file mode 100644 index 72f00ef6b..000000000 --- a/docs/com/textkernel/tx/models/dataenrichment/class-use/ProfessionMultipleDescriptions.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.dataenrichment.ProfessionMultipleDescriptions (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.dataenrichment.ProfessionMultipleDescriptions

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/dataenrichment/class-use/Skill.html b/docs/com/textkernel/tx/models/dataenrichment/class-use/Skill.html deleted file mode 100644 index 56d2dc76a..000000000 --- a/docs/com/textkernel/tx/models/dataenrichment/class-use/Skill.html +++ /dev/null @@ -1,216 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.dataenrichment.Skill (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.dataenrichment.Skill

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/dataenrichment/class-use/SkillAndConfidence.html b/docs/com/textkernel/tx/models/dataenrichment/class-use/SkillAndConfidence.html deleted file mode 100644 index afa75d0fe..000000000 --- a/docs/com/textkernel/tx/models/dataenrichment/class-use/SkillAndConfidence.html +++ /dev/null @@ -1,174 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.dataenrichment.SkillAndConfidence (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.dataenrichment.SkillAndConfidence

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/dataenrichment/class-use/SkillMatch.html b/docs/com/textkernel/tx/models/dataenrichment/class-use/SkillMatch.html deleted file mode 100644 index 928c82c83..000000000 --- a/docs/com/textkernel/tx/models/dataenrichment/class-use/SkillMatch.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.dataenrichment.SkillMatch (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.dataenrichment.SkillMatch

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/dataenrichment/class-use/SkillMultipleDescriptions.html b/docs/com/textkernel/tx/models/dataenrichment/class-use/SkillMultipleDescriptions.html deleted file mode 100644 index df1af6304..000000000 --- a/docs/com/textkernel/tx/models/dataenrichment/class-use/SkillMultipleDescriptions.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.dataenrichment.SkillMultipleDescriptions (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.dataenrichment.SkillMultipleDescriptions

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/dataenrichment/class-use/Taxonomy.html b/docs/com/textkernel/tx/models/dataenrichment/class-use/Taxonomy.html deleted file mode 100644 index eae009391..000000000 --- a/docs/com/textkernel/tx/models/dataenrichment/class-use/Taxonomy.html +++ /dev/null @@ -1,192 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.dataenrichment.Taxonomy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.dataenrichment.Taxonomy

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/dataenrichment/class-use/TaxonomyMetadata.html b/docs/com/textkernel/tx/models/dataenrichment/class-use/TaxonomyMetadata.html deleted file mode 100644 index d3b7d6835..000000000 --- a/docs/com/textkernel/tx/models/dataenrichment/class-use/TaxonomyMetadata.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.dataenrichment.TaxonomyMetadata (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.dataenrichment.TaxonomyMetadata

-
-
No usage of com.textkernel.tx.models.dataenrichment.TaxonomyMetadata
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/dataenrichment/class-use/VersionedProfessionClassification.html b/docs/com/textkernel/tx/models/dataenrichment/class-use/VersionedProfessionClassification.html deleted file mode 100644 index d0a86f981..000000000 --- a/docs/com/textkernel/tx/models/dataenrichment/class-use/VersionedProfessionClassification.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.dataenrichment.VersionedProfessionClassification (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.dataenrichment.VersionedProfessionClassification

-
-
No usage of com.textkernel.tx.models.dataenrichment.VersionedProfessionClassification
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/dataenrichment/package-frame.html b/docs/com/textkernel/tx/models/dataenrichment/package-frame.html deleted file mode 100644 index 0978d57d4..000000000 --- a/docs/com/textkernel/tx/models/dataenrichment/package-frame.html +++ /dev/null @@ -1,35 +0,0 @@ - - - - - - -com.textkernel.tx.models.dataenrichment (Textkernel Tx Java SDK 2.3.3 API) - - - - - -

com.textkernel.tx.models.dataenrichment

-
-

Classes

- -
- - diff --git a/docs/com/textkernel/tx/models/dataenrichment/package-summary.html b/docs/com/textkernel/tx/models/dataenrichment/package-summary.html deleted file mode 100644 index 01310d405..000000000 --- a/docs/com/textkernel/tx/models/dataenrichment/package-summary.html +++ /dev/null @@ -1,230 +0,0 @@ - - - - - - -com.textkernel.tx.models.dataenrichment (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package com.textkernel.tx.models.dataenrichment

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/dataenrichment/package-tree.html b/docs/com/textkernel/tx/models/dataenrichment/package-tree.html deleted file mode 100644 index fcfb22273..000000000 --- a/docs/com/textkernel/tx/models/dataenrichment/package-tree.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -com.textkernel.tx.models.dataenrichment Class Hierarchy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package com.textkernel.tx.models.dataenrichment

-Package Hierarchies: - -
-
-

Class Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/dataenrichment/package-use.html b/docs/com/textkernel/tx/models/dataenrichment/package-use.html deleted file mode 100644 index 6b83028d2..000000000 --- a/docs/com/textkernel/tx/models/dataenrichment/package-use.html +++ /dev/null @@ -1,273 +0,0 @@ - - - - - - -Uses of Package com.textkernel.tx.models.dataenrichment (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Package
com.textkernel.tx.models.dataenrichment

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/job/ApplicationDetails.html b/docs/com/textkernel/tx/models/job/ApplicationDetails.html deleted file mode 100644 index 9450e2724..000000000 --- a/docs/com/textkernel/tx/models/job/ApplicationDetails.html +++ /dev/null @@ -1,391 +0,0 @@ - - - - - - -ApplicationDetails (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.job
-

Class ApplicationDetails

-
-
- -
-
    -
  • -
    -
    -
    public class ApplicationDetails
-extends Object
    -
    An object containing details about the application process
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        ApplicationDescription

        -
        public String ApplicationDescription
        -
        Full text description of the application process
        -
        • -
      - - - -
        -
      • -

        ContactPerson

        -
        public String ContactPerson
        -
        Full name of the main contact person for the application
        -
        • -
      - - - -
        -
      • -

        ContactPhone

        -
        public String ContactPhone
        -
        Normalized phone of the organization with international calling prefix. Can contain multiple values (concatenated by comma)
        -
        • -
      - - - -
        -
      • -

        ContactEmail

        -
        public String ContactEmail
        -
        Displayable email of the organization. Can contain multiple values (concatenated by comma)
        -
        • -
      - - - -
        -
      • -

        Website

        -
        public String Website
        -
        Validated and normalized displayable website of the organization. Can contain multiple values (concatenated by comma)
        -
        • -
      - - - -
        -
      • -

        ApplicationDeadline

        -
        public TxPrimitive<java.time.LocalDate> ApplicationDeadline
        -
        Deadline to apply for the job
        -
        • -
      - - - -
        -
      • -

        PostedDate

        -
        public TxPrimitive<java.time.LocalDate> PostedDate
        -
        Date the job was posted
        -
        • -
      - - - -
        -
      • -

        ReferenceNumber

        -
        public String ReferenceNumber
        -
        Any reference number found for the job application
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ApplicationDetails

        -
        public ApplicationDetails()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/job/EmployerNames.html b/docs/com/textkernel/tx/models/job/EmployerNames.html deleted file mode 100644 index 377cf418a..000000000 --- a/docs/com/textkernel/tx/models/job/EmployerNames.html +++ /dev/null @@ -1,295 +0,0 @@ - - - - - - -EmployerNames (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.job
-

Class EmployerNames

-
-
- -
-
    -
  • -
    -
    -
    public class EmployerNames
-extends Object
    -
    Names of employers found in a job description
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        MainEmployerName

        -
        public String MainEmployerName
        -
        The main/overall employer name
        -
        • -
      - - - -
        -
      • -

        EmployerName

        -
        public List<String> EmployerName
        -
        All employer names found in a job description
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        EmployerNames

        -
        public EmployerNames()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/job/JobDegree.html b/docs/com/textkernel/tx/models/job/JobDegree.html deleted file mode 100644 index 496f34716..000000000 --- a/docs/com/textkernel/tx/models/job/JobDegree.html +++ /dev/null @@ -1,327 +0,0 @@ - - - - - - -JobDegree (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.job
-

Class JobDegree

-
-
- -
-
    -
  • -
    -
    -
    public class JobDegree
-extends Object
    -
    A preferred/required educational degree found in a job
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Name

        -
        public String Name
        -
        The name of the educational degree
        -
        • -
      - - - -
        -
      • -

        Type

        -
        public String Type
        -
        The type of the educational degree
        -
        • -
      - - - -
        -
      • -

        LocalEducationLevel

        -
        public String LocalEducationLevel
        -
        The normalized education level based on the job's country. See here.
        -
        • -
      - - - -
        -
      • -

        InternationalEducationLevel

        -
        public String InternationalEducationLevel
        -
        The normalized education level based on an international standard. See here.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        JobDegree

        -
        public JobDegree()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/job/JobMetadata.html b/docs/com/textkernel/tx/models/job/JobMetadata.html deleted file mode 100644 index d7250dc01..000000000 --- a/docs/com/textkernel/tx/models/job/JobMetadata.html +++ /dev/null @@ -1,260 +0,0 @@ - - - - - - -JobMetadata (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.job
-

Class JobMetadata

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        JobMetadata

        -
        public JobMetadata()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/job/JobTitles.html b/docs/com/textkernel/tx/models/job/JobTitles.html deleted file mode 100644 index 8a9c2e830..000000000 --- a/docs/com/textkernel/tx/models/job/JobTitles.html +++ /dev/null @@ -1,311 +0,0 @@ - - - - - - -JobTitles (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.job
-

Class JobTitles

-
-
- -
-
    -
  • -
    -
    -
    public class JobTitles
-extends Object
    -
    Job titles found in a job description
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        MainJobTitle

        -
        public String MainJobTitle
        -
        The main/overall job title
        -
        • -
      - - - -
        -
      • -

        JobTitle

        -
        public List<String> JobTitle
        -
        All job titles found in the job description
        -
        • -
      - - - - -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        JobTitles

        -
        public JobTitles()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/job/ParsedJob.html b/docs/com/textkernel/tx/models/job/ParsedJob.html deleted file mode 100644 index c0a23ba65..000000000 --- a/docs/com/textkernel/tx/models/job/ParsedJob.html +++ /dev/null @@ -1,979 +0,0 @@ - - - - - - -ParsedJob (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.job
-

Class ParsedJob

-
-
- -
-
    -
  • -
    -
    -
    public class ParsedJob
-extends ParsedDocument
    -
    All of the information extracted while parsing a job
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        CurrentJobIsManagement

        -
        public boolean CurrentJobIsManagement
        -
        Whether or not the job is a management position. Used for AI Matching
        -
        • -
      - - - -
        -
      • -

        HighestManagementScore

        -
        public TxPrimitive<Integer> HighestManagementScore
        -
        The management score. Used for AI Matching
        -
        • -
      - - - -
        -
      • -

        ManagementLevel

        -
        public String ManagementLevel
        -
        The management level. Used for AI Matching
        -
        • -
      - - - -
        -
      • -

        ExecutiveType

        -
        public String ExecutiveType
        -
        What kind of executive position the job is, if any. Used for AI Matching
        -
        • -
      - - - -
        -
      • -

        MinimumYears

        -
        public TxPrimitive<Integer> MinimumYears
        -
        The minimum years experience for the job, if listed. Used for AI Matching
        -
        • -
      - - - -
        -
      • -

        MaximumYears

        -
        public TxPrimitive<Integer> MaximumYears
        -
        The maximum years experience for the job, if listed. Used for AI Matching
        -
        • -
      - - - -
        -
      • -

        MinimumYearsManagement

        -
        public TxPrimitive<Integer> MinimumYearsManagement
        -
        The minimum years of management experience, if listed. Used for AI Matching
        -
        • -
      - - - -
        -
      • -

        MaximumYearsManagement

        -
        public TxPrimitive<Integer> MaximumYearsManagement
        -
        The maximum years of management experience, if listed. Used for AI Matching
        -
        • -
      - - - -
        -
      • -

        RequiredDegree

        -
        public String RequiredDegree
        -
        The required educational degree, if listed. Used for AI Matching
        -
        • -
      - - - -
        -
      • -

        StartDate

        -
        public TxPrimitive<java.time.LocalDate> StartDate
        -
        The start date of the job.
        -
        • -
      - - - -
        -
      • -

        EndDate

        -
        public TxPrimitive<java.time.LocalDate> EndDate
        -
        The end date for the job, if listed.
        -
        • -
      - - - -
        -
      • -

        JobDescription

        -
        public String JobDescription
        -
        Section containing information about the job. Job description strictly includes duties, tasks, and responsibilities for the role with as little irrelevant text as possible.
        -
        • -
      - - - -
        -
      • -

        JobRequirements

        -
        public String JobRequirements
        -
        Full text of any requirements listed by the job.
        -
        • -
      - - - -
        -
      • -

        Benefits

        -
        public String Benefits
        -
        Full text of any benefits listed by the job.
        -
        • -
      - - - -
        -
      • -

        EmployerDescription

        -
        public String EmployerDescription
        -
        Full text of any employer description listed by the job.
        -
        • -
      - - - -
        -
      • -

        JobTitles

        -
        public JobTitles JobTitles
        -
        The job titles found in the job. Used for AI Matching
        -
        • -
      - - - -
        -
      • -

        EmployerNames

        -
        public EmployerNames EmployerNames
        -
        The employer names found in the job.
        -
        • -
      - - - -
        -
      • -

        Degrees

        -
        public List<JobDegree> Degrees
        -
        The educational degrees found listed in the job. Used for AI Matching
        -
        • -
      - - - -
        -
      • -

        SchoolNames

        -
        public List<String> SchoolNames
        -
        Any school names listed in the job
        -
        • -
      - - - -
        -
      • -

        CertificationsAndLicenses

        -
        public List<String> CertificationsAndLicenses
        -
        Any certifications/licenses listed in the job. Used for AI Matching
        -
        • -
      - - - -
        -
      • -

        LanguageCodes

        -
        public List<String> LanguageCodes
        -
        Any languages listed in the job. Used for AI Matching
        -
        • -
      - - - -
        -
      • -

        CurrentLocation

        -
        public Location CurrentLocation
        -
        The location of the job, if listed. If no job location is found, this is the location of the company, if listed.
        -
        • -
      - - - -
        -
      • -

        ApplicationDetails

        -
        public ApplicationDetails ApplicationDetails
        -
        Information about the application process.
        -
        • -
      - - - -
        -
      • -

        Salary

        -
        public PayRange Salary
        -
        The salary found for the position.
        -
        • -
      - - - -
        -
      • -

        MinimumWorkingHours

        -
        public TxPrimitive<Integer> MinimumWorkingHours
        -
        The minimum number of working hours per week
        -
        • -
      - - - -
        -
      • -

        MaximumWorkingHours

        -
        public TxPrimitive<Integer> MaximumWorkingHours
        -
        The maximum number of working hours per week
        -
        • -
      - - - -
        -
      • -

        WorkingHours

        -
        public String WorkingHours
        -
        The type of working hours. One of: -
          -
        • regular
          • -
        • irregular
          • -
        -
        • -
      - - - -
        -
      • -

        IsRemote

        -
        public boolean IsRemote
        -
        Whether or not the position is remote. Includes fulltime, partial and temporary remote working opportunities
        -
        • -
      - - - -
        -
      • -

        DriversLicenses

        -
        public List<String> DriversLicenses
        -
        Any drivers license requirements
        -
        • -
      - - - -
        -
      • -

        EmploymentType

        -
        public String EmploymentType
        -
        The type of employment. One of: -
          -
        • unspecified
          • -
        • fulltime
          • -
        • parttime
          • -
        • fulltime/parttime
          • -
        -
        • -
      - - - -
        -
      • -

        ContractType

        -
        public String ContractType
        -
        The contract type. One of: -
          -
        • unspecified
          • -
        • permanent
          • -
        • temporary
          • -
        • possibly_permanent
          • -
        • interim
          • -
        • franchise
          • -
        • side
          • -
        • internship
          • -
        • voluntary
          • -
        • freelance
          • -
        • apprenticeship
          • -
        • assisted
          • -
        -
        • -
      - - - -
        -
      • -

        TermsOfInterest

        -
        public List<String> TermsOfInterest
        -
        Terms of interest listed in the job
        -
        • -
      - - - -
        -
      • -

        Owners

        -
        public List<String> Owners
        -
        Any owners of the job posting, if listed.
        -
        • -
      - - - - - - - - - - - -
        -
      • -

        JobMetadata

        -
        public JobMetadata JobMetadata
        -
        Metadata about the parsed job
        -
        • -
      - - - -
        -
      • -

        UserDefinedTags

        -
        public List<String> UserDefinedTags
        -
        A list of User-Defined Tags - that are assigned to this job. These are used to filter search/match queries in the AI Matching Engine. -

        NOTE: you may add/remove these prior to indexing. This is the only property you may modify prior to indexing.

        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ParsedJob

        -
        @Deprecated
-public ParsedJob()
        -
        Deprecated. You should never create one of these. Instead, these are output by the Job Parser. - The API does not support manually-created jobs to be used in the AI Matching engine.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        fromFile

        -
        public static ParsedJob fromFile(String path)
-                          throws IOException,
-                                 com.google.gson.JsonParseException
        -
        Load a parsed job from a json file using UTF-8 encoding. This is useful when you have stored parse results to disk for use later.
        -
        -
        Parameters:
        -
        path - The full path to the json file
        -
        Returns:
        -
        The deserialized ParsedJob
        -
        Throws:
        -
        IOException - When an error occurs reading the file
        -
        com.google.gson.JsonParseException - If you try to parse an invalid ParsedResume JSON string
        -
        -
        • -
      - - - -
        -
      • -

        fromJson

        -
        public static ParsedJob fromJson(String utf8json)
-                          throws com.google.gson.JsonParseException
        -
        Create a parsed job from json. This is useful when you have stored parse results to disk for use later.
        -
        -
        Parameters:
        -
        utf8json - The UTF-8 encoded json string
        -
        Returns:
        -
        The deserialized ParsedJob
        -
        Throws:
        -
        com.google.gson.JsonParseException - If you try to parse an invalid ParsedResume JSON string
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/job/PayRange.html b/docs/com/textkernel/tx/models/job/PayRange.html deleted file mode 100644 index c1508df27..000000000 --- a/docs/com/textkernel/tx/models/job/PayRange.html +++ /dev/null @@ -1,374 +0,0 @@ - - - - - - -PayRange (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.job
-

Class PayRange

-
-
- -
-
    -
  • -
    -
    -
    public class PayRange
-extends Object
    -
    An object containing details about a job position's pay.
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Minimum

        -
        public TxPrimitive<Integer> Minimum
        -
        The normalized minimum yearly salary
        -
        • -
      - - - -
        -
      • -

        Maximum

        -
        public TxPrimitive<Integer> Maximum
        -
        The normalized maximum yearly salary
        -
        • -
      - - - -
        -
      • -

        RawMinimum

        -
        public String RawMinimum
        -
        The raw, un-normalized, minimum value. This is returned as is in the text, so there is no guarantee that it will evaluate to a valid number and not a string.
        -
        • -
      - - - -
        -
      • -

        RawMaximum

        -
        public String RawMaximum
        -
        The raw, un-normalized, maximum value. This is returned as is in the text, so there is no guarantee that it will evaluate to a valid number and not a string.
        -
        • -
      - - - -
        -
      • -

        Currency

        -
        public String Currency
        -
        Currency code (ISO 4217) applied to the Minimum and Maximum
        -
        • -
      - - - -
        -
      • -

        TimeScale

        -
        public String TimeScale
        -
        Time scale applied to the raw values to get the minimum and maximum annual salary. Possible values are: -
          -
        • Hourly
          • -
        • Daily
          • -
        • Weekly
          • -
        • Monthly
          • -
        • Annually
          • -
        - If no lexical cues are available from the vacancy, the time scale is guessed based on predefined salary ranges. - Here are some rough salary ranges (note that country-specific conditions may apply): -
          -
        • 1 or 2 digits salary (9, 12): Hourly
          • -
        • 3 or 4 digits salary (3800, 5000): Monthly
          • -
        • 5 digit salary (38000, 50000): Annually
          • -
        - If a monthly salary is extracted, to get the annual salary it is multiplied by 14 (if country = AT) or 12 (all other countries).
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        PayRange

        -
        public PayRange()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/job/class-use/ApplicationDetails.html b/docs/com/textkernel/tx/models/job/class-use/ApplicationDetails.html deleted file mode 100644 index ea48c4f6f..000000000 --- a/docs/com/textkernel/tx/models/job/class-use/ApplicationDetails.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.job.ApplicationDetails (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.job.ApplicationDetails

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/job/class-use/EmployerNames.html b/docs/com/textkernel/tx/models/job/class-use/EmployerNames.html deleted file mode 100644 index 7fd95f7a8..000000000 --- a/docs/com/textkernel/tx/models/job/class-use/EmployerNames.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.job.EmployerNames (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.job.EmployerNames

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/job/class-use/JobDegree.html b/docs/com/textkernel/tx/models/job/class-use/JobDegree.html deleted file mode 100644 index a817765c3..000000000 --- a/docs/com/textkernel/tx/models/job/class-use/JobDegree.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.job.JobDegree (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.job.JobDegree

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/job/class-use/JobMetadata.html b/docs/com/textkernel/tx/models/job/class-use/JobMetadata.html deleted file mode 100644 index d54af35c5..000000000 --- a/docs/com/textkernel/tx/models/job/class-use/JobMetadata.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.job.JobMetadata (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.job.JobMetadata

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/job/class-use/JobTitles.html b/docs/com/textkernel/tx/models/job/class-use/JobTitles.html deleted file mode 100644 index 7a590015f..000000000 --- a/docs/com/textkernel/tx/models/job/class-use/JobTitles.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.job.JobTitles (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.job.JobTitles

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/job/class-use/ParsedJob.html b/docs/com/textkernel/tx/models/job/class-use/ParsedJob.html deleted file mode 100644 index b9aa983df..000000000 --- a/docs/com/textkernel/tx/models/job/class-use/ParsedJob.html +++ /dev/null @@ -1,513 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.job.ParsedJob (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.job.ParsedJob

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/job/class-use/PayRange.html b/docs/com/textkernel/tx/models/job/class-use/PayRange.html deleted file mode 100644 index 6e6c40b40..000000000 --- a/docs/com/textkernel/tx/models/job/class-use/PayRange.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.job.PayRange (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.job.PayRange

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/job/package-frame.html b/docs/com/textkernel/tx/models/job/package-frame.html deleted file mode 100644 index 8f4151c34..000000000 --- a/docs/com/textkernel/tx/models/job/package-frame.html +++ /dev/null @@ -1,27 +0,0 @@ - - - - - - -com.textkernel.tx.models.job (Textkernel Tx Java SDK 2.3.3 API) - - - - - -

com.textkernel.tx.models.job

-
-

Classes

- -
- - diff --git a/docs/com/textkernel/tx/models/job/package-summary.html b/docs/com/textkernel/tx/models/job/package-summary.html deleted file mode 100644 index cffb4669e..000000000 --- a/docs/com/textkernel/tx/models/job/package-summary.html +++ /dev/null @@ -1,182 +0,0 @@ - - - - - - -com.textkernel.tx.models.job (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package com.textkernel.tx.models.job

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/job/package-tree.html b/docs/com/textkernel/tx/models/job/package-tree.html deleted file mode 100644 index 2621f18ea..000000000 --- a/docs/com/textkernel/tx/models/job/package-tree.html +++ /dev/null @@ -1,153 +0,0 @@ - - - - - - -com.textkernel.tx.models.job Class Hierarchy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package com.textkernel.tx.models.job

-Package Hierarchies: - -
-
-

Class Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/job/package-use.html b/docs/com/textkernel/tx/models/job/package-use.html deleted file mode 100644 index f3b91501f..000000000 --- a/docs/com/textkernel/tx/models/job/package-use.html +++ /dev/null @@ -1,317 +0,0 @@ - - - - - - -Uses of Package com.textkernel.tx.models.job (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Package
com.textkernel.tx.models.job

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/job/skills/JobNormalizedSkill.html b/docs/com/textkernel/tx/models/job/skills/JobNormalizedSkill.html deleted file mode 100644 index d9a9fab33..000000000 --- a/docs/com/textkernel/tx/models/job/skills/JobNormalizedSkill.html +++ /dev/null @@ -1,291 +0,0 @@ - - - - - - -JobNormalizedSkill (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.job.skills
-

Class JobNormalizedSkill

-
-
- -
-
    -
  • -
    -
    -
    public class JobNormalizedSkill
-extends NormalizedSkill
    -
    Normalized skill concept representing one or more raw skills that were extracted.
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Required

        -
        public boolean Required
        -
        true if this skill was listed as 'required' on the job description
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        JobNormalizedSkill

        -
        public JobNormalizedSkill()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/job/skills/JobRawSkill.html b/docs/com/textkernel/tx/models/job/skills/JobRawSkill.html deleted file mode 100644 index 9a15b5bb0..000000000 --- a/docs/com/textkernel/tx/models/job/skills/JobRawSkill.html +++ /dev/null @@ -1,291 +0,0 @@ - - - - - - -JobRawSkill (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.job.skills
-

Class JobRawSkill

-
-
- -
-
    -
  • -
    -
    -
    public class JobRawSkill
-extends RawSkill
    -
    Skill exactly as it was found in the plain text of the document.
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Required

        -
        public boolean Required
        -
        true if this skill was listed as 'required' on the job description
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        JobRawSkill

        -
        public JobRawSkill()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/job/skills/JobSkill.html b/docs/com/textkernel/tx/models/job/skills/JobSkill.html deleted file mode 100644 index d6a9ddec1..000000000 --- a/docs/com/textkernel/tx/models/job/skills/JobSkill.html +++ /dev/null @@ -1,303 +0,0 @@ - - - - - - -JobSkill (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.job.skills
-

Class JobSkill

-
-
- -
-
    -
  • -
    -
    -
    public class JobSkill
-extends JobSkillVariation
    -
    A skill listed in a job
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Variations

        -
        public List<JobSkillVariation> Variations
        -
        The variations (synonyms) of this skill that were found
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        JobSkill

        -
        public JobSkill()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/job/skills/JobSkillVariation.html b/docs/com/textkernel/tx/models/job/skills/JobSkillVariation.html deleted file mode 100644 index c2591899e..000000000 --- a/docs/com/textkernel/tx/models/job/skills/JobSkillVariation.html +++ /dev/null @@ -1,295 +0,0 @@ - - - - - - -JobSkillVariation (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.job.skills
-

Class JobSkillVariation

-
-
- -
-
    -
  • -
    -
    Direct Known Subclasses:
    -
    JobSkill
    -
    -
    -
    -
    public class JobSkillVariation
-extends Skill
    -
    A skill listed in a job
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Required

        -
        public boolean Required
        -
        true if this skill was listed as 'required' on the job description
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        JobSkillVariation

        -
        public JobSkillVariation()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/job/skills/JobSubTaxonomy.html b/docs/com/textkernel/tx/models/job/skills/JobSubTaxonomy.html deleted file mode 100644 index e3d98ed88..000000000 --- a/docs/com/textkernel/tx/models/job/skills/JobSubTaxonomy.html +++ /dev/null @@ -1,303 +0,0 @@ - - - - - - -JobSubTaxonomy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.job.skills
-

Class JobSubTaxonomy

-
-
- -
-
    -
  • -
    -
    -
    public class JobSubTaxonomy
-extends FoundSubTaxonomy
    -
    A subtaxonomy to group similar skills
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Skills

        -
        public List<JobSkill> Skills
        -
        The skills from this subtaxonomy that were found
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        JobSubTaxonomy

        -
        public JobSubTaxonomy()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/job/skills/JobTaxonomy.html b/docs/com/textkernel/tx/models/job/skills/JobTaxonomy.html deleted file mode 100644 index 2f7c8c2f5..000000000 --- a/docs/com/textkernel/tx/models/job/skills/JobTaxonomy.html +++ /dev/null @@ -1,272 +0,0 @@ - - - - - - -JobTaxonomy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.job.skills
-

Class JobTaxonomy

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        JobTaxonomy

        -
        public JobTaxonomy()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/job/skills/JobTaxonomyRoot.html b/docs/com/textkernel/tx/models/job/skills/JobTaxonomyRoot.html deleted file mode 100644 index baf231580..000000000 --- a/docs/com/textkernel/tx/models/job/skills/JobTaxonomyRoot.html +++ /dev/null @@ -1,295 +0,0 @@ - - - - - - -JobTaxonomyRoot (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.job.skills
-

Class JobTaxonomyRoot

-
-
- -
-
    -
  • -
    -
    -
    public class JobTaxonomyRoot
-extends Object
    -
    A container for skills taxonomies found in a job
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Root

        -
        public String Root
        -
        The name of the skills list that these taxonomies belong to
        -
        • -
      - - - -
        -
      • -

        Taxonomies

        -
        public List<JobTaxonomy> Taxonomies
        -
        The taxonomies found in a job
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        JobTaxonomyRoot

        -
        public JobTaxonomyRoot()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/job/skills/JobV2Skills.html b/docs/com/textkernel/tx/models/job/skills/JobV2Skills.html deleted file mode 100644 index aa7d9fa39..000000000 --- a/docs/com/textkernel/tx/models/job/skills/JobV2Skills.html +++ /dev/null @@ -1,314 +0,0 @@ - - - - - - -JobV2Skills (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.job.skills
-

Class JobV2Skills

-
-
- -
-
    -
  • -
    -
    -
    public class JobV2Skills
-extends Object
    -
    Skills output when version 2 of the taxonomy is utilized.
    -
    • -
-
-
- -
-
- -
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/job/skills/class-use/JobNormalizedSkill.html b/docs/com/textkernel/tx/models/job/skills/class-use/JobNormalizedSkill.html deleted file mode 100644 index a71afc3c7..000000000 --- a/docs/com/textkernel/tx/models/job/skills/class-use/JobNormalizedSkill.html +++ /dev/null @@ -1,169 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.job.skills.JobNormalizedSkill (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.job.skills.JobNormalizedSkill

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/job/skills/class-use/JobRawSkill.html b/docs/com/textkernel/tx/models/job/skills/class-use/JobRawSkill.html deleted file mode 100644 index 4267d69f2..000000000 --- a/docs/com/textkernel/tx/models/job/skills/class-use/JobRawSkill.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.job.skills.JobRawSkill (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.job.skills.JobRawSkill

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/job/skills/class-use/JobSkill.html b/docs/com/textkernel/tx/models/job/skills/class-use/JobSkill.html deleted file mode 100644 index ac3094f87..000000000 --- a/docs/com/textkernel/tx/models/job/skills/class-use/JobSkill.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.job.skills.JobSkill (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.job.skills.JobSkill

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/job/skills/class-use/JobSkillVariation.html b/docs/com/textkernel/tx/models/job/skills/class-use/JobSkillVariation.html deleted file mode 100644 index a044f5f41..000000000 --- a/docs/com/textkernel/tx/models/job/skills/class-use/JobSkillVariation.html +++ /dev/null @@ -1,183 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.job.skills.JobSkillVariation (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.job.skills.JobSkillVariation

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/job/skills/class-use/JobSubTaxonomy.html b/docs/com/textkernel/tx/models/job/skills/class-use/JobSubTaxonomy.html deleted file mode 100644 index 76b3ab00e..000000000 --- a/docs/com/textkernel/tx/models/job/skills/class-use/JobSubTaxonomy.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.job.skills.JobSubTaxonomy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.job.skills.JobSubTaxonomy

-
-
No usage of com.textkernel.tx.models.job.skills.JobSubTaxonomy
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/job/skills/class-use/JobTaxonomy.html b/docs/com/textkernel/tx/models/job/skills/class-use/JobTaxonomy.html deleted file mode 100644 index 709a43218..000000000 --- a/docs/com/textkernel/tx/models/job/skills/class-use/JobTaxonomy.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.job.skills.JobTaxonomy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.job.skills.JobTaxonomy

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/job/skills/class-use/JobTaxonomyRoot.html b/docs/com/textkernel/tx/models/job/skills/class-use/JobTaxonomyRoot.html deleted file mode 100644 index 71f3bfa54..000000000 --- a/docs/com/textkernel/tx/models/job/skills/class-use/JobTaxonomyRoot.html +++ /dev/null @@ -1,170 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.job.skills.JobTaxonomyRoot (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.job.skills.JobTaxonomyRoot

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/job/skills/class-use/JobV2Skills.html b/docs/com/textkernel/tx/models/job/skills/class-use/JobV2Skills.html deleted file mode 100644 index d7ecb43e3..000000000 --- a/docs/com/textkernel/tx/models/job/skills/class-use/JobV2Skills.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.job.skills.JobV2Skills (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.job.skills.JobV2Skills

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/job/skills/package-frame.html b/docs/com/textkernel/tx/models/job/skills/package-frame.html deleted file mode 100644 index f24626e7d..000000000 --- a/docs/com/textkernel/tx/models/job/skills/package-frame.html +++ /dev/null @@ -1,28 +0,0 @@ - - - - - - -com.textkernel.tx.models.job.skills (Textkernel Tx Java SDK 2.3.3 API) - - - - - -

com.textkernel.tx.models.job.skills

-
-

Classes

- -
- - diff --git a/docs/com/textkernel/tx/models/job/skills/package-summary.html b/docs/com/textkernel/tx/models/job/skills/package-summary.html deleted file mode 100644 index 355cfcc9d..000000000 --- a/docs/com/textkernel/tx/models/job/skills/package-summary.html +++ /dev/null @@ -1,188 +0,0 @@ - - - - - - -com.textkernel.tx.models.job.skills (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package com.textkernel.tx.models.job.skills

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/job/skills/package-tree.html b/docs/com/textkernel/tx/models/job/skills/package-tree.html deleted file mode 100644 index b11827804..000000000 --- a/docs/com/textkernel/tx/models/job/skills/package-tree.html +++ /dev/null @@ -1,177 +0,0 @@ - - - - - - -com.textkernel.tx.models.job.skills Class Hierarchy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package com.textkernel.tx.models.job.skills

-Package Hierarchies: - -
-
-

Class Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/job/skills/package-use.html b/docs/com/textkernel/tx/models/job/skills/package-use.html deleted file mode 100644 index 5b535c21e..000000000 --- a/docs/com/textkernel/tx/models/job/skills/package-use.html +++ /dev/null @@ -1,207 +0,0 @@ - - - - - - -Uses of Package com.textkernel.tx.models.job.skills (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Package
com.textkernel.tx.models.job.skills

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/matching/Index.html b/docs/com/textkernel/tx/models/matching/Index.html deleted file mode 100644 index fd6427532..000000000 --- a/docs/com/textkernel/tx/models/matching/Index.html +++ /dev/null @@ -1,311 +0,0 @@ - - - - - - -Index (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.matching
-

Class Index

-
-
- -
-
    -
  • -
    -
    -
    public class Index
-extends Object
    -
    A document index to hold resumes or jobs
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        OwnerId

        -
        public String OwnerId
        -
        The account id of the owner for this index
        -
        • -
      - - - -
        -
      • -

        Name

        -
        public String Name
        -
        The name/id of this index
        -
        • -
      - - - -
        -
      • -

        IndexType

        -
        public IndexType IndexType
        -
        The type of document in this index
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        Index

        -
        public Index()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/matching/IndexType.html b/docs/com/textkernel/tx/models/matching/IndexType.html deleted file mode 100644 index 2c7372cda..000000000 --- a/docs/com/textkernel/tx/models/matching/IndexType.html +++ /dev/null @@ -1,344 +0,0 @@ - - - - - - -IndexType (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.matching
-

Enum IndexType

-
-
- -
- -
-
- -
-
-
    -
  • - - - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        values

        -
        public static IndexType[] values()
        -
        Returns an array containing the constants of this enum type, in -the order they are declared. This method may be used to iterate -over the constants as follows: -
        -for (IndexType c : IndexType.values())
-    System.out.println(c);
-
        -
        -
        Returns:
        -
        an array containing the constants of this enum type, in the order they are declared
        -
        -
        • -
      - - - -
        -
      • -

        valueOf

        -
        public static IndexType valueOf(String name)
        -
        Returns the enum constant of this type with the specified name. -The string must match exactly an identifier used to declare an -enum constant in this type. (Extraneous whitespace characters are -not permitted.)
        -
        -
        Parameters:
        -
        name - the name of the enum constant to be returned.
        -
        Returns:
        -
        the enum constant with the specified name
        -
        Throws:
        -
        IllegalArgumentException - if this enum type has no constant with the specified name
        -
        NullPointerException - if the argument is null
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/matching/class-use/Index.html b/docs/com/textkernel/tx/models/matching/class-use/Index.html deleted file mode 100644 index 01242af1f..000000000 --- a/docs/com/textkernel/tx/models/matching/class-use/Index.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.matching.Index (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.matching.Index

-
-
No usage of com.textkernel.tx.models.matching.Index
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/matching/class-use/IndexType.html b/docs/com/textkernel/tx/models/matching/class-use/IndexType.html deleted file mode 100644 index 7d460c84d..000000000 --- a/docs/com/textkernel/tx/models/matching/class-use/IndexType.html +++ /dev/null @@ -1,239 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.matching.IndexType (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.matching.IndexType

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/matching/package-frame.html b/docs/com/textkernel/tx/models/matching/package-frame.html deleted file mode 100644 index cdb6f34b5..000000000 --- a/docs/com/textkernel/tx/models/matching/package-frame.html +++ /dev/null @@ -1,25 +0,0 @@ - - - - - - -com.textkernel.tx.models.matching (Textkernel Tx Java SDK 2.3.3 API) - - - - - -

com.textkernel.tx.models.matching

-
-

Classes

- -

Enums

- -
- - diff --git a/docs/com/textkernel/tx/models/matching/package-summary.html b/docs/com/textkernel/tx/models/matching/package-summary.html deleted file mode 100644 index 73d0e1d72..000000000 --- a/docs/com/textkernel/tx/models/matching/package-summary.html +++ /dev/null @@ -1,163 +0,0 @@ - - - - - - -com.textkernel.tx.models.matching (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package com.textkernel.tx.models.matching

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/matching/package-tree.html b/docs/com/textkernel/tx/models/matching/package-tree.html deleted file mode 100644 index 579327f62..000000000 --- a/docs/com/textkernel/tx/models/matching/package-tree.html +++ /dev/null @@ -1,151 +0,0 @@ - - - - - - -com.textkernel.tx.models.matching Class Hierarchy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package com.textkernel.tx.models.matching

-Package Hierarchies: - -
-
-

Class Hierarchy

- -

Enum Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/matching/package-use.html b/docs/com/textkernel/tx/models/matching/package-use.html deleted file mode 100644 index e37bcd26c..000000000 --- a/docs/com/textkernel/tx/models/matching/package-use.html +++ /dev/null @@ -1,203 +0,0 @@ - - - - - - -Uses of Package com.textkernel.tx.models.matching (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Package
com.textkernel.tx.models.matching

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/package-frame.html b/docs/com/textkernel/tx/models/package-frame.html deleted file mode 100644 index 5e7b7ae6d..000000000 --- a/docs/com/textkernel/tx/models/package-frame.html +++ /dev/null @@ -1,28 +0,0 @@ - - - - - - -com.textkernel.tx.models (Textkernel Tx Java SDK 2.3.3 API) - - - - - -

com.textkernel.tx.models

-
-

Classes

- -
- - diff --git a/docs/com/textkernel/tx/models/package-summary.html b/docs/com/textkernel/tx/models/package-summary.html deleted file mode 100644 index e62e42d14..000000000 --- a/docs/com/textkernel/tx/models/package-summary.html +++ /dev/null @@ -1,188 +0,0 @@ - - - - - - -com.textkernel.tx.models (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package com.textkernel.tx.models

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/package-tree.html b/docs/com/textkernel/tx/models/package-tree.html deleted file mode 100644 index 2d712cdd5..000000000 --- a/docs/com/textkernel/tx/models/package-tree.html +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - -com.textkernel.tx.models Class Hierarchy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package com.textkernel.tx.models

-Package Hierarchies: - -
-
-

Class Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/package-use.html b/docs/com/textkernel/tx/models/package-use.html deleted file mode 100644 index 0d3f39013..000000000 --- a/docs/com/textkernel/tx/models/package-use.html +++ /dev/null @@ -1,468 +0,0 @@ - - - - - - -Uses of Package com.textkernel.tx.models (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Package
com.textkernel.tx.models

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/Association.html b/docs/com/textkernel/tx/models/resume/Association.html deleted file mode 100644 index 7d8f3f4ae..000000000 --- a/docs/com/textkernel/tx/models/resume/Association.html +++ /dev/null @@ -1,311 +0,0 @@ - - - - - - -Association (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.resume
-

Class Association

-
-
- -
-
    -
  • -
    -
    -
    public class Association
-extends Object
    -
    An association/organization found on a resume
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Organization

        -
        public String Organization
        -
        The name of the association/organization
        -
        • -
      - - - -
        -
      • -

        Role

        -
        public String Role
        -
        The role the candidate held
        -
        • -
      - - - -
        -
      • -

        FoundInContext

        -
        public String FoundInContext
        -
        The full text in which this association was found
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        Association

        -
        public Association()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/CandidateReference.html b/docs/com/textkernel/tx/models/resume/CandidateReference.html deleted file mode 100644 index 9c72a7daf..000000000 --- a/docs/com/textkernel/tx/models/resume/CandidateReference.html +++ /dev/null @@ -1,391 +0,0 @@ - - - - - - -CandidateReference (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.resume
-

Class CandidateReference

-
-
- -
-
    -
  • -
    -
    -
    public class CandidateReference
-extends Object
    -
    A reference found on a resume
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        ReferenceName

        -
        public PersonName ReferenceName
        -
        The name of the reference
        -
        • -
      - - - -
        -
      • -

        Title

        -
        public String Title
        -
        The job title of the reference
        -
        • -
      - - - -
        -
      • -

        Company

        -
        public String Company
        -
        The employer of the reference
        -
        • -
      - - - -
        -
      • -

        Type

        -
        public String Type
        -
        The type of reference
        -
        • -
      - - - -
        -
      • -

        Location

        -
        public Location Location
        -
        The physical location of the reference
        -
        • -
      - - - -
        -
      • -

        Telephones

        -
        public List<NormalizedString> Telephones
        -
        Phone numbers listed for the reference
        -
        • -
      - - - -
        -
      • -

        EmailAddresses

        -
        public List<String> EmailAddresses
        -
        Email addresses listed for the reference
        -
        • -
      - - - -
        -
      • -

        WebAddresses

        -
        public List<WebAddress> WebAddresses
        -
        Other web addresses listed for the reference
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        CandidateReference

        -
        public CandidateReference()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/Certification.html b/docs/com/textkernel/tx/models/resume/Certification.html deleted file mode 100644 index 3aa69295b..000000000 --- a/docs/com/textkernel/tx/models/resume/Certification.html +++ /dev/null @@ -1,315 +0,0 @@ - - - - - - -Certification (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.resume
-

Class Certification

-
-
- -
-
    -
  • -
    -
    -
    public class Certification
-extends Object
    -
    A certification found on a resume
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Name

        -
        public String Name
        -
        The name of the certification
        -
        • -
      - - - -
        -
      • -

        MatchedFromList

        -
        public boolean MatchedFromList
        -
        true if this was found by matching to a known list of certifications. - false if this was found by analyzing the context and determining it was a certification.
        -
        • -
      - - - -
        -
      • -

        IsVariation

        -
        public boolean IsVariation
        -
        The parser generates several possible variations for some certifications to be used in AI Matching. - This greatly improves Matching, since different candidates have different ways of listing a certification. - If this certification is a generated variation of a certification found on the resume, this property will be - true, otherwise false.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        Certification

        -
        public Certification()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/LanguageCompetency.html b/docs/com/textkernel/tx/models/resume/LanguageCompetency.html deleted file mode 100644 index 19be38303..000000000 --- a/docs/com/textkernel/tx/models/resume/LanguageCompetency.html +++ /dev/null @@ -1,311 +0,0 @@ - - - - - - -LanguageCompetency (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.resume
-

Class LanguageCompetency

-
-
- -
-
    -
  • -
    -
    -
    public class LanguageCompetency
-extends Object
    -
    A language competency (fluent in, can read, can write, etc) found on a resume
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Language

        -
        public String Language
        -
        The language name
        -
        • -
      - - - -
        -
      • -

        LanguageCode

        -
        public String LanguageCode
        -
        The two-letter ISO 639-1 code for the language
        -
        • -
      - - - -
        -
      • -

        FoundInContext

        -
        public String FoundInContext
        -
        The full text where this language competency was found
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        LanguageCompetency

        -
        public LanguageCompetency()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/LicenseDetails.html b/docs/com/textkernel/tx/models/resume/LicenseDetails.html deleted file mode 100644 index cc0e3d6b8..000000000 --- a/docs/com/textkernel/tx/models/resume/LicenseDetails.html +++ /dev/null @@ -1,296 +0,0 @@ - - - - - - -LicenseDetails (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.resume
-

Class LicenseDetails

-
-
- -
-
    -
  • -
    -
    -
    public class LicenseDetails
-extends Object
    -
    A license found on a resume. These are professional licenses, not driving licenses. For driving licenses, see tx.models.resume.PersonalAttributes.DrivingLicense
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Name

        -
        public String Name
        -
        The name of the license
        -
        • -
      - - - -
        -
      • -

        MatchedFromList

        -
        public boolean MatchedFromList
        -
        true if this was found by matching to a known list of licenses. - false if this was found this by analyzing the context and determining it was a license.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        LicenseDetails

        -
        public LicenseDetails()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/NationalIdentity.html b/docs/com/textkernel/tx/models/resume/NationalIdentity.html deleted file mode 100644 index 66eee26df..000000000 --- a/docs/com/textkernel/tx/models/resume/NationalIdentity.html +++ /dev/null @@ -1,295 +0,0 @@ - - - - - - -NationalIdentity (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.resume
-

Class NationalIdentity

-
-
- -
-
    -
  • -
    -
    -
    public class NationalIdentity
-extends Object
    -
    A national identity found on a resume
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Number

        -
        public String Number
        -
        The national identity number
        -
        • -
      - - - -
        -
      • -

        Phrase

        -
        public String Phrase
        -
        The type of identity/number this is (for example, SSN)
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        NationalIdentity

        -
        public NationalIdentity()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/NormalizedString.html b/docs/com/textkernel/tx/models/resume/NormalizedString.html deleted file mode 100644 index 09b2171a9..000000000 --- a/docs/com/textkernel/tx/models/resume/NormalizedString.html +++ /dev/null @@ -1,299 +0,0 @@ - - - - - - -NormalizedString (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.resume
-

Class NormalizedString

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Raw

        -
        public String Raw
        -
        The raw value found in the text
        -
        • -
      - - - -
        -
      • -

        Normalized

        -
        public String Normalized
        -
        The normalized value
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        NormalizedString

        -
        public NormalizedString()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/ParsedResume.html b/docs/com/textkernel/tx/models/resume/ParsedResume.html deleted file mode 100644 index d092b9bb7..000000000 --- a/docs/com/textkernel/tx/models/resume/ParsedResume.html +++ /dev/null @@ -1,764 +0,0 @@ - - - - - - -ParsedResume (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.resume
-

Class ParsedResume

-
-
- -
-
    -
  • -
    -
    -
    public class ParsedResume
-extends ParsedDocument
    -
    All of the information extracted while parsing a resume
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        ContactInformation

        -
        public ContactInformation ContactInformation
        -
        The candidate's contact information found on the resume
        -
        • -
      - - - -
        -
      • -

        ProfessionalSummary

        -
        public String ProfessionalSummary
        -
        The professional summary from the resume
        -
        • -
      - - - -
        -
      • -

        Objective

        -
        public String Objective
        -
        The candidate's written objective
        -
        • -
      - - - -
        -
      • -

        CoverLetter

        -
        public String CoverLetter
        -
        The cover letter, if present.
        -
        • -
      - - - -
        -
      • -

        PersonalAttributes

        -
        public PersonalAttributes PersonalAttributes
        -
        Personal information provided by the candidate on the resume
        -
        • -
      - - - -
        -
      • -

        Education

        -
        public EducationHistory Education
        -
        The candidate's education history found on the resume
        -
        • -
      - - - -
        -
      • -

        EmploymentHistory

        -
        public EmploymentHistory EmploymentHistory
        -
        The candidate's employment/work history found on the resume
        -
        • -
      - - - - - - - - - - - -
        -
      • -

        Certifications

        -
        public List<Certification> Certifications
        -
        Certifications found on a resume.
        -
        • -
      - - - - - - - -
        -
      • -

        Associations

        -
        public List<Association> Associations
        -
        Associations/organizations found on a resume
        -
        • -
      - - - -
        -
      • -

        LanguageCompetencies

        -
        public List<LanguageCompetency> LanguageCompetencies
        -
        Any language competencies (fluent in, can read, can write, etc) found in the resume.
        -
        • -
      - - - -
        -
      • -

        MilitaryExperience

        -
        public List<MilitaryDetails> MilitaryExperience
        -
        Any military experience listed on the resume
        -
        • -
      - - - -
        -
      • -

        SecurityCredentials

        -
        public List<SecurityCredential> SecurityCredentials
        -
        Any security credentials/clearances listed on the resume
        -
        • -
      - - - - - - - -
        -
      • -

        Achievements

        -
        public List<String> Achievements
        -
        Any achievements listed on the resume
        -
        • -
      - - - -
        -
      • -

        Training

        -
        public TrainingHistory Training
        -
        Any training listed on the resume
        -
        • -
      - - - -
        -
      • -

        QualificationsSummary

        -
        public String QualificationsSummary
        -
        A standalone 'skills' section, if listed on the resume
        -
        • -
      - - - -
        -
      • -

        Hobbies

        -
        public String Hobbies
        -
        Any hobbies listed on the resume
        -
        • -
      - - - -
        -
      • -

        Patents

        -
        public String Patents
        -
        Any patents listed on the resume
        -
        • -
      - - - -
        -
      • -

        Publications

        -
        public String Publications
        -
        Any publications listed on the resume
        -
        • -
      - - - -
        -
      • -

        SpeakingEngagements

        -
        public String SpeakingEngagements
        -
        Any speaking engagements/appearances listed on the resume
        -
        • -
      - - - -
        -
      • -

        ResumeMetadata

        -
        public ResumeMetadata ResumeMetadata
        -
        Metadata about the parsed resume
        -
        • -
      - - - -
        -
      • -

        UserDefinedTags

        -
        public List<String> UserDefinedTags
        -
        A list of User-Defined Tags - that are assigned to this resume. These are used to filter search/match queries in the AI Matching Engine. -

        NOTE: you may add/remove these prior to indexing. This is the only property you may modify prior to indexing.

        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ParsedResume

        -
        @Deprecated
-public ParsedResume()
        -
        Deprecated. You should never create one of these. Instead, these are output by the Resume Parser. - The API does not support manually-created resumes to be used in the AI Matching engine.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        fromFile

        -
        public static ParsedResume fromFile(String path)
-                             throws IOException,
-                                    com.google.gson.JsonParseException
        -
        Load a parsed resume from a json file using UTF-8 encoding. This is useful when you have stored parse results to disk for use later.
        -
        -
        Parameters:
        -
        path - The full path to the json file
        -
        Returns:
        -
        The deserialized ParsedResume
        -
        Throws:
        -
        IOException - When an error occurs reading the file
        -
        com.google.gson.JsonParseException - If you try to parse an invalid ParsedResume JSON string
        -
        -
        • -
      - - - -
        -
      • -

        fromJson

        -
        public static ParsedResume fromJson(String utf8json)
-                             throws com.google.gson.JsonParseException
        -
        Create a parsed resume from json. This is useful when you have stored parse results to disk for use later.
        -
        -
        Parameters:
        -
        utf8json - The UTF-8 encoded json string
        -
        Returns:
        -
        The deserialized ParsedResume
        -
        Throws:
        -
        com.google.gson.JsonParseException - If you try to parse an invalid ParsedResume JSON string
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/PersonalAttributes.html b/docs/com/textkernel/tx/models/resume/PersonalAttributes.html deleted file mode 100644 index c2c818604..000000000 --- a/docs/com/textkernel/tx/models/resume/PersonalAttributes.html +++ /dev/null @@ -1,599 +0,0 @@ - - - - - - -PersonalAttributes (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.resume
-

Class PersonalAttributes

-
-
- -
-
    -
  • -
    -
    -
    public class PersonalAttributes
-extends Object
    -
    Personal attributes found on a resume
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Availability

        -
        public String Availability
        -
        The availability of the candidate
        -
        • -
      - - - -
        -
      • -

        Birthplace

        -
        public String Birthplace
        -
        The birthplace of the candidate
        -
        • -
      - - - -
        -
      • -

        CurrentLocation

        -
        public String CurrentLocation
        -
        The current location listed on the resume
        -
        • -
      - - - -
        -
      • -

        CurrentSalary

        -
        public Salary CurrentSalary
        -
        The current salary listed on the resume
        -
        • -
      - - - -
        -
      • -

        DateOfBirth

        -
        public TxDate DateOfBirth
        -
        The date of birth given on the resume
        -
        • -
      - - - -
        -
      • -

        DrivingLicense

        -
        public String DrivingLicense
        -
        A driving license listed on the resume
        -
        • -
      - - - -
        -
      • -

        FamilyComposition

        -
        public String FamilyComposition
        -
        The family composition
        -
        • -
      - - - -
        -
      • -

        FathersName

        -
        public String FathersName
        -
        The candidate's father's name listed on the resume
        -
        • -
      - - - -
        -
      • -

        Gender

        -
        public String Gender
        -
        The candidate's gender listed on the resume
        -
        • -
      - - - -
        -
      • -

        HukouCity

        -
        public String HukouCity
        -
        Used in Chinese resumes
        -
        • -
      - - - -
        -
      • -

        HukouArea

        -
        public String HukouArea
        -
        Used in Chinese resumes
        -
        • -
      - - - -
        -
      • -

        MaritalStatus

        -
        public String MaritalStatus
        -
        The marital status listed on the resume
        -
        • -
      - - - -
        -
      • -

        MothersMaidenName

        -
        public String MothersMaidenName
        -
        The candidate's mother's maiden name listed on the resume
        -
        • -
      - - - -
        -
      • -

        MotherTongue

        -
        public String MotherTongue
        -
        The candidate's mother tongue (native language) listed on the resume
        -
        • -
      - - - -
        -
      • -

        NationalIdentities

        -
        public List<NationalIdentity> NationalIdentities
        -
        Any national identities provided on the resume
        -
        • -
      - - - -
        -
      • -

        Nationality

        -
        public String Nationality
        -
        The candidate's nationality listed on the resume
        -
        • -
      - - - -
        -
      • -

        PassportNumber

        -
        public String PassportNumber
        -
        The candidate's passport number listed on the resume
        -
        • -
      - - - -
        -
      • -

        PreferredLocation

        -
        public String PreferredLocation
        -
        The candidate's preferred location listed on the resume
        -
        • -
      - - - -
        -
      • -

        RequiredSalary

        -
        public Salary RequiredSalary
        -
        The candidate's required salary listed on the resume
        -
        • -
      - - - -
        -
      • -

        VisaStatus

        -
        public String VisaStatus
        -
        The candidate's visa status listed on the resume
        -
        • -
      - - - -
        -
      • -

        WillingToRelocate

        -
        public String WillingToRelocate
        -
        Whether the candidate is willing to relocate
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        PersonalAttributes

        -
        public PersonalAttributes()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/Salary.html b/docs/com/textkernel/tx/models/resume/Salary.html deleted file mode 100644 index f100317e6..000000000 --- a/docs/com/textkernel/tx/models/resume/Salary.html +++ /dev/null @@ -1,295 +0,0 @@ - - - - - - -Salary (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.resume
-

Class Salary

-
-
- -
-
    -
  • -
    -
    -
    public class Salary
-extends Object
    -
    A salary found in a resume
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Currency

        -
        public String Currency
        -
        The three-letter currency, eg: USD
        -
        • -
      - - - -
        -
      • -

        Amount

        -
        public double Amount
        -
        The amount of the salary (usually yearly when listed on a resume)
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        Salary

        -
        public Salary()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/SectionIdentifier.html b/docs/com/textkernel/tx/models/resume/SectionIdentifier.html deleted file mode 100644 index 669a8fd99..000000000 --- a/docs/com/textkernel/tx/models/resume/SectionIdentifier.html +++ /dev/null @@ -1,295 +0,0 @@ - - - - - - -SectionIdentifier (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.resume
-

Class SectionIdentifier

-
-
- -
-
    -
  • -
    -
    -
    public class SectionIdentifier
-extends Object
    -
    Information about a particular section of a resume
    -
    • -
-
-
- -
-
- -
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/TrainingDetails.html b/docs/com/textkernel/tx/models/resume/TrainingDetails.html deleted file mode 100644 index 13d6210e5..000000000 --- a/docs/com/textkernel/tx/models/resume/TrainingDetails.html +++ /dev/null @@ -1,345 +0,0 @@ - - - - - - -TrainingDetails (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.resume
-

Class TrainingDetails

-
-
- -
-
    -
  • -
    -
    -
    public class TrainingDetails
-extends Object
    -
    A training history found on a resume
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Text

        -
        public String Text
        -
        The text that was found on the resume
        -
        • -
      - - - -
        -
      • -

        Entity

        -
        public String Entity
        -
        The name of the school or company where the training occurred.
        -
        • -
      - - - -
        -
      • -

        Qualifications

        -
        public List<String> Qualifications
        -
        Any text within the Text that is recognized as a qualification (such as DDS), - degree (such as B.S.), or a certification (such as PMP). Each qualification is listed separately.
        -
        • -
      - - - -
        -
      • -

        StartDate

        -
        public TxDate StartDate
        -
        The date the training started
        -
        • -
      - - - -
        -
      • -

        EndDate

        -
        public TxDate EndDate
        -
        The date the training ended
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        TrainingDetails

        -
        public TrainingDetails()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/TrainingHistory.html b/docs/com/textkernel/tx/models/resume/TrainingHistory.html deleted file mode 100644 index 083a27f33..000000000 --- a/docs/com/textkernel/tx/models/resume/TrainingHistory.html +++ /dev/null @@ -1,295 +0,0 @@ - - - - - - -TrainingHistory (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.resume
-

Class TrainingHistory

-
-
- -
-
    -
  • -
    -
    -
    public class TrainingHistory
-extends Object
    -
    All training info found in a resume
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Text

        -
        public String Text
        -
        The full text where we found all training history
        -
        • -
      - - - -
        -
      • -

        Trainings

        -
        public List<TrainingDetails> Trainings
        -
        Information about each training history we found
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        TrainingHistory

        -
        public TrainingHistory()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/class-use/Association.html b/docs/com/textkernel/tx/models/resume/class-use/Association.html deleted file mode 100644 index aa482b3b1..000000000 --- a/docs/com/textkernel/tx/models/resume/class-use/Association.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.resume.Association (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.resume.Association

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/class-use/CandidateReference.html b/docs/com/textkernel/tx/models/resume/class-use/CandidateReference.html deleted file mode 100644 index 79475fdf5..000000000 --- a/docs/com/textkernel/tx/models/resume/class-use/CandidateReference.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.resume.CandidateReference (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.resume.CandidateReference

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/class-use/Certification.html b/docs/com/textkernel/tx/models/resume/class-use/Certification.html deleted file mode 100644 index c54f739ca..000000000 --- a/docs/com/textkernel/tx/models/resume/class-use/Certification.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.resume.Certification (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.resume.Certification

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/class-use/LanguageCompetency.html b/docs/com/textkernel/tx/models/resume/class-use/LanguageCompetency.html deleted file mode 100644 index d049f6ca0..000000000 --- a/docs/com/textkernel/tx/models/resume/class-use/LanguageCompetency.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.resume.LanguageCompetency (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.resume.LanguageCompetency

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/class-use/LicenseDetails.html b/docs/com/textkernel/tx/models/resume/class-use/LicenseDetails.html deleted file mode 100644 index 226647bf4..000000000 --- a/docs/com/textkernel/tx/models/resume/class-use/LicenseDetails.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.resume.LicenseDetails (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.resume.LicenseDetails

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/class-use/NationalIdentity.html b/docs/com/textkernel/tx/models/resume/class-use/NationalIdentity.html deleted file mode 100644 index d63ff442d..000000000 --- a/docs/com/textkernel/tx/models/resume/class-use/NationalIdentity.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.resume.NationalIdentity (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.resume.NationalIdentity

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/class-use/NormalizedString.html b/docs/com/textkernel/tx/models/resume/class-use/NormalizedString.html deleted file mode 100644 index 620542624..000000000 --- a/docs/com/textkernel/tx/models/resume/class-use/NormalizedString.html +++ /dev/null @@ -1,262 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.resume.NormalizedString (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.resume.NormalizedString

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/class-use/ParsedResume.html b/docs/com/textkernel/tx/models/resume/class-use/ParsedResume.html deleted file mode 100644 index 31c2017f2..000000000 --- a/docs/com/textkernel/tx/models/resume/class-use/ParsedResume.html +++ /dev/null @@ -1,579 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.resume.ParsedResume (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.resume.ParsedResume

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/class-use/PersonalAttributes.html b/docs/com/textkernel/tx/models/resume/class-use/PersonalAttributes.html deleted file mode 100644 index 649987cbe..000000000 --- a/docs/com/textkernel/tx/models/resume/class-use/PersonalAttributes.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.resume.PersonalAttributes (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.resume.PersonalAttributes

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/class-use/Salary.html b/docs/com/textkernel/tx/models/resume/class-use/Salary.html deleted file mode 100644 index 8dcc1614f..000000000 --- a/docs/com/textkernel/tx/models/resume/class-use/Salary.html +++ /dev/null @@ -1,174 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.resume.Salary (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.resume.Salary

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/class-use/SectionIdentifier.html b/docs/com/textkernel/tx/models/resume/class-use/SectionIdentifier.html deleted file mode 100644 index 76b7016fb..000000000 --- a/docs/com/textkernel/tx/models/resume/class-use/SectionIdentifier.html +++ /dev/null @@ -1,204 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.resume.SectionIdentifier (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.resume.SectionIdentifier

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/class-use/TrainingDetails.html b/docs/com/textkernel/tx/models/resume/class-use/TrainingDetails.html deleted file mode 100644 index 11cc009b0..000000000 --- a/docs/com/textkernel/tx/models/resume/class-use/TrainingDetails.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.resume.TrainingDetails (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.resume.TrainingDetails

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/class-use/TrainingHistory.html b/docs/com/textkernel/tx/models/resume/class-use/TrainingHistory.html deleted file mode 100644 index 546c24d20..000000000 --- a/docs/com/textkernel/tx/models/resume/class-use/TrainingHistory.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.resume.TrainingHistory (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.resume.TrainingHistory

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/contactinfo/ContactInformation.html b/docs/com/textkernel/tx/models/resume/contactinfo/ContactInformation.html deleted file mode 100644 index 7c6bb11d7..000000000 --- a/docs/com/textkernel/tx/models/resume/contactinfo/ContactInformation.html +++ /dev/null @@ -1,345 +0,0 @@ - - - - - - -ContactInformation (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.resume.contactinfo
-

Class ContactInformation

-
-
- -
-
    -
  • -
    -
    -
    public class ContactInformation
-extends Object
    -
    A candidate's contact information listed on a resume
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        CandidateName

        -
        public PersonName CandidateName
        -
        The candidate's name
        -
        • -
      - - - -
        -
      • -

        Telephones

        -
        public List<Telephone> Telephones
        -
        The candidate's phone numbers. If multiple numbers are found, mobile phone numbers will be listed first
        -
        • -
      - - - -
        -
      • -

        EmailAddresses

        -
        public List<String> EmailAddresses
        -
        The candidate's email addresses
        -
        • -
      - - - -
        -
      • -

        Location

        -
        public Location Location
        -
        The candidate's location/address. The Parser does not standardize addresses. Address standardization - services are available, including for example the Google Maps API, that can take the Parser's contact - info fields and standardize/geocode the data.
        -
        • -
      - - - -
        -
      • -

        WebAddresses

        -
        public List<WebAddress> WebAddresses
        -
        The candidate's web addresses (URLs, social media) listed on the resume
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ContactInformation

        -
        public ContactInformation()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/contactinfo/PersonName.html b/docs/com/textkernel/tx/models/resume/contactinfo/PersonName.html deleted file mode 100644 index ce4d43b19..000000000 --- a/docs/com/textkernel/tx/models/resume/contactinfo/PersonName.html +++ /dev/null @@ -1,375 +0,0 @@ - - - - - - -PersonName (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.resume.contactinfo
-

Class PersonName

-
-
- -
-
    -
  • -
    -
    -
    public class PersonName
-extends Object
    -
    A name broken into its constituent parts
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        FormattedName

        -
        public String FormattedName
        -
        The full name in a standard format
        -
        • -
      - - - -
        -
      • -

        Prefix

        -
        public String Prefix
        -
        A prefix for a name, such as Dr.
        -
        • -
      - - - -
        -
      • -

        GivenName

        -
        public String GivenName
        -
        The given (first) name
        -
        • -
      - - - -
        -
      • -

        MiddleName

        -
        public String MiddleName
        -
        The middle name or initial
        -
        • -
      - - - -
        -
      • -

        Moniker

        -
        public String Moniker
        -
        The nickname/moniker, this is rarely populated
        -
        • -
      - - - -
        -
      • -

        FamilyName

        -
        public String FamilyName
        -
        The family (last) name
        -
        • -
      - - - -
        -
      • -

        Suffix

        -
        public String Suffix
        -
        A suffix for a name, such as Jr. or III
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        PersonName

        -
        public PersonName()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/contactinfo/Telephone.html b/docs/com/textkernel/tx/models/resume/contactinfo/Telephone.html deleted file mode 100644 index 16ae8cb2f..000000000 --- a/docs/com/textkernel/tx/models/resume/contactinfo/Telephone.html +++ /dev/null @@ -1,323 +0,0 @@ - - - - - - -Telephone (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.resume.contactinfo
-

Class Telephone

-
-
- -
-
    -
  • -
    -
    -
    public class Telephone
-extends NormalizedString
    -
    A phone number listed on the resume
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        InternationalCountryCode

        -
        public String InternationalCountryCode
        -
        The international country code part of the phone number
        -
        • -
      - - - -
        -
      • -

        AreaCityCode

        -
        public String AreaCityCode
        -
        The area code part of the phone number
        -
        • -
      - - - -
        -
      • -

        SubscriberNumber

        -
        public String SubscriberNumber
        -
        The subscriber number part of the phone number
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        Telephone

        -
        public Telephone()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/contactinfo/WebAddress.html b/docs/com/textkernel/tx/models/resume/contactinfo/WebAddress.html deleted file mode 100644 index ad72a35e8..000000000 --- a/docs/com/textkernel/tx/models/resume/contactinfo/WebAddress.html +++ /dev/null @@ -1,316 +0,0 @@ - - - - - - -WebAddress (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.resume.contactinfo
-

Class WebAddress

-
-
- -
-
    -
  • -
    -
    -
    public class WebAddress
-extends Object
    -
    A web address (URL, twitter handle, etc)
    -
    • -
-
-
- -
-
- -
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/contactinfo/WebAddressType.html b/docs/com/textkernel/tx/models/resume/contactinfo/WebAddressType.html deleted file mode 100644 index ae1998503..000000000 --- a/docs/com/textkernel/tx/models/resume/contactinfo/WebAddressType.html +++ /dev/null @@ -1,581 +0,0 @@ - - - - - - -WebAddressType (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.resume.contactinfo
-

Class WebAddressType

-
-
- -
-
    -
  • -
    -
    -
    public class WebAddressType
-extends Object
    -
    A type of WebAddress. These are useful instead of magic strings.
    -
    • -
-
-
- -
-
- -
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/contactinfo/class-use/ContactInformation.html b/docs/com/textkernel/tx/models/resume/contactinfo/class-use/ContactInformation.html deleted file mode 100644 index 371163944..000000000 --- a/docs/com/textkernel/tx/models/resume/contactinfo/class-use/ContactInformation.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.resume.contactinfo.ContactInformation (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.resume.contactinfo.ContactInformation

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/contactinfo/class-use/PersonName.html b/docs/com/textkernel/tx/models/resume/contactinfo/class-use/PersonName.html deleted file mode 100644 index 73c57be3b..000000000 --- a/docs/com/textkernel/tx/models/resume/contactinfo/class-use/PersonName.html +++ /dev/null @@ -1,192 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.resume.contactinfo.PersonName (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.resume.contactinfo.PersonName

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/contactinfo/class-use/Telephone.html b/docs/com/textkernel/tx/models/resume/contactinfo/class-use/Telephone.html deleted file mode 100644 index 99d6eed98..000000000 --- a/docs/com/textkernel/tx/models/resume/contactinfo/class-use/Telephone.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.resume.contactinfo.Telephone (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.resume.contactinfo.Telephone

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/contactinfo/class-use/WebAddress.html b/docs/com/textkernel/tx/models/resume/contactinfo/class-use/WebAddress.html deleted file mode 100644 index 99e1ac6e9..000000000 --- a/docs/com/textkernel/tx/models/resume/contactinfo/class-use/WebAddress.html +++ /dev/null @@ -1,192 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.resume.contactinfo.WebAddress (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.resume.contactinfo.WebAddress

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/contactinfo/class-use/WebAddressType.html b/docs/com/textkernel/tx/models/resume/contactinfo/class-use/WebAddressType.html deleted file mode 100644 index f57d6b03e..000000000 --- a/docs/com/textkernel/tx/models/resume/contactinfo/class-use/WebAddressType.html +++ /dev/null @@ -1,288 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.resume.contactinfo.WebAddressType (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.resume.contactinfo.WebAddressType

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/contactinfo/package-frame.html b/docs/com/textkernel/tx/models/resume/contactinfo/package-frame.html deleted file mode 100644 index 51a97b1c5..000000000 --- a/docs/com/textkernel/tx/models/resume/contactinfo/package-frame.html +++ /dev/null @@ -1,25 +0,0 @@ - - - - - - -com.textkernel.tx.models.resume.contactinfo (Textkernel Tx Java SDK 2.3.3 API) - - - - - -

com.textkernel.tx.models.resume.contactinfo

-
-

Classes

- -
- - diff --git a/docs/com/textkernel/tx/models/resume/contactinfo/package-summary.html b/docs/com/textkernel/tx/models/resume/contactinfo/package-summary.html deleted file mode 100644 index 349cd65f8..000000000 --- a/docs/com/textkernel/tx/models/resume/contactinfo/package-summary.html +++ /dev/null @@ -1,170 +0,0 @@ - - - - - - -com.textkernel.tx.models.resume.contactinfo (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package com.textkernel.tx.models.resume.contactinfo

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/contactinfo/package-tree.html b/docs/com/textkernel/tx/models/resume/contactinfo/package-tree.html deleted file mode 100644 index 6020a2720..000000000 --- a/docs/com/textkernel/tx/models/resume/contactinfo/package-tree.html +++ /dev/null @@ -1,147 +0,0 @@ - - - - - - -com.textkernel.tx.models.resume.contactinfo Class Hierarchy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package com.textkernel.tx.models.resume.contactinfo

-Package Hierarchies: - -
-
-

Class Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/contactinfo/package-use.html b/docs/com/textkernel/tx/models/resume/contactinfo/package-use.html deleted file mode 100644 index 66314307b..000000000 --- a/docs/com/textkernel/tx/models/resume/contactinfo/package-use.html +++ /dev/null @@ -1,207 +0,0 @@ - - - - - - -Uses of Package com.textkernel.tx.models.resume.contactinfo (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Package
com.textkernel.tx.models.resume.contactinfo

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/education/Degree.html b/docs/com/textkernel/tx/models/resume/education/Degree.html deleted file mode 100644 index f728d56d0..000000000 --- a/docs/com/textkernel/tx/models/resume/education/Degree.html +++ /dev/null @@ -1,370 +0,0 @@ - - - - - - -Degree (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.resume.education
-

Class Degree

-
-
- -
-
    -
  • -
    -
    -
    public class Degree
-extends Object
    -
    An educational degree
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - - - - - -
        -
      • -

        Type

        -
        @Deprecated
-public String Type
        -
        Deprecated. 
        -
        Deprecated - use NormalizedLocal and NormalizedInternational instead. -

        - These values are not very global-friendly, but the Parser does normalize all degrees - to one of these pre-defined types. This list is sorted, as well as possible, by increasing - level of education, although there are certainly ambiguities from one discipline to - another, such as whether professional is above or below bachelors. Here are the possible values: -
          -
        • lessThanHighSchool
          • -
        • specialeducation
          • -
        • someHighSchoolOrEquivalent
          • -
        • ged
          • -
        • certification
          • -
        • vocational
          • -
        • secondary
          • -
        • highSchoolOrEquivalent
          • -
        • someCollege
          • -
        • HND_HNC_OrEquivalent
          • -
        • ASc
          • -
        • associates
          • -
        • international
          • -
        • professional
          • -
        • postprofessional
          • -
        • BSc
          • -
        • bachelors
          • -
        • somePostgraduate
          • -
        • MBA
          • -
        • MSc
          • -
        • masters
          • -
        • intermediategraduate
          • -
        • doctorate
          • -
        • postdoctorate
          • -
        -
        • -
      - - - - - - - - -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        Degree

        -
        public Degree()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/education/EducationDetails.html b/docs/com/textkernel/tx/models/resume/education/EducationDetails.html deleted file mode 100644 index 9cd8d9ea8..000000000 --- a/docs/com/textkernel/tx/models/resume/education/EducationDetails.html +++ /dev/null @@ -1,486 +0,0 @@ - - - - - - -EducationDetails (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.resume.education
-

Class EducationDetails

-
-
- -
-
    -
  • -
    -
    -
    public class EducationDetails
-extends Object
    -
    An education entry on a resume
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Id

        -
        public String Id
        -
        The id of this education entry (one-based, so EDU-1 is the first, etc)
        -
        • -
      - - - -
        -
      • -

        Text

        -
        public String Text
        -
        The raw text from the resume
        -
        • -
      - - - -
        -
      • -

        SchoolName

        -
        public NormalizedString SchoolName
        -
        The name of the school attended
        -
        • -
      - - - -
        -
      • -

        SchoolType

        -
        public String SchoolType
        -
        The type of the school attended. One of: -
          -
        • UNSPECIFIED
          • -
        • lowerSchool
          • -
        • highschool
          • -
        • secondary
          • -
        • trade
          • -
        • professional
          • -
        • vocational
          • -
        • community
          • -
        • college
          • -
        • university
          • -
        -
        • -
      - - - -
        -
      • -

        Location

        -
        public Location Location
        -
        The Country/Region/City of the school, if found
        -
        • -
      - - - -
        -
      • -

        Degree

        -
        public Degree Degree
        -
        The degree obtained (or worked toward)
        -
        • -
      - - - -
        -
      • -

        Majors

        -
        public List<String> Majors
        -
        Any majors/areas of major focus
        -
        • -
      - - - -
        -
      • -

        Minors

        -
        public List<String> Minors
        -
        Any minors/areas of minor focus
        -
        • -
      - - - - - - - -
        -
      • -

        LastEducationDate

        -
        public TxDate LastEducationDate
        -
        Deprecated. use EndDate instead
        -
        The date graduated or education ended
        -
        • -
      - - - -
        -
      • -

        StartDate

        -
        public TxDate StartDate
        -
        The date education started
        -
        • -
      - - - -
        -
      • -

        EndDate

        -
        public TxDate EndDate
        -
        The date graduated or education ended
        -
        • -
      - - - -
        -
      • -

        Graduated

        -
        public TxPrimitive<Boolean> Graduated
        -
        Whether or not the candidate graduated
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        EducationDetails

        -
        public EducationDetails()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/education/EducationHistory.html b/docs/com/textkernel/tx/models/resume/education/EducationHistory.html deleted file mode 100644 index 2c416e4de..000000000 --- a/docs/com/textkernel/tx/models/resume/education/EducationHistory.html +++ /dev/null @@ -1,295 +0,0 @@ - - - - - - -EducationHistory (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.resume.education
-

Class EducationHistory

-
-
- -
-
    -
  • -
    -
    -
    public class EducationHistory
-extends Object
    -
    Information about education history found on a resume
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        HighestDegree

        -
        public Degree HighestDegree
        -
        The highest degree obtained by a candidate
        -
        • -
      - - - -
        -
      • -

        EducationDetails

        -
        public List<EducationDetails> EducationDetails
        -
        All of the education details listed on a resume
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        EducationHistory

        -
        public EducationHistory()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/education/GradePointAverage.html b/docs/com/textkernel/tx/models/resume/education/GradePointAverage.html deleted file mode 100644 index 80021a4ee..000000000 --- a/docs/com/textkernel/tx/models/resume/education/GradePointAverage.html +++ /dev/null @@ -1,350 +0,0 @@ - - - - - - -GradePointAverage (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.resume.education
-

Class GradePointAverage

-
-
- -
-
    -
  • -
    -
    -
    public class GradePointAverage
-extends Object
    -
    Information about a GPA (or equivalent)
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Score

        -
        public String Score
        -
        The score found in the resume
        -
        • -
      - - - -
        -
      • -

        ScoringSystem

        -
        public String ScoringSystem
        -
        The scoring system used on the resume
        -
        • -
      - - - - - - - - - - - -
        -
      • -

        NormalizedScore

        -
        public double NormalizedScore
        -
        The Score, normalized to a 0.0-1.0 scale, with 1.0 being the top mark. - This takes into account different min/max values and whether high or low numbers - are ranked higher. This makes it possible/valid to compare GPAs across various scales. - For example: -
          -
        • USA degree with GPA of 3.5 / 4.0 = 0.875
          • -
        • German degree with 1.5 / 6.0 = 0.916
          • -
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        GradePointAverage

        -
        public GradePointAverage()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/education/NormalizedDegree.html b/docs/com/textkernel/tx/models/resume/education/NormalizedDegree.html deleted file mode 100644 index 8576724ac..000000000 --- a/docs/com/textkernel/tx/models/resume/education/NormalizedDegree.html +++ /dev/null @@ -1,295 +0,0 @@ - - - - - - -NormalizedDegree (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.resume.education
-

Class NormalizedDegree

-
-
- -
-
    -
  • -
    -
    -
    public class NormalizedDegree
-extends Object
    -
    A normalized educational degree
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Code

        -
        public String Code
        -
        One of the codes listed here.
        -
        • -
      - - - -
        -
      • -

        Description

        -
        public String Description
        -
        One of the descriptions listed here.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        NormalizedDegree

        -
        public NormalizedDegree()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/education/class-use/Degree.html b/docs/com/textkernel/tx/models/resume/education/class-use/Degree.html deleted file mode 100644 index a82ade68d..000000000 --- a/docs/com/textkernel/tx/models/resume/education/class-use/Degree.html +++ /dev/null @@ -1,174 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.resume.education.Degree (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.resume.education.Degree

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/education/class-use/EducationDetails.html b/docs/com/textkernel/tx/models/resume/education/class-use/EducationDetails.html deleted file mode 100644 index ceadd7257..000000000 --- a/docs/com/textkernel/tx/models/resume/education/class-use/EducationDetails.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.resume.education.EducationDetails (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.resume.education.EducationDetails

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/education/class-use/EducationHistory.html b/docs/com/textkernel/tx/models/resume/education/class-use/EducationHistory.html deleted file mode 100644 index 12c5f61bd..000000000 --- a/docs/com/textkernel/tx/models/resume/education/class-use/EducationHistory.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.resume.education.EducationHistory (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.resume.education.EducationHistory

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/education/class-use/GradePointAverage.html b/docs/com/textkernel/tx/models/resume/education/class-use/GradePointAverage.html deleted file mode 100644 index c18059fc6..000000000 --- a/docs/com/textkernel/tx/models/resume/education/class-use/GradePointAverage.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.resume.education.GradePointAverage (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.resume.education.GradePointAverage

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/education/class-use/NormalizedDegree.html b/docs/com/textkernel/tx/models/resume/education/class-use/NormalizedDegree.html deleted file mode 100644 index 404fc3fd1..000000000 --- a/docs/com/textkernel/tx/models/resume/education/class-use/NormalizedDegree.html +++ /dev/null @@ -1,174 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.resume.education.NormalizedDegree (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.resume.education.NormalizedDegree

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/education/package-frame.html b/docs/com/textkernel/tx/models/resume/education/package-frame.html deleted file mode 100644 index 37375751e..000000000 --- a/docs/com/textkernel/tx/models/resume/education/package-frame.html +++ /dev/null @@ -1,25 +0,0 @@ - - - - - - -com.textkernel.tx.models.resume.education (Textkernel Tx Java SDK 2.3.3 API) - - - - - -

com.textkernel.tx.models.resume.education

-
-

Classes

- -
- - diff --git a/docs/com/textkernel/tx/models/resume/education/package-summary.html b/docs/com/textkernel/tx/models/resume/education/package-summary.html deleted file mode 100644 index 38925727f..000000000 --- a/docs/com/textkernel/tx/models/resume/education/package-summary.html +++ /dev/null @@ -1,170 +0,0 @@ - - - - - - -com.textkernel.tx.models.resume.education (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package com.textkernel.tx.models.resume.education

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/education/package-tree.html b/docs/com/textkernel/tx/models/resume/education/package-tree.html deleted file mode 100644 index d3ac59aca..000000000 --- a/docs/com/textkernel/tx/models/resume/education/package-tree.html +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - -com.textkernel.tx.models.resume.education Class Hierarchy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package com.textkernel.tx.models.resume.education

-Package Hierarchies: - -
-
-

Class Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/education/package-use.html b/docs/com/textkernel/tx/models/resume/education/package-use.html deleted file mode 100644 index 05f5d36ba..000000000 --- a/docs/com/textkernel/tx/models/resume/education/package-use.html +++ /dev/null @@ -1,197 +0,0 @@ - - - - - - -Uses of Package com.textkernel.tx.models.resume.education (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Package
com.textkernel.tx.models.resume.education

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/employment/Bullet.html b/docs/com/textkernel/tx/models/resume/employment/Bullet.html deleted file mode 100644 index 4b8638b1e..000000000 --- a/docs/com/textkernel/tx/models/resume/employment/Bullet.html +++ /dev/null @@ -1,299 +0,0 @@ - - - - - - -Bullet (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.resume.employment
-

Class Bullet

-
-
- -
-
    -
  • -
    -
    -
    public class Bullet
-extends Object
    -
    A single entry in a bullet-point list in a position/job description on a resume
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Type

        -
        public String Type
        -
        The type of text/term found for this bullet point. One of: -
          -
        • creativeTerm - Text indicates that an action was taken by the candidate
          • -
        • sentence: the default, no special terms were found in Text
          • -
        -
        • -
      - - - -
        -
      • -

        Text

        -
        public String Text
        -
        The text value of the bullet-list item (excluding the bullet point character)
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        Bullet

        -
        public Bullet()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/employment/CompanyNameWithProbability.html b/docs/com/textkernel/tx/models/resume/employment/CompanyNameWithProbability.html deleted file mode 100644 index 7a69df3c7..000000000 --- a/docs/com/textkernel/tx/models/resume/employment/CompanyNameWithProbability.html +++ /dev/null @@ -1,297 +0,0 @@ - - - - - - -CompanyNameWithProbability (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.resume.employment
-

Class CompanyNameWithProbability

-
-
- -
-
    -
  • -
    -
    -
    public class CompanyNameWithProbability
-extends NormalizedString
    -
    A company name that has been normalized and assigned a probability
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Probability

        -
        public String Probability
        -
        The degree of certainty that the company name is accurate. One of: -
          -
        • VeryUnlikely - recommend discarding
          • -
        • Unlikely - recommend discarding
          • -
        • Probable - recommend review
          • -
        • Confident - no action needed
          • -
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        CompanyNameWithProbability

        -
        public CompanyNameWithProbability()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/employment/Employer.html b/docs/com/textkernel/tx/models/resume/employment/Employer.html deleted file mode 100644 index 0dcbcabc2..000000000 --- a/docs/com/textkernel/tx/models/resume/employment/Employer.html +++ /dev/null @@ -1,313 +0,0 @@ - - - - - - -Employer (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.resume.employment
-

Class Employer

-
-
- -
-
    -
  • -
    -
    -
    public class Employer
-extends Object
    -
    A name/location for a company/employer
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - - - - - -
        -
      • -

        NameVariation

        -
        public NormalizedString NameVariation
        -
        Sometimes a second possible company name is found, or a department/organization - within a company. This is that value, if it is found.
        -
        • -
      - - - -
        -
      • -

        Location

        -
        public Location Location
        -
        The location/address of the employer
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        Employer

        -
        public Employer()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/employment/EmploymentHistory.html b/docs/com/textkernel/tx/models/resume/employment/EmploymentHistory.html deleted file mode 100644 index b3e7d973b..000000000 --- a/docs/com/textkernel/tx/models/resume/employment/EmploymentHistory.html +++ /dev/null @@ -1,295 +0,0 @@ - - - - - - -EmploymentHistory (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.resume.employment
-

Class EmploymentHistory

-
-
- -
-
    -
  • -
    -
    -
    public class EmploymentHistory
-extends Object
    -
    Work history found on a resume
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        ExperienceSummary

        -
        public ExperienceSummary ExperienceSummary
        -
        A summary of all the work history with important calculated metadata
        -
        • -
      - - - -
        -
      • -

        Positions

        -
        public List<Position> Positions
        -
        A list of jobs/positions found on the resume
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        EmploymentHistory

        -
        public EmploymentHistory()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/employment/ExperienceSummary.html b/docs/com/textkernel/tx/models/resume/employment/ExperienceSummary.html deleted file mode 100644 index 9c14ffd56..000000000 --- a/docs/com/textkernel/tx/models/resume/employment/ExperienceSummary.html +++ /dev/null @@ -1,471 +0,0 @@ - - - - - - -ExperienceSummary (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.resume.employment
-

Class ExperienceSummary

-
-
- -
-
    -
  • -
    -
    -
    public class ExperienceSummary
-extends Object
    -
    A summary of a candidate's work history
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Field Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      Fields 
      Modifier and TypeField and Description
      StringAttentionNeeded -
      Any abnormal findings about the candidate's career will be reported here.
      -
      intAverageMonthsPerEmployer -
      The average number of months a candidate has spent at each employer.
      -
      StringCurrentManagementLevel -
      Computed level of management for the current position.
      -
      StringDescription -
      A paragraph of text that summarizes the candidate's experience.
      -
      StringExecutiveType -
      If ManagementScore is at least 30 (mid-level+), then the job titles are examined to - determine the best category for the executive experience.
      -
      intFulltimeDirectHirePredictiveIndex -
      A score (0-100), where 0 means a candidate is more likely to have had (and want/pursue) short-term/part-time/temp/contracting - jobs and 100 means a candidate is more likely to have had (and want/pursue) traditional full-time, direct-hire jobs.
      -
      intManagementScore -
      The highest score calculated from any of the position titles.
      -
      StringManagementStory -
      A paragraph of text that summarizes the candidate's management experience (in English).
      -
      intMonthsOfManagementExperience -
      The number of months of management experience as indicated by the range of - start and end date values in the various jobs/positions in the resume that have been - determined to be management-level positions.
      -
      intMonthsOfWorkExperience -
      The number of months of work experience as indicated by the range of - start and end date values in the various jobs/positions in the resume.
      -
      -
      • -
    - -
      -
    • - - -

      Constructor Summary

      - - - - - - - - -
      Constructors 
      Constructor and Description
      ExperienceSummary() 
      -
      • -
    - - -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Description

        -
        public String Description
        -
        A paragraph of text that summarizes the candidate's experience. This paragraph is generated based on other data - points in the ExperienceSummary. It will be the same language as the resume for Czech, Dutch, - English, French, German, Greek, Hungarian, Italian, Norwegian, Russian, Spanish, and Swedish. To always generate the - summary in English, set "OutputFormat.AllSummariesInEnglish = True;" in the configuration string when parsing. -

        In order for this value to be accurate, you must have provided an accurate RevisionDate when you parsed this resume.

        -
        • -
      - - - -
        -
      • -

        MonthsOfWorkExperience

        -
        public int MonthsOfWorkExperience
        -
        The number of months of work experience as indicated by the range of - start and end date values in the various jobs/positions in the resume. - Overlapping date ranges are not double-counted. This value is NOT derived from text like "I have 15 years of experience". -

        In order for this value to be accurate, you must have provided an accurate RevisionDate when you parsed this resume.

        -
        • -
      - - - -
        -
      • -

        MonthsOfManagementExperience

        -
        public int MonthsOfManagementExperience
        -
        The number of months of management experience as indicated by the range of - start and end date values in the various jobs/positions in the resume that have been - determined to be management-level positions. Overlapping date ranges are not double-counted. - This value is NOT derived from text like "I have 10 years of management experience". -

        In order for this value to be accurate, you must have provided an accurate RevisionDate when you parsed this resume.

        -
        • -
      - - - -
        -
      • -

        ExecutiveType

        -
        public String ExecutiveType
        -
        If ManagementScore is at least 30 (mid-level+), then the job titles are examined to - determine the best category for the executive experience. One of: -
          -
        • NONE
          • -
        • ADMIN
          • -
        • ACCOUNTING
          • -
        • BUSINESS_DEV
          • -
        • EXECUTIVE
          • -
        • FINANCIAL
          • -
        • GENERAL
          • -
        • IT
          • -
        • LEARNING
          • -
        • MARKETING
          • -
        • OPERATIONS
          • -
        -
        • -
      - - - -
        -
      • -

        AverageMonthsPerEmployer

        -
        public int AverageMonthsPerEmployer
        -
        The average number of months a candidate has spent at each employer. Note that this number is per employer, not per job. -

        In order for this value to be accurate, you must have provided an accurate RevisionDate when you parsed this resume.

        -
        • -
      - - - -
        -
      • -

        FulltimeDirectHirePredictiveIndex

        -
        public int FulltimeDirectHirePredictiveIndex
        -
        A score (0-100), where 0 means a candidate is more likely to have had (and want/pursue) short-term/part-time/temp/contracting - jobs and 100 means a candidate is more likely to have had (and want/pursue) traditional full-time, direct-hire jobs. -

        In order for this value to be accurate, you must have provided an accurate RevisionDate when you parsed this resume.

        -
        • -
      - - - -
        -
      • -

        ManagementStory

        -
        public String ManagementStory
        -
        A paragraph of text that summarizes the candidate's management experience (in English).
        -
        • -
      - - - -
        -
      • -

        CurrentManagementLevel

        -
        public String CurrentManagementLevel
        -
        Computed level of management for the current position. One of: -
          -
        • low-or-no-level
          • -
        • low-level
          • -
        • mid-level
          • -
        • somewhat high-level
          • -
        • high-level
          • -
        • executive-level
          • -
        -
        • -
      - - - -
        -
      • -

        ManagementScore

        -
        public int ManagementScore
        -
        The highest score calculated from any of the position titles. The score is based on the - wording of the title, not on the experience described within the position description. -
          -
        • 0-29 = Low level
          • -
        • 30-59 = Mid level
          • -
        • 60+ = High level
          • -
        -
        • -
      - - - -
        -
      • -

        AttentionNeeded

        -
        public String AttentionNeeded
        -
        Any abnormal findings about the candidate's career will be reported here. For example, if the candidate - held a management-level position in a previous job, but not their current job.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ExperienceSummary

        -
        public ExperienceSummary()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/employment/JobTitle.html b/docs/com/textkernel/tx/models/resume/employment/JobTitle.html deleted file mode 100644 index d810cc8d7..000000000 --- a/docs/com/textkernel/tx/models/resume/employment/JobTitle.html +++ /dev/null @@ -1,341 +0,0 @@ - - - - - - -JobTitle (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.resume.employment
-

Class JobTitle

-
-
- -
-
    -
  • -
    -
    -
    public class JobTitle
-extends Object
    -
    A job title found in a resume
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Raw

        -
        public String Raw
        -
        The raw text as it was found in the resume
        -
        • -
      - - - - - - - -
        -
      • -

        Probability

        -
        public String Probability
        -
        The degree of certainty that the job title value is accurate. One of: -
          -
        • VeryUnlikely - recommend discarding
          • -
        • Unlikely - recommend discarding
          • -
        • Probable - recommend review
          • -
        • Confident - no action needed
          • -
        -
        • -
      - - - - -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        JobTitle

        -
        public JobTitle()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/employment/ParsingNormalizedProfession.html b/docs/com/textkernel/tx/models/resume/employment/ParsingNormalizedProfession.html deleted file mode 100644 index 0033a1551..000000000 --- a/docs/com/textkernel/tx/models/resume/employment/ParsingNormalizedProfession.html +++ /dev/null @@ -1,359 +0,0 @@ - - - - - - -ParsingNormalizedProfession (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.resume.employment
-

Class ParsingNormalizedProfession

-
-
- -
-
    -
  • -
    -
    -
    public class ParsingNormalizedProfession
-extends Object
    -
    Normalized profession related to a specific job title.
    -
    • -
-
-
- -
-
- -
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/employment/Position.html b/docs/com/textkernel/tx/models/resume/employment/Position.html deleted file mode 100644 index c4da729e4..000000000 --- a/docs/com/textkernel/tx/models/resume/employment/Position.html +++ /dev/null @@ -1,580 +0,0 @@ - - - - - - -Position (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.resume.employment
-

Class Position

-
-
- -
-
    -
  • -
    -
    -
    public class Position
-extends Object
    -
    A position/job on a resume
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Id

        -
        public String Id
        -
        The id of this position (one-based, so POS-1 is the first, etc)
        -
        • -
      - - - -
        -
      • -

        Employer

        -
        public Employer Employer
        -
        The employer/company for this position. Will be null if IsSelfEmployed is true
        -
        • -
      - - - -
        -
      • -

        RelatedToByDates

        -
        public List<String> RelatedToByDates
        -
        A list of Ids that have overlapping dates with this Position
        -
        • -
      - - - - - - - -
        -
      • -

        IsSelfEmployed

        -
        public boolean IsSelfEmployed
        -
        true if the candidate was self-employed at this job/position
        -
        • -
      - - - -
        -
      • -

        IsCurrent

        -
        public boolean IsCurrent
        -
        true if the job/position is listed as current on the resume
        -
        • -
      - - - -
        -
      • -

        JobTitle

        -
        public JobTitle JobTitle
        -
        The job title for this position/job
        -
        • -
      - - - -
        -
      • -

        StartDate

        -
        public TxDate StartDate
        -
        The start date listed for this position
        -
        • -
      - - - -
        -
      • -

        EndDate

        -
        public TxDate EndDate
        -
        The end date listed for this position
        -
        • -
      - - - -
        -
      • -

        NumberEmployeesSupervised

        -
        public TxPrimitive<Integer> NumberEmployeesSupervised
        -
        How many employees were supervised in this position/job
        -
        • -
      - - - -
        -
      • -

        JobType

        -
        public String JobType
        -
        The type of job. One of: -
          -
        • directHire
          • -
        • contract
          • -
        • temp
          • -
        • volunteer
          • -
        • internship
          • -
        • UNSPECIFIED
          • -
        -
        • -
      - - - -
        -
      • -

        TaxonomyName

        -
        @Deprecated
-public String TaxonomyName
        -
        Deprecated. use NormalizedProfession instead
        -
        The name of the skills taxonomy that this position was categorized as based on skills found in the job description.
        -
        • -
      - - - -
        -
      • -

        SubTaxonomyName

        -
        @Deprecated
-public String SubTaxonomyName
        -
        Deprecated. use NormalizedProfession instead
        -
        The name of the skills subtaxonomy that this position was categorized as based on skills found in the job description.
        -
        • -
      - - - -
        -
      • -

        JobLevel

        -
        public String JobLevel
        -
        The level determined by length of experience and job titles. One of: -
          -
        • Entry Level
          • -
        • Experienced(non-manager)
          • -
        • Senior(more than 5 years experience)
          • -
        • Manager
          • -
        • Senior Manager(more than 5 years management experience)
          • -
        • Executive(VP, Dept.Head)
          • -
        • Senior Executive(President, C-level)
          • -
        -
        • -
      - - - - - - - -
        -
      • -

        Description

        -
        public String Description
        -
        The job description
        -
        • -
      - - - -
        -
      • -

        Bullets

        -
        public List<Bullet> Bullets
        -
        Bullet points found in the Description (available when OutputFormat.CreateBullets = true is set in the Configuration string on the request)
        -
        • -
      - - - - -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        Position

        -
        public Position()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/employment/ProfessionClassification.html b/docs/com/textkernel/tx/models/resume/employment/ProfessionClassification.html deleted file mode 100644 index 66a7eaf0c..000000000 --- a/docs/com/textkernel/tx/models/resume/employment/ProfessionClassification.html +++ /dev/null @@ -1,299 +0,0 @@ - - - - - - -ProfessionClassification (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.resume.employment
-

Class ProfessionClassification<T>

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        CodeId

        -
        public T CodeId
        -
        The code id of the profession concept.
        -
        • -
      - - - -
        -
      • -

        Description

        -
        public String Description
        -
        The description of the profession concept.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ProfessionClassification

        -
        public ProfessionClassification()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/employment/VersionedNormalizedProfessionClassification.html b/docs/com/textkernel/tx/models/resume/employment/VersionedNormalizedProfessionClassification.html deleted file mode 100644 index 4b4050bcb..000000000 --- a/docs/com/textkernel/tx/models/resume/employment/VersionedNormalizedProfessionClassification.html +++ /dev/null @@ -1,291 +0,0 @@ - - - - - - -VersionedNormalizedProfessionClassification (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.resume.employment
-

Class VersionedNormalizedProfessionClassification<T>

-
-
- -
-
    -
  • -
    -
    -
    public class VersionedNormalizedProfessionClassification<T>
-extends ProfessionClassification<T>
    -
    Object representing a profession concept with taxonomy version
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Version

        -
        public String Version
        -
        The version of the profession taxonomy
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        VersionedNormalizedProfessionClassification

        -
        public VersionedNormalizedProfessionClassification()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/employment/class-use/Bullet.html b/docs/com/textkernel/tx/models/resume/employment/class-use/Bullet.html deleted file mode 100644 index b918cc195..000000000 --- a/docs/com/textkernel/tx/models/resume/employment/class-use/Bullet.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.resume.employment.Bullet (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.resume.employment.Bullet

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/employment/class-use/CompanyNameWithProbability.html b/docs/com/textkernel/tx/models/resume/employment/class-use/CompanyNameWithProbability.html deleted file mode 100644 index b08c28b01..000000000 --- a/docs/com/textkernel/tx/models/resume/employment/class-use/CompanyNameWithProbability.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.resume.employment.CompanyNameWithProbability (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.resume.employment.CompanyNameWithProbability

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/employment/class-use/Employer.html b/docs/com/textkernel/tx/models/resume/employment/class-use/Employer.html deleted file mode 100644 index fd221f220..000000000 --- a/docs/com/textkernel/tx/models/resume/employment/class-use/Employer.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.resume.employment.Employer (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.resume.employment.Employer

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/employment/class-use/EmploymentHistory.html b/docs/com/textkernel/tx/models/resume/employment/class-use/EmploymentHistory.html deleted file mode 100644 index 09fe80e78..000000000 --- a/docs/com/textkernel/tx/models/resume/employment/class-use/EmploymentHistory.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.resume.employment.EmploymentHistory (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.resume.employment.EmploymentHistory

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/employment/class-use/ExperienceSummary.html b/docs/com/textkernel/tx/models/resume/employment/class-use/ExperienceSummary.html deleted file mode 100644 index 0a572d0a3..000000000 --- a/docs/com/textkernel/tx/models/resume/employment/class-use/ExperienceSummary.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.resume.employment.ExperienceSummary (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.resume.employment.ExperienceSummary

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/employment/class-use/JobTitle.html b/docs/com/textkernel/tx/models/resume/employment/class-use/JobTitle.html deleted file mode 100644 index 7360541de..000000000 --- a/docs/com/textkernel/tx/models/resume/employment/class-use/JobTitle.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.resume.employment.JobTitle (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.resume.employment.JobTitle

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/employment/class-use/ParsingNormalizedProfession.html b/docs/com/textkernel/tx/models/resume/employment/class-use/ParsingNormalizedProfession.html deleted file mode 100644 index 3256ddf5c..000000000 --- a/docs/com/textkernel/tx/models/resume/employment/class-use/ParsingNormalizedProfession.html +++ /dev/null @@ -1,192 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.resume.employment.ParsingNormalizedProfession (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.resume.employment.ParsingNormalizedProfession

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/employment/class-use/Position.html b/docs/com/textkernel/tx/models/resume/employment/class-use/Position.html deleted file mode 100644 index 4b3188288..000000000 --- a/docs/com/textkernel/tx/models/resume/employment/class-use/Position.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.resume.employment.Position (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.resume.employment.Position

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/employment/class-use/ProfessionClassification.html b/docs/com/textkernel/tx/models/resume/employment/class-use/ProfessionClassification.html deleted file mode 100644 index 8f9e8f932..000000000 --- a/docs/com/textkernel/tx/models/resume/employment/class-use/ProfessionClassification.html +++ /dev/null @@ -1,195 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.resume.employment.ProfessionClassification (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.resume.employment.ProfessionClassification

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/employment/class-use/VersionedNormalizedProfessionClassification.html b/docs/com/textkernel/tx/models/resume/employment/class-use/VersionedNormalizedProfessionClassification.html deleted file mode 100644 index 4597c17cd..000000000 --- a/docs/com/textkernel/tx/models/resume/employment/class-use/VersionedNormalizedProfessionClassification.html +++ /dev/null @@ -1,174 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.resume.employment.VersionedNormalizedProfessionClassification (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.resume.employment.VersionedNormalizedProfessionClassification

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/employment/package-frame.html b/docs/com/textkernel/tx/models/resume/employment/package-frame.html deleted file mode 100644 index 7f178025b..000000000 --- a/docs/com/textkernel/tx/models/resume/employment/package-frame.html +++ /dev/null @@ -1,30 +0,0 @@ - - - - - - -com.textkernel.tx.models.resume.employment (Textkernel Tx Java SDK 2.3.3 API) - - - - - -

com.textkernel.tx.models.resume.employment

-
-

Classes

- -
- - diff --git a/docs/com/textkernel/tx/models/resume/employment/package-summary.html b/docs/com/textkernel/tx/models/resume/employment/package-summary.html deleted file mode 100644 index d90bef264..000000000 --- a/docs/com/textkernel/tx/models/resume/employment/package-summary.html +++ /dev/null @@ -1,200 +0,0 @@ - - - - - - -com.textkernel.tx.models.resume.employment (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package com.textkernel.tx.models.resume.employment

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/employment/package-tree.html b/docs/com/textkernel/tx/models/resume/employment/package-tree.html deleted file mode 100644 index 2990a8ca8..000000000 --- a/docs/com/textkernel/tx/models/resume/employment/package-tree.html +++ /dev/null @@ -1,155 +0,0 @@ - - - - - - -com.textkernel.tx.models.resume.employment Class Hierarchy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package com.textkernel.tx.models.resume.employment

-Package Hierarchies: - -
-
-

Class Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/employment/package-use.html b/docs/com/textkernel/tx/models/resume/employment/package-use.html deleted file mode 100644 index 1dc1eaed7..000000000 --- a/docs/com/textkernel/tx/models/resume/employment/package-use.html +++ /dev/null @@ -1,243 +0,0 @@ - - - - - - -Uses of Package com.textkernel.tx.models.resume.employment (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Package
com.textkernel.tx.models.resume.employment

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/metadata/ReservedData.html b/docs/com/textkernel/tx/models/resume/metadata/ReservedData.html deleted file mode 100644 index f98efe775..000000000 --- a/docs/com/textkernel/tx/models/resume/metadata/ReservedData.html +++ /dev/null @@ -1,343 +0,0 @@ - - - - - - -ReservedData (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.resume.metadata
-

Class ReservedData

-
-
- -
-
    -
  • -
    -
    -
    public class ReservedData
-extends Object
    -
    Used to redact PII
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Phones

        -
        public List<String> Phones
        -
        All phone numbers found in the resume
        -
        • -
      - - - -
        -
      • -

        Names

        -
        public List<String> Names
        -
        All names found in the resume
        -
        • -
      - - - -
        -
      • -

        EmailAddresses

        -
        public List<String> EmailAddresses
        -
        All email addresses found in the resume
        -
        • -
      - - - -
        -
      • -

        Urls

        -
        public List<String> Urls
        -
        All personal urls found in the resume
        -
        • -
      - - - -
        -
      • -

        OtherData

        -
        public List<String> OtherData
        -
        Any other PII that should be redacted
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ReservedData

        -
        public ReservedData()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/metadata/ResumeMetadata.html b/docs/com/textkernel/tx/models/resume/metadata/ResumeMetadata.html deleted file mode 100644 index b6d536ba2..000000000 --- a/docs/com/textkernel/tx/models/resume/metadata/ResumeMetadata.html +++ /dev/null @@ -1,336 +0,0 @@ - - - - - - -ResumeMetadata (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.resume.metadata
-

Class ResumeMetadata

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        FoundSections

        -
        public List<ResumeSection> FoundSections
        -
        A list of sections found in the resume
        -
        • -
      - - - -
        -
      • -

        ResumeQuality

        -
        public List<ResumeQualityAssessment> ResumeQuality
        -
        This is an advanced level feature. Please ignore the data in the Resume Quality output unless/until you have discussed its proper use with Textkernel, and been approved to use it.

        - The Resume Quality section output should NEVER IN ANY SENSE WHATSOEVER be used as an indication that the Parser has failed or performed poorly. - The sole purpose of the Resume Quality section is to help you, the integrator, to understand substandard aspects of the candidate's resume. - The majority of resumes will have at least one entry in this section. AGAIN, that does not mean that parsing "failed" or that the Parser needs fixing.

        - Please recall that candidates' resumes fall within a bell curve. Some resumes are really well done. Some are horrible. Most fall into the Good to Pretty Good range. - The Resume Quality section is designed to help you understand where the resume falls in that bell curve. Great resumes will parse great. Horrible resumes will parse poorly. - That is a limitation of the quality of the resume. The Parser cannot fix candidate mistakes.

        - For instance, the Resume Quality section may report that the candidate provided neither a phone nor an email address. Reporting that fact does not indicate that the Parser failed. - The failure was that the candidate did not include a way to be contacted electronically. We cannot fix that, nor can you, the integrator. Only the candidate can.

        - You should not use the Resume Quality section to communicate problems/suggestions to candidates unless you have a very sophisticated workflow and step-by-step improvement process. - Otherwise, you will frustrate candidates and do more harm than good.

        - The Resume Quality is a series of assessments of how well the resume conforms to best practices for constructing machine-readable resumes. Assessments are ordered by severity, - from fatal problems (which nevertheless may not have caused an actual parsing problem), to suggested improvements. Each assessment contains a list of findings, - describing the exact issue with the resume and a recommendation for how the candidate could resolve the issue.
        -
        • -
      - - - - -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ResumeMetadata

        -
        public ResumeMetadata()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/metadata/ResumeQualityAssessment.html b/docs/com/textkernel/tx/models/resume/metadata/ResumeQualityAssessment.html deleted file mode 100644 index 4230462f3..000000000 --- a/docs/com/textkernel/tx/models/resume/metadata/ResumeQualityAssessment.html +++ /dev/null @@ -1,299 +0,0 @@ - - - - - - -ResumeQualityAssessment (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.resume.metadata
-

Class ResumeQualityAssessment

-
-
- -
-
    -
  • -
    -
    -
    public class ResumeQualityAssessment
-extends Object
    -
    A list of ResumeQualityFinding of the same level/severity
    -
    • -
-
-
- -
-
- -
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/metadata/ResumeQualityFinding.html b/docs/com/textkernel/tx/models/resume/metadata/ResumeQualityFinding.html deleted file mode 100644 index 53587ba7b..000000000 --- a/docs/com/textkernel/tx/models/resume/metadata/ResumeQualityFinding.html +++ /dev/null @@ -1,312 +0,0 @@ - - - - - - -ResumeQualityFinding (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.resume.metadata
-

Class ResumeQualityFinding

-
-
- -
-
    -
  • -
    -
    -
    public class ResumeQualityFinding
-extends Object
    -
    A single resume quality issue
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        QualityCode

        -
        public String QualityCode
        -
        A unique 3-digit code to identify what type of issue was found. - See all possibilities at our docs site here.
        -
        • -
      - - - -
        -
      • -

        SectionIdentifiers

        -
        public List<SectionIdentifier> SectionIdentifiers
        -
        If applicable, areas in the resume where this issue was found or that are affected by this issue.
        -
        • -
      - - - -
        -
      • -

        Message

        -
        public String Message
        -
        A human-readable message explaining the issue that is being reported and possibly how to fix.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ResumeQualityFinding

        -
        public ResumeQualityFinding()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/metadata/ResumeQualityLevel.html b/docs/com/textkernel/tx/models/resume/metadata/ResumeQualityLevel.html deleted file mode 100644 index 58a6378c0..000000000 --- a/docs/com/textkernel/tx/models/resume/metadata/ResumeQualityLevel.html +++ /dev/null @@ -1,309 +0,0 @@ - - - - - - -ResumeQualityLevel (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.resume.metadata
-

Class ResumeQualityLevel

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        SuggestedImprovement

        -
        public static ResumeQualityLevel SuggestedImprovement
        -
        Only minor issues were found
        -
        • -
      - - - -
        -
      • -

        DataMissing

        -
        public static ResumeQualityLevel DataMissing
        -
        Some data was missing that should be included in a resume
        -
        • -
      - - - -
        -
      • -

        MajorIssue

        -
        public static ResumeQualityLevel MajorIssue
        -
        A major issue was found in the resume that will reduce the quality of parse results
        -
        • -
      - - - -
        -
      • -

        FatalProblem

        -
        public static ResumeQualityLevel FatalProblem
        -
        A fatal issue was found in the resume. Parse results may have severe inaccuracies
        -
        • -
      - - - -
        -
      • -

        Value

        -
        public String Value
        -
        The string value for this level/severity
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/metadata/ResumeSection.html b/docs/com/textkernel/tx/models/resume/metadata/ResumeSection.html deleted file mode 100644 index 4de997893..000000000 --- a/docs/com/textkernel/tx/models/resume/metadata/ResumeSection.html +++ /dev/null @@ -1,356 +0,0 @@ - - - - - - -ResumeSection (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.resume.metadata
-

Class ResumeSection

-
-
- -
-
    -
  • -
    -
    -
    public class ResumeSection
-extends Object
    -
    A section in the resume (work history, education, etc)
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        FirstLineNumber

        -
        public int FirstLineNumber
        -
        The first line of the section (zero-based). This refers to the lines (delimited by newline) in the ParsedDocumentMetadata.PlainText
        -
        • -
      - - - -
        -
      • -

        LastLineNumber

        -
        public int LastLineNumber
        -
        The last line of the section (zero-based). This refers to the lines (delimited by newline) in the ParsedDocumentMetadata.PlainText
        -
        • -
      - - - -
        -
      • -

        SectionType

        -
        public String SectionType
        -
        The type of section. One of: -
          -
        • ARTICLES
          • -
        • AVAILABILITY
          • -
        • BOOKS
          • -
        • CERTIFICATIONS
          • -
        • CONFERENCE_PAPERS
          • -
        • CONTACT_INFO
          • -
        • EDUCATION
          • -
        • HOBBIES
          • -
        • IGNORE_DATA_AFTER
          • -
        • LANGUAGES
          • -
        • LICENSES
          • -
        • MILITARY
          • -
        • OBJECTIVE
          • -
        • OTHER_PUBLICATIONS
          • -
        • PATENTS
          • -
        • PERSONAL_INTERESTS_AND_ACCOMPLISHMENTS
          • -
        • PROFESSIONAL_AFFILIATIONS
          • -
        • QUALIFICATIONS_SUMMARY
          • -
        • REFERENCES
          • -
        • SECURITY_CLEARANCES
          • -
        • SKILLS
          • -
        • SPEAKING
          • -
        • SUMMARY
          • -
        • TRAINING
          • -
        • WORK_HISTORY
          • -
        • WORK_STATUS
          • -
        -
        • -
      - - - -
        -
      • -

        HeaderTextFound

        -
        public String HeaderTextFound
        -
        The exact text that was used to identify the beginning of the section. - If there was no text indicator and the location was calculated, then the value is "CALCULATED"
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ResumeSection

        -
        public ResumeSection()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/metadata/class-use/ReservedData.html b/docs/com/textkernel/tx/models/resume/metadata/class-use/ReservedData.html deleted file mode 100644 index cdff584ab..000000000 --- a/docs/com/textkernel/tx/models/resume/metadata/class-use/ReservedData.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.resume.metadata.ReservedData (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.resume.metadata.ReservedData

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/metadata/class-use/ResumeMetadata.html b/docs/com/textkernel/tx/models/resume/metadata/class-use/ResumeMetadata.html deleted file mode 100644 index 6b1402e1f..000000000 --- a/docs/com/textkernel/tx/models/resume/metadata/class-use/ResumeMetadata.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.resume.metadata.ResumeMetadata (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.resume.metadata.ResumeMetadata

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/metadata/class-use/ResumeQualityAssessment.html b/docs/com/textkernel/tx/models/resume/metadata/class-use/ResumeQualityAssessment.html deleted file mode 100644 index 6e6814fed..000000000 --- a/docs/com/textkernel/tx/models/resume/metadata/class-use/ResumeQualityAssessment.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.resume.metadata.ResumeQualityAssessment (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.resume.metadata.ResumeQualityAssessment

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/metadata/class-use/ResumeQualityFinding.html b/docs/com/textkernel/tx/models/resume/metadata/class-use/ResumeQualityFinding.html deleted file mode 100644 index e8bfc5243..000000000 --- a/docs/com/textkernel/tx/models/resume/metadata/class-use/ResumeQualityFinding.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.resume.metadata.ResumeQualityFinding (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.resume.metadata.ResumeQualityFinding

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/metadata/class-use/ResumeQualityLevel.html b/docs/com/textkernel/tx/models/resume/metadata/class-use/ResumeQualityLevel.html deleted file mode 100644 index 115f55248..000000000 --- a/docs/com/textkernel/tx/models/resume/metadata/class-use/ResumeQualityLevel.html +++ /dev/null @@ -1,186 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.resume.metadata.ResumeQualityLevel (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.resume.metadata.ResumeQualityLevel

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/metadata/class-use/ResumeSection.html b/docs/com/textkernel/tx/models/resume/metadata/class-use/ResumeSection.html deleted file mode 100644 index ce9d39e74..000000000 --- a/docs/com/textkernel/tx/models/resume/metadata/class-use/ResumeSection.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.resume.metadata.ResumeSection (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.resume.metadata.ResumeSection

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/metadata/package-frame.html b/docs/com/textkernel/tx/models/resume/metadata/package-frame.html deleted file mode 100644 index 4c514be7a..000000000 --- a/docs/com/textkernel/tx/models/resume/metadata/package-frame.html +++ /dev/null @@ -1,26 +0,0 @@ - - - - - - -com.textkernel.tx.models.resume.metadata (Textkernel Tx Java SDK 2.3.3 API) - - - - - -

com.textkernel.tx.models.resume.metadata

-
-

Classes

- -
- - diff --git a/docs/com/textkernel/tx/models/resume/metadata/package-summary.html b/docs/com/textkernel/tx/models/resume/metadata/package-summary.html deleted file mode 100644 index edacaf5f7..000000000 --- a/docs/com/textkernel/tx/models/resume/metadata/package-summary.html +++ /dev/null @@ -1,176 +0,0 @@ - - - - - - -com.textkernel.tx.models.resume.metadata (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package com.textkernel.tx.models.resume.metadata

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/metadata/package-tree.html b/docs/com/textkernel/tx/models/resume/metadata/package-tree.html deleted file mode 100644 index 25c71ec89..000000000 --- a/docs/com/textkernel/tx/models/resume/metadata/package-tree.html +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - -com.textkernel.tx.models.resume.metadata Class Hierarchy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package com.textkernel.tx.models.resume.metadata

-Package Hierarchies: - -
-
-

Class Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/metadata/package-use.html b/docs/com/textkernel/tx/models/resume/metadata/package-use.html deleted file mode 100644 index 34dbfda1f..000000000 --- a/docs/com/textkernel/tx/models/resume/metadata/package-use.html +++ /dev/null @@ -1,202 +0,0 @@ - - - - - - -Uses of Package com.textkernel.tx.models.resume.metadata (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Package
com.textkernel.tx.models.resume.metadata

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/military/MilitaryDetails.html b/docs/com/textkernel/tx/models/resume/military/MilitaryDetails.html deleted file mode 100644 index 5a2c0bea3..000000000 --- a/docs/com/textkernel/tx/models/resume/military/MilitaryDetails.html +++ /dev/null @@ -1,343 +0,0 @@ - - - - - - -MilitaryDetails (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.resume.military
-

Class MilitaryDetails

-
-
- -
-
    -
  • -
    -
    -
    public class MilitaryDetails
-extends Object
    -
    Information about military post/job listed on a resume
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Country

        -
        public String Country
        -
        The country that the military belongs to
        -
        • -
      - - - -
        -
      • -

        Service

        -
        public MilitaryService Service
        -
        The branch/name/rank for this post/job
        -
        • -
      - - - -
        -
      • -

        StartDate

        -
        public TxDate StartDate
        -
        The start date for this post/job
        -
        • -
      - - - -
        -
      • -

        EndDate

        -
        public TxDate EndDate
        -
        The end date for this post/job
        -
        • -
      - - - -
        -
      • -

        FoundInContext

        -
        public String FoundInContext
        -
        The full text where this military post/job was found in the resume
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        MilitaryDetails

        -
        public MilitaryDetails()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/military/MilitaryService.html b/docs/com/textkernel/tx/models/resume/military/MilitaryService.html deleted file mode 100644 index 90967a18d..000000000 --- a/docs/com/textkernel/tx/models/resume/military/MilitaryService.html +++ /dev/null @@ -1,311 +0,0 @@ - - - - - - -MilitaryService (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.resume.military
-

Class MilitaryService

-
-
- -
-
    -
  • -
    -
    -
    public class MilitaryService
-extends Object
    -
    A branch/name/rank for a military post/job
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Name

        -
        public String Name
        -
        The name of the post/job
        -
        • -
      - - - -
        -
      • -

        Branch

        -
        public String Branch
        -
        The branch of the military
        -
        • -
      - - - -
        -
      • -

        Rank

        -
        public String Rank
        -
        The military rank of the candidate
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        MilitaryService

        -
        public MilitaryService()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/military/SecurityCredential.html b/docs/com/textkernel/tx/models/resume/military/SecurityCredential.html deleted file mode 100644 index bc5bb9960..000000000 --- a/docs/com/textkernel/tx/models/resume/military/SecurityCredential.html +++ /dev/null @@ -1,295 +0,0 @@ - - - - - - -SecurityCredential (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.resume.military
-

Class SecurityCredential

-
-
- -
-
    -
  • -
    -
    -
    public class SecurityCredential
-extends Object
    -
    A security credential/clearance found on a resume
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Name

        -
        public String Name
        -
        The name of the credential/clearance
        -
        • -
      - - - -
        -
      • -

        FoundInContext

        -
        public String FoundInContext
        -
        The full context of where this clearance/credential was found
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        SecurityCredential

        -
        public SecurityCredential()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/military/class-use/MilitaryDetails.html b/docs/com/textkernel/tx/models/resume/military/class-use/MilitaryDetails.html deleted file mode 100644 index 6fefe94c3..000000000 --- a/docs/com/textkernel/tx/models/resume/military/class-use/MilitaryDetails.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.resume.military.MilitaryDetails (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.resume.military.MilitaryDetails

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/military/class-use/MilitaryService.html b/docs/com/textkernel/tx/models/resume/military/class-use/MilitaryService.html deleted file mode 100644 index 97cfa6237..000000000 --- a/docs/com/textkernel/tx/models/resume/military/class-use/MilitaryService.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.resume.military.MilitaryService (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.resume.military.MilitaryService

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/military/class-use/SecurityCredential.html b/docs/com/textkernel/tx/models/resume/military/class-use/SecurityCredential.html deleted file mode 100644 index 29bb7e020..000000000 --- a/docs/com/textkernel/tx/models/resume/military/class-use/SecurityCredential.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.resume.military.SecurityCredential (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.resume.military.SecurityCredential

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/military/package-frame.html b/docs/com/textkernel/tx/models/resume/military/package-frame.html deleted file mode 100644 index 4c37bc57f..000000000 --- a/docs/com/textkernel/tx/models/resume/military/package-frame.html +++ /dev/null @@ -1,23 +0,0 @@ - - - - - - -com.textkernel.tx.models.resume.military (Textkernel Tx Java SDK 2.3.3 API) - - - - - -

com.textkernel.tx.models.resume.military

-
-

Classes

- -
- - diff --git a/docs/com/textkernel/tx/models/resume/military/package-summary.html b/docs/com/textkernel/tx/models/resume/military/package-summary.html deleted file mode 100644 index f082852a1..000000000 --- a/docs/com/textkernel/tx/models/resume/military/package-summary.html +++ /dev/null @@ -1,158 +0,0 @@ - - - - - - -com.textkernel.tx.models.resume.military (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package com.textkernel.tx.models.resume.military

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/military/package-tree.html b/docs/com/textkernel/tx/models/resume/military/package-tree.html deleted file mode 100644 index d60d2fa3e..000000000 --- a/docs/com/textkernel/tx/models/resume/military/package-tree.html +++ /dev/null @@ -1,141 +0,0 @@ - - - - - - -com.textkernel.tx.models.resume.military Class Hierarchy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package com.textkernel.tx.models.resume.military

-Package Hierarchies: - -
-
-

Class Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/military/package-use.html b/docs/com/textkernel/tx/models/resume/military/package-use.html deleted file mode 100644 index 5f37313c1..000000000 --- a/docs/com/textkernel/tx/models/resume/military/package-use.html +++ /dev/null @@ -1,187 +0,0 @@ - - - - - - -Uses of Package com.textkernel.tx.models.resume.military (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Package
com.textkernel.tx.models.resume.military

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/package-frame.html b/docs/com/textkernel/tx/models/resume/package-frame.html deleted file mode 100644 index 539fcf071..000000000 --- a/docs/com/textkernel/tx/models/resume/package-frame.html +++ /dev/null @@ -1,33 +0,0 @@ - - - - - - -com.textkernel.tx.models.resume (Textkernel Tx Java SDK 2.3.3 API) - - - - - -

com.textkernel.tx.models.resume

-
-

Classes

- -
- - diff --git a/docs/com/textkernel/tx/models/resume/package-summary.html b/docs/com/textkernel/tx/models/resume/package-summary.html deleted file mode 100644 index 36b97e020..000000000 --- a/docs/com/textkernel/tx/models/resume/package-summary.html +++ /dev/null @@ -1,218 +0,0 @@ - - - - - - -com.textkernel.tx.models.resume (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package com.textkernel.tx.models.resume

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/package-tree.html b/docs/com/textkernel/tx/models/resume/package-tree.html deleted file mode 100644 index 650f4d08e..000000000 --- a/docs/com/textkernel/tx/models/resume/package-tree.html +++ /dev/null @@ -1,155 +0,0 @@ - - - - - - -com.textkernel.tx.models.resume Class Hierarchy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package com.textkernel.tx.models.resume

-Package Hierarchies: - -
-
-

Class Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/package-use.html b/docs/com/textkernel/tx/models/resume/package-use.html deleted file mode 100644 index 5e98e9efc..000000000 --- a/docs/com/textkernel/tx/models/resume/package-use.html +++ /dev/null @@ -1,468 +0,0 @@ - - - - - - -Uses of Package com.textkernel.tx.models.resume (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Package
com.textkernel.tx.models.resume

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/skills/ResumeNormalizedSkill.html b/docs/com/textkernel/tx/models/resume/skills/ResumeNormalizedSkill.html deleted file mode 100644 index 4b6bcb0df..000000000 --- a/docs/com/textkernel/tx/models/resume/skills/ResumeNormalizedSkill.html +++ /dev/null @@ -1,323 +0,0 @@ - - - - - - -ResumeNormalizedSkill (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.resume.skills
-

Class ResumeNormalizedSkill

-
-
- -
-
    -
  • -
    -
    -
    public class ResumeNormalizedSkill
-extends NormalizedSkill
    -
    Normalized skill concept representing one or more raw skills that were extracted.
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        MonthsExperience

        -
        public TxPrimitive<Integer> MonthsExperience
        -
        Describes the amount of experience a candidate has with this skill
        -
        • -
      - - - -
        -
      • -

        LastUsed

        -
        public TxPrimitive<java.time.LocalDate> LastUsed
        -
        Describes the date the candidate last used the skill (derived from position dates)
        -
        • -
      - - - - -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ResumeNormalizedSkill

        -
        public ResumeNormalizedSkill()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/skills/ResumeRawSkill.html b/docs/com/textkernel/tx/models/resume/skills/ResumeRawSkill.html deleted file mode 100644 index 82eb2ae08..000000000 --- a/docs/com/textkernel/tx/models/resume/skills/ResumeRawSkill.html +++ /dev/null @@ -1,323 +0,0 @@ - - - - - - -ResumeRawSkill (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.resume.skills
-

Class ResumeRawSkill

-
-
- -
-
    -
  • -
    -
    -
    public class ResumeRawSkill
-extends RawSkill
    -
    Skill exactly as it was found in the plain text of the document.
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        MonthsExperience

        -
        public TxPrimitive<Integer> MonthsExperience
        -
        Describes the amount of experience a candidate has with this skill
        -
        • -
      - - - -
        -
      • -

        LastUsed

        -
        public TxPrimitive<java.time.LocalDate> LastUsed
        -
        Describes the date the candidate last used the skill (derived from position dates)
        -
        • -
      - - - - -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ResumeRawSkill

        -
        public ResumeRawSkill()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/skills/ResumeSkill.html b/docs/com/textkernel/tx/models/resume/skills/ResumeSkill.html deleted file mode 100644 index 1e32716a6..000000000 --- a/docs/com/textkernel/tx/models/resume/skills/ResumeSkill.html +++ /dev/null @@ -1,335 +0,0 @@ - - - - - - -ResumeSkill (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.resume.skills
-

Class ResumeSkill

-
-
- -
-
    -
  • -
    -
    -
    public class ResumeSkill
-extends ResumeSkillVariation
    -
    A skill listed in a resume or job
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Variations

        -
        public List<ResumeSkillVariation> Variations
        -
        The variations (synonyms) of this skill that were found
        -
        • -
      - - - -
        -
      • -

        ChildrenMonthsExperience

        -
        public TxPrimitive<Integer> ChildrenMonthsExperience
        -
        If this skill has any variations, this describes the total months experience of those variations
        -
        • -
      - - - -
        -
      • -

        ChildrenLastUsed

        -
        public TxPrimitive<java.time.LocalDate> ChildrenLastUsed
        -
        If this skill has any variations, this describes the most recent date any of the variations were used
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ResumeSkill

        -
        public ResumeSkill()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/skills/ResumeSkillVariation.html b/docs/com/textkernel/tx/models/resume/skills/ResumeSkillVariation.html deleted file mode 100644 index db0486d04..000000000 --- a/docs/com/textkernel/tx/models/resume/skills/ResumeSkillVariation.html +++ /dev/null @@ -1,327 +0,0 @@ - - - - - - -ResumeSkillVariation (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.resume.skills
-

Class ResumeSkillVariation

-
-
- -
-
    -
  • -
    -
    Direct Known Subclasses:
    -
    ResumeSkill
    -
    -
    -
    -
    public class ResumeSkillVariation
-extends Skill
    -
    A skill listed in a resume or job
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        MonthsExperience

        -
        public TxPrimitive<Integer> MonthsExperience
        -
        Describes the amount of experience a candidate has with this skill
        -
        • -
      - - - -
        -
      • -

        LastUsed

        -
        public TxPrimitive<java.time.LocalDate> LastUsed
        -
        Describes the date the candidate last used the skill (derived from position dates)
        -
        • -
      - - - - -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ResumeSkillVariation

        -
        public ResumeSkillVariation()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/skills/ResumeSubTaxonomy.html b/docs/com/textkernel/tx/models/resume/skills/ResumeSubTaxonomy.html deleted file mode 100644 index a24b276ce..000000000 --- a/docs/com/textkernel/tx/models/resume/skills/ResumeSubTaxonomy.html +++ /dev/null @@ -1,303 +0,0 @@ - - - - - - -ResumeSubTaxonomy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.resume.skills
-

Class ResumeSubTaxonomy

-
-
- -
-
    -
  • -
    -
    -
    public class ResumeSubTaxonomy
-extends FoundSubTaxonomy
    -
    A subtaxonomy to group similar skills
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Skills

        -
        public List<ResumeSkill> Skills
        -
        The skills from this subtaxonomy that were found
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ResumeSubTaxonomy

        -
        public ResumeSubTaxonomy()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/skills/ResumeTaxonomy.html b/docs/com/textkernel/tx/models/resume/skills/ResumeTaxonomy.html deleted file mode 100644 index 27aee6e21..000000000 --- a/docs/com/textkernel/tx/models/resume/skills/ResumeTaxonomy.html +++ /dev/null @@ -1,272 +0,0 @@ - - - - - - -ResumeTaxonomy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
com.textkernel.tx.models.resume.skills
-

Class ResumeTaxonomy

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ResumeTaxonomy

        -
        public ResumeTaxonomy()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/skills/ResumeTaxonomyRoot.html b/docs/com/textkernel/tx/models/resume/skills/ResumeTaxonomyRoot.html deleted file mode 100644 index 8e893eb84..000000000 --- a/docs/com/textkernel/tx/models/resume/skills/ResumeTaxonomyRoot.html +++ /dev/null @@ -1,295 +0,0 @@ - - - - - - -ResumeTaxonomyRoot (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.resume.skills
-

Class ResumeTaxonomyRoot

-
-
- -
-
    -
  • -
    -
    -
    public class ResumeTaxonomyRoot
-extends Object
    -
    A container for skills taxonomies found in a resume
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Root

        -
        public String Root
        -
        The name of the skills list that these taxonomies belong to
        -
        • -
      - - - -
        -
      • -

        Taxonomies

        -
        public List<ResumeTaxonomy> Taxonomies
        -
        The skills taxonomies found in a resume
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ResumeTaxonomyRoot

        -
        public ResumeTaxonomyRoot()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/skills/ResumeV2Skills.html b/docs/com/textkernel/tx/models/resume/skills/ResumeV2Skills.html deleted file mode 100644 index bb1d69082..000000000 --- a/docs/com/textkernel/tx/models/resume/skills/ResumeV2Skills.html +++ /dev/null @@ -1,314 +0,0 @@ - - - - - - -ResumeV2Skills (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.resume.skills
-

Class ResumeV2Skills

-
-
- -
-
    -
  • -
    -
    -
    public class ResumeV2Skills
-extends Object
    -
    Skills output when version 2 of the taxonomy is utilized.
    -
    • -
-
-
- -
-
- -
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/skills/class-use/ResumeNormalizedSkill.html b/docs/com/textkernel/tx/models/resume/skills/class-use/ResumeNormalizedSkill.html deleted file mode 100644 index 84905e2c5..000000000 --- a/docs/com/textkernel/tx/models/resume/skills/class-use/ResumeNormalizedSkill.html +++ /dev/null @@ -1,169 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.resume.skills.ResumeNormalizedSkill (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.resume.skills.ResumeNormalizedSkill

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/skills/class-use/ResumeRawSkill.html b/docs/com/textkernel/tx/models/resume/skills/class-use/ResumeRawSkill.html deleted file mode 100644 index 3ff722377..000000000 --- a/docs/com/textkernel/tx/models/resume/skills/class-use/ResumeRawSkill.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.resume.skills.ResumeRawSkill (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.resume.skills.ResumeRawSkill

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/skills/class-use/ResumeSkill.html b/docs/com/textkernel/tx/models/resume/skills/class-use/ResumeSkill.html deleted file mode 100644 index 3bfef8196..000000000 --- a/docs/com/textkernel/tx/models/resume/skills/class-use/ResumeSkill.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.resume.skills.ResumeSkill (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.resume.skills.ResumeSkill

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/skills/class-use/ResumeSkillVariation.html b/docs/com/textkernel/tx/models/resume/skills/class-use/ResumeSkillVariation.html deleted file mode 100644 index 232ed72b6..000000000 --- a/docs/com/textkernel/tx/models/resume/skills/class-use/ResumeSkillVariation.html +++ /dev/null @@ -1,183 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.resume.skills.ResumeSkillVariation (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.resume.skills.ResumeSkillVariation

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/skills/class-use/ResumeSubTaxonomy.html b/docs/com/textkernel/tx/models/resume/skills/class-use/ResumeSubTaxonomy.html deleted file mode 100644 index f6c6d5689..000000000 --- a/docs/com/textkernel/tx/models/resume/skills/class-use/ResumeSubTaxonomy.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.resume.skills.ResumeSubTaxonomy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.resume.skills.ResumeSubTaxonomy

-
-
No usage of com.textkernel.tx.models.resume.skills.ResumeSubTaxonomy
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/skills/class-use/ResumeTaxonomy.html b/docs/com/textkernel/tx/models/resume/skills/class-use/ResumeTaxonomy.html deleted file mode 100644 index 0545ea5a0..000000000 --- a/docs/com/textkernel/tx/models/resume/skills/class-use/ResumeTaxonomy.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.resume.skills.ResumeTaxonomy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.resume.skills.ResumeTaxonomy

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/skills/class-use/ResumeTaxonomyRoot.html b/docs/com/textkernel/tx/models/resume/skills/class-use/ResumeTaxonomyRoot.html deleted file mode 100644 index 9f1e6b096..000000000 --- a/docs/com/textkernel/tx/models/resume/skills/class-use/ResumeTaxonomyRoot.html +++ /dev/null @@ -1,170 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.resume.skills.ResumeTaxonomyRoot (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.resume.skills.ResumeTaxonomyRoot

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/skills/class-use/ResumeV2Skills.html b/docs/com/textkernel/tx/models/resume/skills/class-use/ResumeV2Skills.html deleted file mode 100644 index dcd24da9c..000000000 --- a/docs/com/textkernel/tx/models/resume/skills/class-use/ResumeV2Skills.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.resume.skills.ResumeV2Skills (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.resume.skills.ResumeV2Skills

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/skills/package-frame.html b/docs/com/textkernel/tx/models/resume/skills/package-frame.html deleted file mode 100644 index 8eab5c0ec..000000000 --- a/docs/com/textkernel/tx/models/resume/skills/package-frame.html +++ /dev/null @@ -1,28 +0,0 @@ - - - - - - -com.textkernel.tx.models.resume.skills (Textkernel Tx Java SDK 2.3.3 API) - - - - - -

com.textkernel.tx.models.resume.skills

-
-

Classes

- -
- - diff --git a/docs/com/textkernel/tx/models/resume/skills/package-summary.html b/docs/com/textkernel/tx/models/resume/skills/package-summary.html deleted file mode 100644 index d1297ef1a..000000000 --- a/docs/com/textkernel/tx/models/resume/skills/package-summary.html +++ /dev/null @@ -1,188 +0,0 @@ - - - - - - -com.textkernel.tx.models.resume.skills (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package com.textkernel.tx.models.resume.skills

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/skills/package-tree.html b/docs/com/textkernel/tx/models/resume/skills/package-tree.html deleted file mode 100644 index aaf1a31ed..000000000 --- a/docs/com/textkernel/tx/models/resume/skills/package-tree.html +++ /dev/null @@ -1,177 +0,0 @@ - - - - - - -com.textkernel.tx.models.resume.skills Class Hierarchy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package com.textkernel.tx.models.resume.skills

-Package Hierarchies: - -
-
-

Class Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/resume/skills/package-use.html b/docs/com/textkernel/tx/models/resume/skills/package-use.html deleted file mode 100644 index d3e9be735..000000000 --- a/docs/com/textkernel/tx/models/resume/skills/package-use.html +++ /dev/null @@ -1,207 +0,0 @@ - - - - - - -Uses of Package com.textkernel.tx.models.resume.skills (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Package
com.textkernel.tx.models.resume.skills

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/skills/FoundSubTaxonomy.html b/docs/com/textkernel/tx/models/skills/FoundSubTaxonomy.html deleted file mode 100644 index b81f0406b..000000000 --- a/docs/com/textkernel/tx/models/skills/FoundSubTaxonomy.html +++ /dev/null @@ -1,311 +0,0 @@ - - - - - - -FoundSubTaxonomy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.skills
-

Class FoundSubTaxonomy

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        PercentOfOverall

        -
        public int PercentOfOverall
        -
        The percent (0-100) of skills found in this subtaxonomy compared to all subtaxonomies
        -
        • -
      - - - -
        -
      • -

        PercentOfParent

        -
        public int PercentOfParent
        -
        The percent (0-100) of skills found in this subtaxonomy compared to other subtaxonomies in the parent taxonomy
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        FoundSubTaxonomy

        -
        public FoundSubTaxonomy()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/skills/FoundTaxonomy.html b/docs/com/textkernel/tx/models/skills/FoundTaxonomy.html deleted file mode 100644 index 0dbc57401..000000000 --- a/docs/com/textkernel/tx/models/skills/FoundTaxonomy.html +++ /dev/null @@ -1,295 +0,0 @@ - - - - - - -FoundTaxonomy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.skills
-

Class FoundTaxonomy<T>

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        PercentOfOverall

        -
        public int PercentOfOverall
        -
        The percent (0-100) of skills found in the document that belong to this taxonomy
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        FoundTaxonomy

        -
        public FoundTaxonomy()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/skills/ITaxonomy.html b/docs/com/textkernel/tx/models/skills/ITaxonomy.html deleted file mode 100644 index a5c6be08f..000000000 --- a/docs/com/textkernel/tx/models/skills/ITaxonomy.html +++ /dev/null @@ -1,315 +0,0 @@ - - - - - - -ITaxonomy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.skills
-

Class ITaxonomy<T>

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Id

        -
        public String Id
        -
        The id of the skills taxonomy
        -
        • -
      - - - -
        -
      • -

        Name

        -
        public String Name
        -
        The human-readable name
        -
        • -
      - - - -
        -
      • -

        SubTaxonomies

        -
        public List<T> SubTaxonomies
        -
        The subtaxonomy children of this taxonomy (more specific groupings of skills)
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ITaxonomy

        -
        public ITaxonomy()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/skills/NormalizedSkill.html b/docs/com/textkernel/tx/models/skills/NormalizedSkill.html deleted file mode 100644 index 19d305bfb..000000000 --- a/docs/com/textkernel/tx/models/skills/NormalizedSkill.html +++ /dev/null @@ -1,331 +0,0 @@ - - - - - - -NormalizedSkill (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.skills
-

Class NormalizedSkill

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Name

        -
        public String Name
        -
        Name of the normalized skill.
        -
        • -
      - - - -
        -
      • -

        Id

        -
        public String Id
        -
        Id of this skill in the skills taxonomy.
        -
        • -
      - - - -
        -
      • -

        Type

        -
        public String Type
        -
        Type of skill. Possible values are Professional, IT, or Soft.
        -
        • -
      - - - -
        -
      • -

        RawSkills

        -
        public List<String> RawSkills
        -
        Array of raw skills that were extracted that normalized to this skill.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        NormalizedSkill

        -
        public NormalizedSkill()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/skills/ProfessionClass.html b/docs/com/textkernel/tx/models/skills/ProfessionClass.html deleted file mode 100644 index e02261ff6..000000000 --- a/docs/com/textkernel/tx/models/skills/ProfessionClass.html +++ /dev/null @@ -1,327 +0,0 @@ - - - - - - -ProfessionClass (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.skills
-

Class ProfessionClass

-
-
- -
-
    -
  • -
    -
    -
    public class ProfessionClass
-extends Object
    -
    Profession Class that describes a percentage of the source document.
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Name

        -
        public String Name
        -
        Name of the related profession.
        -
        • -
      - - - -
        -
      • -

        Id

        -
        public String Id
        -
        Id of the related profession.
        -
        • -
      - - - -
        -
      • -

        Percent

        -
        public int Percent
        -
        Percent of overall document that relates to this profession.
        -
        • -
      - - - -
        -
      • -

        Groups

        -
        public List<ProfessionGroup> Groups
        -
        Array of objects representing groups of professions.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ProfessionClass

        -
        public ProfessionClass()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/skills/ProfessionGroup.html b/docs/com/textkernel/tx/models/skills/ProfessionGroup.html deleted file mode 100644 index 7e056103a..000000000 --- a/docs/com/textkernel/tx/models/skills/ProfessionGroup.html +++ /dev/null @@ -1,327 +0,0 @@ - - - - - - -ProfessionGroup (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.skills
-

Class ProfessionGroup

-
-
- -
-
    -
  • -
    -
    -
    public class ProfessionGroup
-extends Object
    -
    Profession Group that describes a percentage of the Profession Class.
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Name

        -
        public String Name
        -
        Name of the profession group.
        -
        • -
      - - - -
        -
      • -

        Id

        -
        public String Id
        -
        Id of the profession group.
        -
        • -
      - - - -
        -
      • -

        Percent

        -
        public int Percent
        -
        Percent of overall document described by this profession group. All groups across all classes will add up to 100%.
        -
        • -
      - - - -
        -
      • -

        NormalizedSkills

        -
        public List<String> NormalizedSkills
        -
        Array of normalized skills associated to this profession group.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ProfessionGroup

        -
        public ProfessionGroup()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/skills/RawSkill.html b/docs/com/textkernel/tx/models/skills/RawSkill.html deleted file mode 100644 index 2531de87a..000000000 --- a/docs/com/textkernel/tx/models/skills/RawSkill.html +++ /dev/null @@ -1,283 +0,0 @@ - - - - - - -RawSkill (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.skills
-

Class RawSkill

-
-
- -
-
    -
  • -
    -
    Direct Known Subclasses:
    -
    JobRawSkill, ResumeRawSkill
    -
    -
    -
    -
    public class RawSkill
-extends Object
    -
    Skill exactly as it was found in the plain text of the document.
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Name

        -
        public String Name
        -
        The name of the skill
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        RawSkill

        -
        public RawSkill()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/skills/Skill.html b/docs/com/textkernel/tx/models/skills/Skill.html deleted file mode 100644 index ae3ea5ad7..000000000 --- a/docs/com/textkernel/tx/models/skills/Skill.html +++ /dev/null @@ -1,315 +0,0 @@ - - - - - - -Skill (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.skills
-

Class Skill

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Id

        -
        public String Id
        -
        The Id of the skill
        -
        • -
      - - - -
        -
      • -

        Name

        -
        public String Name
        -
        The name of the skill
        -
        • -
      - - - -
        -
      • -

        ExistsInText

        -
        public boolean ExistsInText
        -
        Whether or not this skill was found verbatim in the text
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        Skill

        -
        public Skill()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/skills/SubTaxonomy.html b/docs/com/textkernel/tx/models/skills/SubTaxonomy.html deleted file mode 100644 index 52cced742..000000000 --- a/docs/com/textkernel/tx/models/skills/SubTaxonomy.html +++ /dev/null @@ -1,299 +0,0 @@ - - - - - - -SubTaxonomy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.skills
-

Class SubTaxonomy

-
-
- -
-
    -
  • -
    -
    Direct Known Subclasses:
    -
    FoundSubTaxonomy
    -
    -
    -
    -
    public class SubTaxonomy
-extends Object
    -
    A subtaxonomy to group similar skills
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        SubTaxonomyId

        -
        public String SubTaxonomyId
        -
        The id of this subtaxonomy
        -
        • -
      - - - -
        -
      • -

        SubTaxonomyName

        -
        public String SubTaxonomyName
        -
        The human-readable name of this subtaxonomy
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        SubTaxonomy

        -
        public SubTaxonomy()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/skills/Taxonomy.html b/docs/com/textkernel/tx/models/skills/Taxonomy.html deleted file mode 100644 index 0b44f16cf..000000000 --- a/docs/com/textkernel/tx/models/skills/Taxonomy.html +++ /dev/null @@ -1,298 +0,0 @@ - - - - - - -Taxonomy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
com.textkernel.tx.models.skills
-

Class Taxonomy

-
-
- -
- -
-
- -
-
- -
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
- - -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/skills/class-use/FoundSubTaxonomy.html b/docs/com/textkernel/tx/models/skills/class-use/FoundSubTaxonomy.html deleted file mode 100644 index a982feb42..000000000 --- a/docs/com/textkernel/tx/models/skills/class-use/FoundSubTaxonomy.html +++ /dev/null @@ -1,192 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.skills.FoundSubTaxonomy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.skills.FoundSubTaxonomy

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/skills/class-use/FoundTaxonomy.html b/docs/com/textkernel/tx/models/skills/class-use/FoundTaxonomy.html deleted file mode 100644 index 34cbe93b5..000000000 --- a/docs/com/textkernel/tx/models/skills/class-use/FoundTaxonomy.html +++ /dev/null @@ -1,192 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.skills.FoundTaxonomy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.skills.FoundTaxonomy

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/skills/class-use/ITaxonomy.html b/docs/com/textkernel/tx/models/skills/class-use/ITaxonomy.html deleted file mode 100644 index 4113f12eb..000000000 --- a/docs/com/textkernel/tx/models/skills/class-use/ITaxonomy.html +++ /dev/null @@ -1,220 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.skills.ITaxonomy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.skills.ITaxonomy

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/skills/class-use/NormalizedSkill.html b/docs/com/textkernel/tx/models/skills/class-use/NormalizedSkill.html deleted file mode 100644 index b33f0610a..000000000 --- a/docs/com/textkernel/tx/models/skills/class-use/NormalizedSkill.html +++ /dev/null @@ -1,192 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.skills.NormalizedSkill (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.skills.NormalizedSkill

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/skills/class-use/ProfessionClass.html b/docs/com/textkernel/tx/models/skills/class-use/ProfessionClass.html deleted file mode 100644 index 204e51ae3..000000000 --- a/docs/com/textkernel/tx/models/skills/class-use/ProfessionClass.html +++ /dev/null @@ -1,192 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.skills.ProfessionClass (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.skills.ProfessionClass

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/skills/class-use/ProfessionGroup.html b/docs/com/textkernel/tx/models/skills/class-use/ProfessionGroup.html deleted file mode 100644 index 362745358..000000000 --- a/docs/com/textkernel/tx/models/skills/class-use/ProfessionGroup.html +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.skills.ProfessionGroup (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.skills.ProfessionGroup

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/skills/class-use/RawSkill.html b/docs/com/textkernel/tx/models/skills/class-use/RawSkill.html deleted file mode 100644 index 421b70c5b..000000000 --- a/docs/com/textkernel/tx/models/skills/class-use/RawSkill.html +++ /dev/null @@ -1,192 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.skills.RawSkill (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.skills.RawSkill

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/skills/class-use/Skill.html b/docs/com/textkernel/tx/models/skills/class-use/Skill.html deleted file mode 100644 index 63a46cbe0..000000000 --- a/docs/com/textkernel/tx/models/skills/class-use/Skill.html +++ /dev/null @@ -1,204 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.skills.Skill (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.skills.Skill

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/skills/class-use/SubTaxonomy.html b/docs/com/textkernel/tx/models/skills/class-use/SubTaxonomy.html deleted file mode 100644 index 1f024983f..000000000 --- a/docs/com/textkernel/tx/models/skills/class-use/SubTaxonomy.html +++ /dev/null @@ -1,216 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.skills.SubTaxonomy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.skills.SubTaxonomy

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/skills/class-use/Taxonomy.html b/docs/com/textkernel/tx/models/skills/class-use/Taxonomy.html deleted file mode 100644 index 970c88548..000000000 --- a/docs/com/textkernel/tx/models/skills/class-use/Taxonomy.html +++ /dev/null @@ -1,166 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.models.skills.Taxonomy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.models.skills.Taxonomy

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/skills/package-frame.html b/docs/com/textkernel/tx/models/skills/package-frame.html deleted file mode 100644 index f417b74ea..000000000 --- a/docs/com/textkernel/tx/models/skills/package-frame.html +++ /dev/null @@ -1,30 +0,0 @@ - - - - - - -com.textkernel.tx.models.skills (Textkernel Tx Java SDK 2.3.3 API) - - - - - -

com.textkernel.tx.models.skills

-
-

Classes

- -
- - diff --git a/docs/com/textkernel/tx/models/skills/package-summary.html b/docs/com/textkernel/tx/models/skills/package-summary.html deleted file mode 100644 index 284d96946..000000000 --- a/docs/com/textkernel/tx/models/skills/package-summary.html +++ /dev/null @@ -1,198 +0,0 @@ - - - - - - -com.textkernel.tx.models.skills (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package com.textkernel.tx.models.skills

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/skills/package-tree.html b/docs/com/textkernel/tx/models/skills/package-tree.html deleted file mode 100644 index 022e9f32a..000000000 --- a/docs/com/textkernel/tx/models/skills/package-tree.html +++ /dev/null @@ -1,154 +0,0 @@ - - - - - - -com.textkernel.tx.models.skills Class Hierarchy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package com.textkernel.tx.models.skills

-Package Hierarchies: - -
-
-

Class Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/models/skills/package-use.html b/docs/com/textkernel/tx/models/skills/package-use.html deleted file mode 100644 index ab8308d42..000000000 --- a/docs/com/textkernel/tx/models/skills/package-use.html +++ /dev/null @@ -1,286 +0,0 @@ - - - - - - -Uses of Package com.textkernel.tx.models.skills (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Package
com.textkernel.tx.models.skills

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/package-frame.html b/docs/com/textkernel/tx/package-frame.html deleted file mode 100644 index 2fff620f0..000000000 --- a/docs/com/textkernel/tx/package-frame.html +++ /dev/null @@ -1,23 +0,0 @@ - - - - - - -com.textkernel.tx (Textkernel Tx Java SDK 2.3.3 API) - - - - - -

com.textkernel.tx

-
-

Classes

- -
- - diff --git a/docs/com/textkernel/tx/package-summary.html b/docs/com/textkernel/tx/package-summary.html deleted file mode 100644 index 3b5342d81..000000000 --- a/docs/com/textkernel/tx/package-summary.html +++ /dev/null @@ -1,158 +0,0 @@ - - - - - - -com.textkernel.tx (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package com.textkernel.tx

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/package-tree.html b/docs/com/textkernel/tx/package-tree.html deleted file mode 100644 index 106326719..000000000 --- a/docs/com/textkernel/tx/package-tree.html +++ /dev/null @@ -1,141 +0,0 @@ - - - - - - -com.textkernel.tx Class Hierarchy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package com.textkernel.tx

-Package Hierarchies: - -
-
-

Class Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/package-use.html b/docs/com/textkernel/tx/package-use.html deleted file mode 100644 index d9f99895e..000000000 --- a/docs/com/textkernel/tx/package-use.html +++ /dev/null @@ -1,166 +0,0 @@ - - - - - - -Uses of Package com.textkernel.tx (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Package
com.textkernel.tx

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/utilities/TxJsonSerializer.html b/docs/com/textkernel/tx/utilities/TxJsonSerializer.html deleted file mode 100644 index d917e7ba3..000000000 --- a/docs/com/textkernel/tx/utilities/TxJsonSerializer.html +++ /dev/null @@ -1,303 +0,0 @@ - - - - - - -TxJsonSerializer (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
com.textkernel.tx.utilities
-

Class TxJsonSerializer

-
-
- -
-
    -
  • -
    -
    -
    public class TxJsonSerializer
-extends Object
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        TxJsonSerializer

        -
        public TxJsonSerializer()
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        serialize

        -
        public static String serialize(Object o)
        -
        • -
      - - - -
        -
      • -

        serialize

        -
        public static String serialize(Object o,
-                               boolean formatted)
        -
        • -
      - - - -
        -
      • -

        deserialize

        -
        public static <T> T deserialize(String json,
-                                Class<T> classOfT)
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/utilities/class-use/TxJsonSerializer.html b/docs/com/textkernel/tx/utilities/class-use/TxJsonSerializer.html deleted file mode 100644 index 043d0aabf..000000000 --- a/docs/com/textkernel/tx/utilities/class-use/TxJsonSerializer.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Class com.textkernel.tx.utilities.TxJsonSerializer (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Class
com.textkernel.tx.utilities.TxJsonSerializer

-
-
No usage of com.textkernel.tx.utilities.TxJsonSerializer
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/utilities/package-frame.html b/docs/com/textkernel/tx/utilities/package-frame.html deleted file mode 100644 index c1f144094..000000000 --- a/docs/com/textkernel/tx/utilities/package-frame.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - -com.textkernel.tx.utilities (Textkernel Tx Java SDK 2.3.3 API) - - - - - -

com.textkernel.tx.utilities

-
-

Classes

- -
- - diff --git a/docs/com/textkernel/tx/utilities/package-summary.html b/docs/com/textkernel/tx/utilities/package-summary.html deleted file mode 100644 index 0d4c0c001..000000000 --- a/docs/com/textkernel/tx/utilities/package-summary.html +++ /dev/null @@ -1,144 +0,0 @@ - - - - - - -com.textkernel.tx.utilities (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Package com.textkernel.tx.utilities

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/utilities/package-tree.html b/docs/com/textkernel/tx/utilities/package-tree.html deleted file mode 100644 index 46c50a636..000000000 --- a/docs/com/textkernel/tx/utilities/package-tree.html +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - -com.textkernel.tx.utilities Class Hierarchy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package com.textkernel.tx.utilities

-Package Hierarchies: - -
-
-

Class Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/com/textkernel/tx/utilities/package-use.html b/docs/com/textkernel/tx/utilities/package-use.html deleted file mode 100644 index 925cf3cf5..000000000 --- a/docs/com/textkernel/tx/utilities/package-use.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Uses of Package com.textkernel.tx.utilities (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Uses of Package
com.textkernel.tx.utilities

-
-
No usage of com.textkernel.tx.utilities
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/constant-values.html b/docs/constant-values.html deleted file mode 100644 index f3b2cdeb4..000000000 --- a/docs/constant-values.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - -Constant Field Values (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Constant Field Values

-

Contents

-
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/deprecated-list.html b/docs/deprecated-list.html deleted file mode 100644 index 0df353d8b..000000000 --- a/docs/deprecated-list.html +++ /dev/null @@ -1,226 +0,0 @@ - - - - - - -Deprecated List (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Deprecated API

-

Contents

- -
-
- - - - - - - -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/help-doc.html b/docs/help-doc.html deleted file mode 100644 index 4693ed754..000000000 --- a/docs/help-doc.html +++ /dev/null @@ -1,231 +0,0 @@ - - - - - - -API Help (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

How This API Document Is Organized

-
This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
-
-
- -This help file applies to API documentation generated using the standard doclet.
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/index-all.html b/docs/index-all.html deleted file mode 100644 index 91fda14c8..000000000 --- a/docs/index-all.html +++ /dev/null @@ -1,6160 +0,0 @@ - - - - - - -Index (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
A B C D E F G H I J K L M N O P Q R S T U V W _  - - -

A

-
-
AccountId - Variable in class com.textkernel.tx.models.api.AccountInfo
-
-
The AccountId for the account
-
-
AccountInfo - Class in com.textkernel.tx.models.api
-
-
Contains information about the account making the API call
-
-
AccountInfo() - Constructor for class com.textkernel.tx.models.api.AccountInfo
-
 
-
Achievements - Variable in class com.textkernel.tx.models.resume.ParsedResume
-
-
Any achievements listed on the resume
-
-
Actual - Variable in class com.textkernel.tx.models.api.matching.response.ManagementLevelScoreData
-
-
Actual management level found.
-
-
ActualEducation - Variable in class com.textkernel.tx.models.api.matching.response.EducationScoreData
-
-
Actual level of education found.
-
-
ActualTaxonomies - Variable in class com.textkernel.tx.models.api.matching.response.TaxonomiesScoreData
-
-
Taxonomies/industries found.
-
-
Address - Class in com.textkernel.tx.models.api.geocoding
-
-
An address used to geocode a document
-
-
Address() - Constructor for class com.textkernel.tx.models.api.geocoding.Address
-
 
-
Address - Variable in class com.textkernel.tx.models.resume.contactinfo.WebAddress
-
-
The URL or username
-
-
AddressLine - Variable in class com.textkernel.tx.models.api.geocoding.Address
-
-
Street address
-
-
Amount - Variable in class com.textkernel.tx.models.resume.Salary
-
-
The amount of the salary (usually yearly when listed on a resume)
-
-
AmountOfExperienceMatches - Variable in class com.textkernel.tx.models.api.matching.response.ManagementLevelScoreData
-
-
true when the duration of management experience matches in the source and target documents.
-
-
ApiResponse<T> - Class in com.textkernel.tx.models.api
-
-
The response body from a Tx API call
-
-
ApiResponse() - Constructor for class com.textkernel.tx.models.api.ApiResponse
-
 
-
ApiResponseInfo - Class in com.textkernel.tx.models.api
-
-
Information/metadata for an individual REST API call.
-
-
ApiResponseInfo() - Constructor for class com.textkernel.tx.models.api.ApiResponseInfo
-
 
-
ApiResponseInfoLite - Class in com.textkernel.tx.models.api
-
-
Information/metadata for an individual REST API call.
-
-
ApiResponseInfoLite() - Constructor for class com.textkernel.tx.models.api.ApiResponseInfoLite
-
 
-
ApiVersion - Variable in class com.textkernel.tx.models.api.ApiResponseInfo
-
-
The version of the API
-
-
ApplicationDeadline - Variable in class com.textkernel.tx.models.job.ApplicationDetails
-
-
Deadline to apply for the job
-
-
ApplicationDescription - Variable in class com.textkernel.tx.models.job.ApplicationDetails
-
-
Full text description of the application process
-
-
ApplicationDetails - Class in com.textkernel.tx.models.job
-
-
An object containing details about the application process
-
-
ApplicationDetails() - Constructor for class com.textkernel.tx.models.job.ApplicationDetails
-
 
-
ApplicationDetails - Variable in class com.textkernel.tx.models.job.ParsedJob
-
-
Information about the application process.
-
-
AppliedCategoryWeights - Variable in class com.textkernel.tx.models.api.matching.BaseScoredResponseValue
-
-
The weights that were actually used for scoring.
-
-
AreaCityCode - Variable in class com.textkernel.tx.models.resume.contactinfo.Telephone
-
-
The area code part of the phone number
-
-
Association - Class in com.textkernel.tx.models.resume
-
-
An association/organization found on a resume
-
-
Association() - Constructor for class com.textkernel.tx.models.resume.Association
-
 
-
Associations - Variable in class com.textkernel.tx.models.resume.ParsedResume
-
-
Associations/organizations found on a resume
-
-
AttentionNeeded - Variable in class com.textkernel.tx.models.resume.employment.ExperienceSummary
-
-
Any abnormal findings about the candidate's career will be reported here.
-
-
AU - Static variable in class com.textkernel.tx.DataCenter
-
-
Represents the AU datacenter.
-
-
autocompleteProfession(String, List<String>, String, int) - Method in class com.textkernel.tx.TxClient
-
-
Returns normalized professions that begin with a given prefix, based on the chosen language(s).
-
-
autocompleteProfession(String) - Method in class com.textkernel.tx.TxClient
-
-
Returns normalized professions that begin with a given prefix, based on the default language of english.
-
-
AutocompleteRequest - Class in com.textkernel.tx.models.api.dataenrichment
-
-
Request body for a 'ProfessionsAutocomplete' request
-
-
AutocompleteRequest() - Constructor for class com.textkernel.tx.models.api.dataenrichment.AutocompleteRequest
-
 
-
autocompleteSkill(String, List<String>, String, List<String>, int) - Method in class com.textkernel.tx.TxClient
-
-
Returns normalized skills that begin with a given prefix, based on the chosen language(s).
-
-
autocompleteSkill(String) - Method in class com.textkernel.tx.TxClient
-
-
Returns normalized skills that begin with a given prefix, based on the chosen language(s).
-
-
AutoCompleteSkillsResponse - Class in com.textkernel.tx.models.api.dataenrichment.skills.response
-
-
The response body from a SkillsAutocomplete API call
-
-
AutoCompleteSkillsResponse() - Constructor for class com.textkernel.tx.models.api.dataenrichment.skills.response.AutoCompleteSkillsResponse
-
 
-
AutocompleteSkillsResponseValue - Class in com.textkernel.tx.models.api.dataenrichment.skills.response
-
-
One entry in the ApiResponse.Value from a 'SkillsAutocomplete' response
-
-
AutocompleteSkillsResponseValue() - Constructor for class com.textkernel.tx.models.api.dataenrichment.skills.response.AutocompleteSkillsResponseValue
-
 
-
autocompleteSkillV2(String, List<String>, String, List<String>, int) - Method in class com.textkernel.tx.TxClient
-
-
Returns normalized skills that begin with a given prefix, based on the chosen language(s).
-
-
autocompleteSkillV2(String) - Method in class com.textkernel.tx.TxClient
-
-
Returns normalized skills that begin with a given prefix, based on the chosen language(s).
-
-
Availability - Variable in class com.textkernel.tx.models.resume.PersonalAttributes
-
-
The availability of the candidate
-
-
AverageMonthsPerEmployer - Variable in class com.textkernel.tx.models.api.matching.request.FilterCriteria
-
-
Results much have ExperienceSummary.AverageMonthsPerEmployer within this range.
-
-
AverageMonthsPerEmployer - Variable in class com.textkernel.tx.models.resume.employment.ExperienceSummary
-
-
The average number of months a candidate has spent at each employer.
-
-
- - - -

B

-
-
BaseParseResponseValue - Class in com.textkernel.tx.models.api.parsing
-
-
The ApiResponse.Value from a Parse response
-
-
BaseParseResponseValue() - Constructor for class com.textkernel.tx.models.api.parsing.BaseParseResponseValue
-
 
-
BaseScoredResponseValue<T> - Class in com.textkernel.tx.models.api.matching
-
-
A base class for all scored responses
-
-
BaseScoredResponseValue() - Constructor for class com.textkernel.tx.models.api.matching.BaseScoredResponseValue
-
 
-
BaseSearchMatchResponseValue<T> - Class in com.textkernel.tx.models.api.matching
-
-
Base class for searches/matches response values
-
-
BaseSearchMatchResponseValue() - Constructor for class com.textkernel.tx.models.api.matching.BaseSearchMatchResponseValue
-
 
-
BasicParseOptions - Class in com.textkernel.tx.models.api.parsing
-
-
Basic parse options
-
-
BasicParseOptions() - Constructor for class com.textkernel.tx.models.api.parsing.BasicParseOptions
-
 
-
BasicProfession - Class in com.textkernel.tx.models.dataenrichment
-
-
A profession ID/description from the Professions Taxonomy.
-
-
BasicProfession() - Constructor for class com.textkernel.tx.models.dataenrichment.BasicProfession
-
 
-
BeginSpan - Variable in class com.textkernel.tx.models.dataenrichment.SkillMatch
-
-
The index of the first character of the match (0-based).
-
-
Benefits - Variable in class com.textkernel.tx.models.job.ParsedJob
-
-
Full text of any benefits listed by the job.
-
-
bimetricScore(ParsedResumeWithId, List<TTarget>, CategoryWeights, SearchMatchSettings) - Method in class com.textkernel.tx.TxClient
-
-
Score one or more target documents against a source resume
-
-
bimetricScore(ParsedJobWithId, List<TTarget>, CategoryWeights, SearchMatchSettings) - Method in class com.textkernel.tx.TxClient
-
-
Score one or more target documents against a source job
-
-
bimetricScore(ParsedResumeWithId, List<TTarget>, CategoryWeights, SearchMatchSettings) - Method in class com.textkernel.tx.TxUIClient
-
-
Create a Matching UI session to score one or more target documents against a source resume
-
-
bimetricScore(ParsedJobWithId, List<TTarget>, CategoryWeights, SearchMatchSettings) - Method in class com.textkernel.tx.TxUIClient
-
-
Create a Matching UI session to score one or more target documents against a source job
-
-
BimetricScoreJobRequest - Class in com.textkernel.tx.models.api.bimetricscoring
-
-
Request body for a 'BimetricScore' request
-
-
BimetricScoreJobRequest() - Constructor for class com.textkernel.tx.models.api.bimetricscoring.BimetricScoreJobRequest
-
 
-
BimetricScoreRequest - Class in com.textkernel.tx.models.api.bimetricscoring
-
-
Request body for a 'BimetricScore' request
-
-
BimetricScoreRequest() - Constructor for class com.textkernel.tx.models.api.bimetricscoring.BimetricScoreRequest
-
 
-
BimetricScoreResponse - Class in com.textkernel.tx.models.api.bimetricscoring
-
-
The response body from a BimetricScore API call
-
-
BimetricScoreResponse() - Constructor for class com.textkernel.tx.models.api.bimetricscoring.BimetricScoreResponse
-
 
-
BimetricScoreResponseValue - Class in com.textkernel.tx.models.api.bimetricscoring
-
-
The ApiResponse.Value from a 'BimetricScore' response
-
-
BimetricScoreResponseValue() - Constructor for class com.textkernel.tx.models.api.bimetricscoring.BimetricScoreResponseValue
-
 
-
BimetricScoreResult - Class in com.textkernel.tx.models.api.bimetricscoring
-
-
And individual result (representing a single document) for a 'BimetricScore' request
-
-
BimetricScoreResult() - Constructor for class com.textkernel.tx.models.api.bimetricscoring.BimetricScoreResult
-
 
-
BimetricScoreResumeRequest - Class in com.textkernel.tx.models.api.bimetricscoring
-
-
Request body for a 'BimetricScore' request
-
-
BimetricScoreResumeRequest() - Constructor for class com.textkernel.tx.models.api.bimetricscoring.BimetricScoreResumeRequest
-
 
-
Birthplace - Variable in class com.textkernel.tx.models.resume.PersonalAttributes
-
-
The birthplace of the candidate
-
-
Branch - Variable in class com.textkernel.tx.models.resume.military.MilitaryService
-
-
The branch of the military
-
-
Bullet - Class in com.textkernel.tx.models.resume.employment
-
-
A single entry in a bullet-point list in a position/job description on a resume
-
-
Bullet() - Constructor for class com.textkernel.tx.models.resume.employment.Bullet
-
 
-
Bullets - Variable in class com.textkernel.tx.models.resume.employment.Position
-
-
Bullet points found in the Position.Description (available when OutputFormat.CreateBullets = true is set in the Configuration string on the request)
-
-
- - - -

C

-
-
CandidateImage - Variable in class com.textkernel.tx.models.api.parsing.Conversions
-
-
If a candidate photo was extracted, it will be output here.
-
-
CandidateImageExtension - Variable in class com.textkernel.tx.models.api.parsing.Conversions
-
-
If a candidate photo was extracted, the appropriate file extension for the photo will be output for this field (e.g.
-
-
CandidateName - Variable in class com.textkernel.tx.models.resume.contactinfo.ContactInformation
-
-
The candidate's name
-
-
CandidateReference - Class in com.textkernel.tx.models.resume
-
-
A reference found on a resume
-
-
CandidateReference() - Constructor for class com.textkernel.tx.models.resume.CandidateReference
-
 
-
CategoryScoreData - Class in com.textkernel.tx.models.api.matching.response
-
-
Details about the score for a specific category
-
-
CategoryScoreData() - Constructor for class com.textkernel.tx.models.api.matching.response.CategoryScoreData
-
 
-
CategoryScoreEvidence - Class in com.textkernel.tx.models.api.matching.response
-
-
Contains information about why the score is a certain value
-
-
CategoryScoreEvidence() - Constructor for class com.textkernel.tx.models.api.matching.response.CategoryScoreEvidence
-
 
-
CategoryWeights - Class in com.textkernel.tx.models.api.matching
-
-
Weights for each category used in matching/scoring
-
-
CategoryWeights() - Constructor for class com.textkernel.tx.models.api.matching.CategoryWeights
-
 
-
Certification - Class in com.textkernel.tx.models.resume
-
-
A certification found on a resume
-
-
Certification() - Constructor for class com.textkernel.tx.models.resume.Certification
-
 
-
Certifications - Variable in class com.textkernel.tx.models.api.matching.CategoryWeights
-
-
The weight of the Certifications category relative to other categories.
-
-
Certifications - Variable in class com.textkernel.tx.models.api.matching.request.FilterCriteria
-
-
Results must have at least one of the specified certifications.
-
-
Certifications - Variable in class com.textkernel.tx.models.api.matching.response.EnrichedScoreData
-
-
Detailed match information for the Certifications category.
-
-
Certifications - Variable in class com.textkernel.tx.models.resume.ParsedResume
-
-
Certifications found on a resume.
-
-
CertificationsAndLicenses - Variable in class com.textkernel.tx.models.job.ParsedJob
-
-
Any certifications/licenses listed in the job.
-
-
CertificationsHasData - Variable in class com.textkernel.tx.models.api.matching.CategoryWeights
-
-
If false, the Certifications category has no data and should be ignored/hidden.
-
-
ChildrenLastUsed - Variable in class com.textkernel.tx.models.resume.skills.ResumeSkill
-
-
If this skill has any variations, this describes the most recent date any of the variations were used
-
-
ChildrenMonthsExperience - Variable in class com.textkernel.tx.models.resume.skills.ResumeSkill
-
-
If this skill has any variations, this describes the total months experience of those variations
-
-
Class - Variable in class com.textkernel.tx.models.dataenrichment.Profession
-
-
/// The class which this profession belongs to.
-
-
Class - Variable in class com.textkernel.tx.models.resume.employment.ParsingNormalizedProfession
-
-
The object of the class to which the profession concept belongs.
-
-
Client - Variable in class com.textkernel.tx.models.api.matching.ui.hooks.UserActionHookCollection
-
-
The client-side User Action Hooks - for a Matching UI session.
-
-
ClientSideHook - Class in com.textkernel.tx.models.api.matching.ui.hooks
-
-
A hook that does some client-side action (opening a tab/window, running some javascript)
-
-
ClientSideHook() - Constructor for class com.textkernel.tx.models.api.matching.ui.hooks.ClientSideHook
-
 
-
Code - Variable in class com.textkernel.tx.models.api.ApiResponseInfoLite
-
-
See https://developer.textkernel.com/tx-platform/v10/overview/#http-status-codes
-
-
Code - Variable in class com.textkernel.tx.models.api.parsing.FlexResponse
-
-
See https://developer.textkernel.com/tx-platform/v10/overview/#http-status-codes
-
-
Code - Variable in class com.textkernel.tx.models.resume.education.NormalizedDegree
-
-
One of the codes listed here.
-
-
CodeId - Variable in class com.textkernel.tx.models.api.dataenrichment.ontology.response.SuggestedProfession
-
-
The code ID of the profession in the Professions Taxonomy.
-
-
CodeId - Variable in class com.textkernel.tx.models.dataenrichment.BasicProfession
-
-
The unique code ID of the profession in the Professions Taxonomy.
-
-
CodeId - Variable in class com.textkernel.tx.models.dataenrichment.ProfessionClassification
-
-
The code id of the profession concept.
-
-
CodeId - Variable in class com.textkernel.tx.models.resume.employment.ProfessionClassification
-
-
The code id of the profession concept.
-
-
CodeIds - Variable in class com.textkernel.tx.models.api.dataenrichment.professions.request.LookupProfessionCodesRequest
-
-
The profession code IDs to get details about from the Professions Taxonomy.
-
-
com.textkernel.tx - package com.textkernel.tx
-
 
-
com.textkernel.tx.exceptions - package com.textkernel.tx.exceptions
-
 
-
com.textkernel.tx.http - package com.textkernel.tx.http
-
 
-
com.textkernel.tx.models - package com.textkernel.tx.models
-
 
-
com.textkernel.tx.models.api - package com.textkernel.tx.models.api
-
 
-
com.textkernel.tx.models.api.account - package com.textkernel.tx.models.api.account
-
 
-
com.textkernel.tx.models.api.bimetricscoring - package com.textkernel.tx.models.api.bimetricscoring
-
 
-
com.textkernel.tx.models.api.dataenrichment - package com.textkernel.tx.models.api.dataenrichment
-
 
-
com.textkernel.tx.models.api.dataenrichment.ontology.request - package com.textkernel.tx.models.api.dataenrichment.ontology.request
-
 
-
com.textkernel.tx.models.api.dataenrichment.ontology.response - package com.textkernel.tx.models.api.dataenrichment.ontology.response
-
 
-
com.textkernel.tx.models.api.dataenrichment.professions - package com.textkernel.tx.models.api.dataenrichment.professions
-
 
-
com.textkernel.tx.models.api.dataenrichment.professions.request - package com.textkernel.tx.models.api.dataenrichment.professions.request
-
 
-
com.textkernel.tx.models.api.dataenrichment.professions.response - package com.textkernel.tx.models.api.dataenrichment.professions.response
-
 
-
com.textkernel.tx.models.api.dataenrichment.skills.request - package com.textkernel.tx.models.api.dataenrichment.skills.request
-
 
-
com.textkernel.tx.models.api.dataenrichment.skills.response - package com.textkernel.tx.models.api.dataenrichment.skills.response
-
 
-
com.textkernel.tx.models.api.formatter - package com.textkernel.tx.models.api.formatter
-
 
-
com.textkernel.tx.models.api.geocoding - package com.textkernel.tx.models.api.geocoding
-
 
-
com.textkernel.tx.models.api.indexes - package com.textkernel.tx.models.api.indexes
-
 
-
com.textkernel.tx.models.api.jobdescription - package com.textkernel.tx.models.api.jobdescription
-
 
-
com.textkernel.tx.models.api.matching - package com.textkernel.tx.models.api.matching
-
 
-
com.textkernel.tx.models.api.matching.request - package com.textkernel.tx.models.api.matching.request
-
 
-
com.textkernel.tx.models.api.matching.response - package com.textkernel.tx.models.api.matching.response
-
 
-
com.textkernel.tx.models.api.matching.ui - package com.textkernel.tx.models.api.matching.ui
-
 
-
com.textkernel.tx.models.api.matching.ui.hooks - package com.textkernel.tx.models.api.matching.ui.hooks
-
 
-
com.textkernel.tx.models.api.matching.ui.request - package com.textkernel.tx.models.api.matching.ui.request
-
 
-
com.textkernel.tx.models.api.parsing - package com.textkernel.tx.models.api.parsing
-
 
-
com.textkernel.tx.models.dataenrichment - package com.textkernel.tx.models.dataenrichment
-
 
-
com.textkernel.tx.models.job - package com.textkernel.tx.models.job
-
 
-
com.textkernel.tx.models.job.skills - package com.textkernel.tx.models.job.skills
-
 
-
com.textkernel.tx.models.matching - package com.textkernel.tx.models.matching
-
 
-
com.textkernel.tx.models.resume - package com.textkernel.tx.models.resume
-
 
-
com.textkernel.tx.models.resume.contactinfo - package com.textkernel.tx.models.resume.contactinfo
-
 
-
com.textkernel.tx.models.resume.education - package com.textkernel.tx.models.resume.education
-
 
-
com.textkernel.tx.models.resume.employment - package com.textkernel.tx.models.resume.employment
-
 
-
com.textkernel.tx.models.resume.metadata - package com.textkernel.tx.models.resume.metadata
-
 
-
com.textkernel.tx.models.resume.military - package com.textkernel.tx.models.resume.military
-
 
-
com.textkernel.tx.models.resume.skills - package com.textkernel.tx.models.resume.skills
-
 
-
com.textkernel.tx.models.skills - package com.textkernel.tx.models.skills
-
 
-
com.textkernel.tx.utilities - package com.textkernel.tx.utilities
-
 
-
CommonSkills - Variable in class com.textkernel.tx.models.api.dataenrichment.ontology.response.CompareProfessionsResponseValue
-
-
A list of common skills for both professions.
-
-
CommonSkills - Variable in class com.textkernel.tx.models.api.dataenrichment.ontology.response.CompareSkillsToProfessionResponseValue
-
-
A list of common skills between skill set and profession.
-
-
Company - Variable in class com.textkernel.tx.models.resume.CandidateReference
-
-
The employer of the reference
-
-
CompanyNameWithProbability - Class in com.textkernel.tx.models.resume.employment
-
-
A company name that has been normalized and assigned a probability
-
-
CompanyNameWithProbability() - Constructor for class com.textkernel.tx.models.resume.employment.CompanyNameWithProbability
-
 
-
compareProfessions(int, int, String) - Method in class com.textkernel.tx.TxClient
-
-
Compare two professions based on the skills associated with each.
-
-
CompareProfessionsRequest - Class in com.textkernel.tx.models.api.dataenrichment.ontology.request
-
-
Request body for a 'CompareProfessions' request
-
-
CompareProfessionsRequest() - Constructor for class com.textkernel.tx.models.api.dataenrichment.ontology.request.CompareProfessionsRequest
-
 
-
CompareProfessionsResponse - Class in com.textkernel.tx.models.api.dataenrichment.ontology.response
-
-
The response body from a CompareProfessions API call
-
-
CompareProfessionsResponse() - Constructor for class com.textkernel.tx.models.api.dataenrichment.ontology.response.CompareProfessionsResponse
-
 
-
CompareProfessionsResponseValue - Class in com.textkernel.tx.models.api.dataenrichment.ontology.response
-
-
One entry in the ApiResponse.Value from a 'CompareProfessions' response
-
-
CompareProfessionsResponseValue() - Constructor for class com.textkernel.tx.models.api.dataenrichment.ontology.response.CompareProfessionsResponseValue
-
 
-
CompareSkillsToProfessionRequest - Class in com.textkernel.tx.models.api.dataenrichment.ontology.request
-
-
Request body for a 'CompareSkillsToProfession' request
-
-
CompareSkillsToProfessionRequest() - Constructor for class com.textkernel.tx.models.api.dataenrichment.ontology.request.CompareSkillsToProfessionRequest
-
 
-
CompareSkillsToProfessionResponse - Class in com.textkernel.tx.models.api.dataenrichment.ontology.response
-
-
The response body from a CompareSkillsToProfession API call
-
-
CompareSkillsToProfessionResponse() - Constructor for class com.textkernel.tx.models.api.dataenrichment.ontology.response.CompareSkillsToProfessionResponse
-
 
-
CompareSkillsToProfessionResponseValue - Class in com.textkernel.tx.models.api.dataenrichment.ontology.response
-
-
One entry in the ApiResponse.Value from a 'CompareSkillsToProfession' response
-
-
CompareSkillsToProfessionResponseValue() - Constructor for class com.textkernel.tx.models.api.dataenrichment.ontology.response.CompareSkillsToProfessionResponseValue
-
 
-
compareSkillsToProfessions(int, String, List<SkillScore>) - Method in class com.textkernel.tx.TxClient
-
-
Compare a given set of skills to the skills related to a given profession.
-
-
compareSkillsToProfessions(ParsedResume, int, String, boolean) - Method in class com.textkernel.tx.TxClient
-
-
Compare the skills of a candidate to the skills related to a job using the Ontology API.
-
-
Comparison - Variable in class com.textkernel.tx.models.api.matching.response.EducationScoreData
-
-
How the EducationScoreData.ActualEducation compares to the EducationScoreData.ExpectedEducation.
-
-
Confidence - Variable in class com.textkernel.tx.models.dataenrichment.NormalizedProfession
-
-
A value from [0 - 1] indicating how well the input job title matched to the normalized profession.
-
-
Confidence - Variable in class com.textkernel.tx.models.dataenrichment.SkillAndConfidence
-
-
Overall confidence that the skill was normalized to the correct skill.
-
-
Confidence - Variable in class com.textkernel.tx.models.resume.employment.ParsingNormalizedProfession
-
-
Overall confidence that the input job title was normalized to the correct profession concept
-
-
Configuration - Variable in class com.textkernel.tx.models.api.parsing.BasicParseOptions
-
-
The configuration settings to use during parsing.
-
-
ContactEmail - Variable in class com.textkernel.tx.models.job.ApplicationDetails
-
-
Displayable email of the organization.
-
-
ContactInformation - Class in com.textkernel.tx.models.resume.contactinfo
-
-
A candidate's contact information listed on a resume
-
-
ContactInformation() - Constructor for class com.textkernel.tx.models.resume.contactinfo.ContactInformation
-
 
-
ContactInformation - Variable in class com.textkernel.tx.models.resume.ParsedResume
-
-
The candidate's contact information found on the resume
-
-
ContactPerson - Variable in class com.textkernel.tx.models.job.ApplicationDetails
-
-
Full name of the main contact person for the application
-
-
ContactPhone - Variable in class com.textkernel.tx.models.job.ApplicationDetails
-
-
Normalized phone of the organization with international calling prefix.
-
-
ContractType - Variable in class com.textkernel.tx.models.job.ParsedJob
-
-
The contract type.
-
-
ConversionMetadata - Variable in class com.textkernel.tx.models.api.parsing.BaseParseResponseValue
-
-
Information about converting the document to plain text
-
-
ConversionMetadata - Class in com.textkernel.tx.models.api.parsing
-
-
Information about a document conversion
-
-
ConversionMetadata() - Constructor for class com.textkernel.tx.models.api.parsing.ConversionMetadata
-
 
-
Conversions - Variable in class com.textkernel.tx.models.api.parsing.BaseParseResponseValue
-
-
Any additional conversions you requested will be here (eg: PDF or HTML)
-
-
Conversions - Class in com.textkernel.tx.models.api.parsing
-
-
Conversions output by the document converter during a parse transaction
-
-
Conversions() - Constructor for class com.textkernel.tx.models.api.parsing.Conversions
-
 
-
Country - Variable in class com.textkernel.tx.models.resume.military.MilitaryDetails
-
-
The country that the military belongs to
-
-
CountryCode - Variable in class com.textkernel.tx.models.api.geocoding.Address
-
-
The 2-letter ISO 3166 country code
-
-
CountryCode - Variable in class com.textkernel.tx.models.api.matching.request.FilterLocation
-
-
The 2-letter ISO 3166 country code
-
-
CountryCode - Variable in class com.textkernel.tx.models.Location
-
-
The 2-letter ISO 3166 country code
-
-
CoverLetter - Variable in class com.textkernel.tx.models.resume.ParsedResume
-
-
The cover letter, if present.
-
-
createIndex(IndexType, String) - Method in class com.textkernel.tx.TxClient
-
-
Create a new index
-
-
CreateIndexRequest - Class in com.textkernel.tx.models.api.indexes
-
-
Request body to create an index
-
-
CreateIndexRequest() - Constructor for class com.textkernel.tx.models.api.indexes.CreateIndexRequest
-
 
-
CreateIndexResponse - Class in com.textkernel.tx.models.api.indexes
-
-
The response body from a CreateIndex API call
-
-
CreateIndexResponse() - Constructor for class com.textkernel.tx.models.api.indexes.CreateIndexResponse
-
 
-
CreditsRemaining - Variable in class com.textkernel.tx.models.api.AccountInfo
-
-
The number of credits remaining to be used by the account
-
-
CreditsUsed - Variable in class com.textkernel.tx.models.api.AccountInfo
-
-
The number of credits used by the account
-
-
CreditsUsed - Variable in class com.textkernel.tx.models.api.ApiResponseInfo
-
-
How many credits the customer was charged for this transaction
-
-
CsvOutput - Variable in class com.textkernel.tx.models.dataenrichment.Taxonomy
-
-
If TaxonomyFormat.csv is requested, this string will contain the csv formatted taxonomy output.
-
-
Currency - Variable in class com.textkernel.tx.models.job.PayRange
-
-
Currency code (ISO 4217) applied to the PayRange.Minimum and PayRange.Maximum
-
-
Currency - Variable in class com.textkernel.tx.models.resume.Salary
-
-
The three-letter currency, eg: USD
-
-
CurrentCount - Variable in class com.textkernel.tx.models.api.matching.BaseSearchMatchResponseValue
-
-
The number of results returned in this response
-
-
CurrentJobIsManagement - Variable in class com.textkernel.tx.models.job.ParsedJob
-
-
Whether or not the job is a management position.
-
-
CurrentLocation - Variable in class com.textkernel.tx.models.job.ParsedJob
-
-
The location of the job, if listed.
-
-
CurrentLocation - Variable in class com.textkernel.tx.models.resume.PersonalAttributes
-
-
The current location listed on the resume
-
-
CurrentManagementLevel - Variable in class com.textkernel.tx.models.api.matching.request.FilterCriteria
-
-
Results must currently have at least one of the following management levels: - - None - Low - Mid - High -
-
-
CurrentManagementLevel - Variable in class com.textkernel.tx.models.resume.employment.ExperienceSummary
-
-
Computed level of management for the current position.
-
-
CurrentSalary - Variable in class com.textkernel.tx.models.resume.PersonalAttributes
-
-
The current salary listed on the resume
-
-
CustomData - Variable in class com.textkernel.tx.models.api.formatter.FormatResumeRequest
-
-
Any data that the template needs that is not in the extracted CV data.
-
-
CustomerDetails - Variable in class com.textkernel.tx.models.api.ApiResponseInfo
-
-
Information about the customer who made the API call
-
-
CustomInfo - Variable in class com.textkernel.tx.models.api.matching.ui.hooks.ServerSideHook
-
-
Any data from your system that you need to associate with this session/action.
-
-
- - - -

D

-
-
Data - Variable in class com.textkernel.tx.models.api.matching.ui.hooks.JsAction
-
-
Any data you want to be sent (in addition to document information) in the 'message' - parameter for the window.postMessage() call.
-
-
DataCenter - Class in com.textkernel.tx
-
-
Use either DataCenter.US or DataCenter.EU
-
-
DataCenter(String, String, boolean) - Constructor for class com.textkernel.tx.DataCenter
-
 
-
DataCenter(String) - Constructor for class com.textkernel.tx.DataCenter
-
-
Create a DataCenter for a self-hosted instance
-
-
DataMissing - Static variable in class com.textkernel.tx.models.resume.metadata.ResumeQualityLevel
-
-
Some data was missing that should be included in a resume
-
-
DataType - Variable in class com.textkernel.tx.models.api.parsing.FlexRequest
-
-
The data type for the reply
-
-
Date - Variable in class com.textkernel.tx.models.TxDate
-
-
The ISO 8601 (yyyy-MM-dd) date, if the day and/or month could not be found, they will be 01
-
-
DateOfBirth - Variable in class com.textkernel.tx.models.resume.PersonalAttributes
-
-
The date of birth given on the resume
-
-
Degree - Class in com.textkernel.tx.models.resume.education
-
-
An educational degree
-
-
Degree() - Constructor for class com.textkernel.tx.models.resume.education.Degree
-
 
-
Degree - Variable in class com.textkernel.tx.models.resume.education.EducationDetails
-
-
The degree obtained (or worked toward)
-
-
DegreeNames - Variable in class com.textkernel.tx.models.api.matching.request.FilterCriteria
-
-
Results must have at least one of the specified degree names.
-
-
Degrees - Variable in class com.textkernel.tx.models.job.ParsedJob
-
-
The educational degrees found listed in the job.
-
-
DegreeTypes - Variable in class com.textkernel.tx.models.api.matching.request.FilterCriteria
-
-
Results must have at least one of the specified degree types.
-
-
deleteDocument(String, String) - Method in class com.textkernel.tx.TxClient
-
-
Delete an existing document from an index
-
-
DeleteDocumentResponse - Class in com.textkernel.tx.models.api.indexes
-
-
The response body from a DeleteDocument API call
-
-
DeleteDocumentResponse() - Constructor for class com.textkernel.tx.models.api.indexes.DeleteDocumentResponse
-
 
-
deleteIndex(String) - Method in class com.textkernel.tx.TxClient
-
-
Delete an existing index.
-
-
DeleteIndexResponse - Class in com.textkernel.tx.models.api.indexes
-
-
The response body from a DeleteIndex API call
-
-
DeleteIndexResponse() - Constructor for class com.textkernel.tx.models.api.indexes.DeleteIndexResponse
-
 
-
deleteMultipleDocuments(String, List<String>) - Method in class com.textkernel.tx.TxClient
-
-
Delete a group of existing documents from an index
-
-
DeleteMultipleDocumentsResponse - Class in com.textkernel.tx.models.api.indexes
-
-
The response body from a DeleteMultipleDocuments API call
-
-
DeleteMultipleDocumentsResponse() - Constructor for class com.textkernel.tx.models.api.indexes.DeleteMultipleDocumentsResponse
-
 
-
Description - Variable in class com.textkernel.tx.models.api.dataenrichment.ontology.response.SkillScore
-
-
The description of the skill in the Skills Taxonomy.
-
-
Description - Variable in class com.textkernel.tx.models.api.dataenrichment.ontology.response.SuggestedProfession
-
-
The description of the profession in the Professions Taxonomy.
-
-
Description - Variable in class com.textkernel.tx.models.dataenrichment.BasicProfession
-
-
The description of the profession in the desired language.
-
-
Description - Variable in class com.textkernel.tx.models.dataenrichment.LangDescription
-
-
The description in the particular language.
-
-
Description - Variable in class com.textkernel.tx.models.dataenrichment.ProfessionClassification
-
-
The description of the profession concept.
-
-
Description - Variable in class com.textkernel.tx.models.dataenrichment.Skill
-
-
The description of the skill in the requested language.
-
-
Description - Variable in class com.textkernel.tx.models.resume.education.NormalizedDegree
-
-
One of the descriptions listed here.
-
-
Description - Variable in class com.textkernel.tx.models.resume.employment.ExperienceSummary
-
-
A paragraph of text that summarizes the candidate's experience.
-
-
Description - Variable in class com.textkernel.tx.models.resume.employment.Position
-
-
The job description
-
-
Description - Variable in class com.textkernel.tx.models.resume.employment.ProfessionClassification
-
-
The description of the profession concept.
-
-
Descriptions - Variable in class com.textkernel.tx.models.dataenrichment.ProfessionMultipleDescriptions
-
-
A list of descriptions of the skill in all supported/requested languages.
-
-
Descriptions - Variable in class com.textkernel.tx.models.dataenrichment.SkillMultipleDescriptions
-
-
A list of descriptions of the skill in all supported/requested languages.
-
-
deserialize(String, Class<T>) - Static method in class com.textkernel.tx.utilities.TxJsonSerializer
-
 
-
Desired - Variable in class com.textkernel.tx.models.api.matching.response.ManagementLevelScoreData
-
-
Requested management level.
-
-
DesiredTaxonomies - Variable in class com.textkernel.tx.models.api.matching.response.TaxonomiesScoreData
-
-
Taxonomies/industries requested.
-
-
DetectedType - Variable in class com.textkernel.tx.models.api.parsing.ConversionMetadata
-
-
The file type that was detected
-
-
Distance - Variable in class com.textkernel.tx.models.api.matching.request.LocationCriteria
-
-
The distance from LocationCriteria.Locations within which to find results.
-
-
DistanceUnit - Enum in com.textkernel.tx.models.api.matching.request
-
-
Units for distance
-
-
DistanceUnit - Variable in class com.textkernel.tx.models.api.matching.request.LocationCriteria
-
-
The units for the specified distance.
-
-
Document - Class in com.textkernel.tx.models
-
-
Represents an unparsed document (a file on the filesystem, byte[] from a database, etc)
-
-
Document(byte[], LocalDate) - Constructor for class com.textkernel.tx.models.Document
-
-
Create a Document from a file byte[]
-
-
Document(String) - Constructor for class com.textkernel.tx.models.Document
-
-
Create a Document from a file on the filesystem.
-
-
DocumentAsBase64String - Variable in class com.textkernel.tx.models.api.formatter.FormatResumeResponseValue
-
-
The formatted resume document (either PDF or DOCX).
-
-
DocumentAsBase64String - Variable in class com.textkernel.tx.models.api.parsing.ParseRequest
-
-
A Base64 encoded string of the document file bytes.
-
-
DocumentCulture - Variable in class com.textkernel.tx.models.ParsedDocumentMetadata
-
-
An ISO 3066 code that represents the cultural context of the document regarding formatting of - numbers, dates, character symbols, etc.
-
-
DocumentHash - Variable in class com.textkernel.tx.models.api.parsing.ConversionMetadata
-
-
The MD5 hash of the document bytes
-
-
DocumentId - Variable in class com.textkernel.tx.models.api.indexes.IndexedDocumentInfo
-
-
The id of the document (case-insensitive)
-
-
DocumentId - Variable in class com.textkernel.tx.models.api.indexes.IndexMultipleDocumentInfo
-
-
The id to assign to the new document.
-
-
DocumentId - Variable in class com.textkernel.tx.models.api.indexes.IndexMultipleDocumentsResponseValue
-
-
Id of the specific document represented in the response
-
-
DocumentIds - Variable in class com.textkernel.tx.models.api.matching.request.FilterCriteria
-
-
Results must have one of the specified document ids (case-insensitive).
-
-
DocumentLanguage - Variable in class com.textkernel.tx.models.ParsedDocumentMetadata
-
-
An ISO 639-1 code that represents the primary language of the parsed text.
-
-
DocumentLanguages - Variable in class com.textkernel.tx.models.api.matching.request.FilterCriteria
-
-
Results must be written in one of the specified languages.
-
-
DocumentLastModified - Variable in class com.textkernel.tx.models.api.parsing.ParseRequest
-
-
Mandatory date - in ISO 8601 (yyyy-MM-dd) format - so that the Parser knows how to interpret dates in the document - that are expressed as "current" or "as of" or similar.
-
-
DocumentLastModified - Variable in class com.textkernel.tx.models.ParsedDocumentMetadata
-
-
The last-revised/last-modified date that was provided for the document.
-
-
DocumentTaxonomies - Class in com.textkernel.tx.models.api.matching.response
-
-
Primary and secondary taxonomy (industry)
-
-
DocumentTaxonomies() - Constructor for class com.textkernel.tx.models.api.matching.response.DocumentTaxonomies
-
 
-
DriversLicenses - Variable in class com.textkernel.tx.models.job.ParsedJob
-
-
Any drivers license requirements
-
-
DrivingLicense - Variable in class com.textkernel.tx.models.resume.PersonalAttributes
-
-
A driving license listed on the resume
-
-
- - - -

E

-
-
Education - Variable in class com.textkernel.tx.models.api.matching.CategoryWeights
-
-
The weight of the Education category relative to other categories.
-
-
Education - Variable in class com.textkernel.tx.models.api.matching.response.EnrichedScoreData
-
-
Detailed match information for the Education category.
-
-
Education - Variable in class com.textkernel.tx.models.resume.ParsedResume
-
-
The candidate's education history found on the resume
-
-
EducationDetails - Class in com.textkernel.tx.models.resume.education
-
-
An education entry on a resume
-
-
EducationDetails() - Constructor for class com.textkernel.tx.models.resume.education.EducationDetails
-
 
-
EducationDetails - Variable in class com.textkernel.tx.models.resume.education.EducationHistory
-
-
All of the education details listed on a resume
-
-
EducationHasData - Variable in class com.textkernel.tx.models.api.matching.CategoryWeights
-
-
If false, the Education category has no data and should be ignored/hidden.
-
-
EducationHistory - Class in com.textkernel.tx.models.resume.education
-
-
Information about education history found on a resume
-
-
EducationHistory() - Constructor for class com.textkernel.tx.models.resume.education.EducationHistory
-
 
-
EducationNormalizationResponse - Variable in class com.textkernel.tx.models.api.parsing.ParseResumeResponseValue
-
-
Information about the status of education normalization during the parse
-
-
EducationScoreData - Class in com.textkernel.tx.models.api.matching.response
-
-
Details about the score for the Education category
-
-
EducationScoreData() - Constructor for class com.textkernel.tx.models.api.matching.response.EducationScoreData
-
 
-
ElapsedMilliseconds - Variable in class com.textkernel.tx.models.api.parsing.ConversionMetadata
-
-
How long the document conversion took, in milliseconds.
-
-
ElapsedMilliseconds - Variable in class com.textkernel.tx.models.api.parsing.ParsingMetadata
-
-
How long it took to parse the document, in milliseconds.
-
-
EmailAddresses - Variable in class com.textkernel.tx.models.resume.CandidateReference
-
-
Email addresses listed for the reference
-
-
EmailAddresses - Variable in class com.textkernel.tx.models.resume.contactinfo.ContactInformation
-
-
The candidate's email addresses
-
-
EmailAddresses - Variable in class com.textkernel.tx.models.resume.metadata.ReservedData
-
-
All email addresses found in the resume
-
-
Employer - Class in com.textkernel.tx.models.resume.employment
-
-
A name/location for a company/employer
-
-
Employer() - Constructor for class com.textkernel.tx.models.resume.employment.Employer
-
 
-
Employer - Variable in class com.textkernel.tx.models.resume.employment.Position
-
-
The employer/company for this position.
-
-
EmployerDescription - Variable in class com.textkernel.tx.models.job.ParsedJob
-
-
Full text of any employer description listed by the job.
-
-
EmployerName - Variable in class com.textkernel.tx.models.job.EmployerNames
-
-
All employer names found in a job description
-
-
EmployerNames - Class in com.textkernel.tx.models.job
-
-
Names of employers found in a job description
-
-
EmployerNames() - Constructor for class com.textkernel.tx.models.job.EmployerNames
-
 
-
EmployerNames - Variable in class com.textkernel.tx.models.job.ParsedJob
-
-
The employer names found in the job.
-
-
Employers - Variable in class com.textkernel.tx.models.api.matching.request.FilterCriteria
-
-
Results must have at least one of the specified employers.
-
-
EmployersMustAllBeCurrentEmployer - Variable in class com.textkernel.tx.models.api.matching.request.FilterCriteria
-
-
When true, at least one employer in FilterCriteria.Employers must be found in the current time frame.
-
-
EmploymentHistory - Class in com.textkernel.tx.models.resume.employment
-
-
Work history found on a resume
-
-
EmploymentHistory() - Constructor for class com.textkernel.tx.models.resume.employment.EmploymentHistory
-
 
-
EmploymentHistory - Variable in class com.textkernel.tx.models.resume.ParsedResume
-
-
The candidate's employment/work history found on the resume
-
-
EmploymentType - Variable in class com.textkernel.tx.models.job.ParsedJob
-
-
The type of employment.
-
-
EndDate - Variable in class com.textkernel.tx.models.job.ParsedJob
-
-
The end date for the job, if listed.
-
-
EndDate - Variable in class com.textkernel.tx.models.resume.education.EducationDetails
-
-
The date graduated or education ended
-
-
EndDate - Variable in class com.textkernel.tx.models.resume.employment.Position
-
-
The end date listed for this position
-
-
EndDate - Variable in class com.textkernel.tx.models.resume.military.MilitaryDetails
-
-
The end date for this post/job
-
-
EndDate - Variable in class com.textkernel.tx.models.resume.TrainingDetails
-
-
The date the training ended
-
-
EndSpan - Variable in class com.textkernel.tx.models.dataenrichment.SkillMatch
-
-
The index of the last character of the match (0-based).
-
-
EngineVersion - Variable in class com.textkernel.tx.models.api.ApiResponseInfo
-
-
The version of the parsing engine
-
-
EnrichedRCSScoreData - Variable in class com.textkernel.tx.models.api.bimetricscoring.BimetricScoreResult
-
-
Detailed information/evidence about the BimetricScoreResult.ReverseCompatibilityScore
-
-
EnrichedRCSScoreData - Variable in class com.textkernel.tx.models.api.matching.response.MatchResult
-
-
Detailed information/evidence about the MatchResult.ReverseCompatibilityScore
-
-
EnrichedScoreData - Variable in class com.textkernel.tx.models.api.bimetricscoring.BimetricScoreResult
-
-
Detailed information/evidence about the BimetricScoreResult.WeightedScore
-
-
EnrichedScoreData - Class in com.textkernel.tx.models.api.matching.response
-
-
Contains metadata/evidence about scores for a specific match/score result
-
-
EnrichedScoreData() - Constructor for class com.textkernel.tx.models.api.matching.response.EnrichedScoreData
-
 
-
EnrichedScoreData - Variable in class com.textkernel.tx.models.api.matching.response.MatchResult
-
-
Detailed information/evidence about the MatchResult.WeightedScore
-
-
Entity - Variable in class com.textkernel.tx.models.resume.TrainingDetails
-
-
The name of the school or company where the training occurred.
-
-
EnumerationValues - Variable in class com.textkernel.tx.models.api.parsing.FlexRequest
-
-
If DataType is FlexRequestDataType.Enumeration, this is the list of possible replies.
-
-
EU - Static variable in class com.textkernel.tx.DataCenter
-
-
Represents the EU datacenter.
-
-
Evidence - Variable in class com.textkernel.tx.models.api.matching.response.CategoryScoreData
-
-
Detailed written explanation about each data point found or not found.
-
-
ExclusiveSkillsByProfession - Variable in class com.textkernel.tx.models.api.dataenrichment.ontology.response.CompareProfessionsResponseValue
-
-
A list of exclusive skills per profession.
-
-
ExecuteImmediately - Variable in class com.textkernel.tx.models.api.matching.ui.UIOptions
-
-
true to execute the query as soon as the page loads (default = false).
-
-
ExecutiveType - Variable in class com.textkernel.tx.models.api.matching.CategoryWeights
-
-
The weight of the ExecutiveType category relative to other categories.
-
-
ExecutiveType - Variable in class com.textkernel.tx.models.api.matching.request.FilterCriteria
-
-
Results must have at least one of the following types of executive experience: - - None - Executive - Admin - Accounting - Operations - Financial - Marketing - Business_Dev - IT - General - Learning -
-
-
ExecutiveType - Variable in class com.textkernel.tx.models.api.matching.response.EnrichedScoreData
-
-
Detailed match information for the ExecutiveType category.
-
-
ExecutiveType - Variable in class com.textkernel.tx.models.job.ParsedJob
-
-
What kind of executive position the job is, if any.
-
-
ExecutiveType - Variable in class com.textkernel.tx.models.resume.employment.ExperienceSummary
-
-
If ExperienceSummary.ManagementScore is at least 30 (mid-level+), then the job titles are examined to - determine the best category for the executive experience.
-
-
ExecutiveTypeHasData - Variable in class com.textkernel.tx.models.api.matching.CategoryWeights
-
-
If false, the ExecutiveType category has no data and should be ignored/hidden.
-
-
ExistsInText - Variable in class com.textkernel.tx.models.skills.Skill
-
-
Whether or not this skill was found verbatim in the text
-
-
ExpectedEducation - Variable in class com.textkernel.tx.models.api.matching.response.EducationScoreData
-
-
Requested level of education.
-
-
ExperienceLevel - Variable in class com.textkernel.tx.models.api.matching.request.SkillFilter
-
-
The experience level of the skill
-
-
ExperienceSummary - Variable in class com.textkernel.tx.models.resume.employment.EmploymentHistory
-
-
A summary of all the work history with important calculated metadata
-
-
ExperienceSummary - Class in com.textkernel.tx.models.resume.employment
-
-
A summary of a candidate's work history
-
-
ExperienceSummary() - Constructor for class com.textkernel.tx.models.resume.employment.ExperienceSummary
-
 
-
ExpirationDate - Variable in class com.textkernel.tx.models.api.AccountInfo
-
-
The date that the current credits expire
-
-
expires_in - Variable in class com.textkernel.tx.models.api.matching.ui.GenerateUIResponse
-
-
The number of seconds until the URL auto-authentication expires.
-
-
ExtractedSkill - Class in com.textkernel.tx.models.dataenrichment
-
-
An extracted, normalized skill from the Skills taxonomy.
-
-
ExtractedSkill() - Constructor for class com.textkernel.tx.models.dataenrichment.ExtractedSkill
-
 
-
extractSkills(String, String, String, float) - Method in class com.textkernel.tx.TxClient
-
-
Extracts known skills from the given text.
-
-
extractSkills(String) - Method in class com.textkernel.tx.TxClient
-
-
Extracts known skills from the given text.
-
-
ExtractSkillsRequest - Class in com.textkernel.tx.models.api.dataenrichment.skills.request
-
-
Request body for a 'ExtractSkills' request
-
-
ExtractSkillsRequest() - Constructor for class com.textkernel.tx.models.api.dataenrichment.skills.request.ExtractSkillsRequest
-
 
-
ExtractSkillsResponse - Class in com.textkernel.tx.models.api.dataenrichment.skills.response
-
-
The response body from a ExtractSkills API call
-
-
ExtractSkillsResponse() - Constructor for class com.textkernel.tx.models.api.dataenrichment.skills.response.ExtractSkillsResponse
-
 
-
ExtractSkillsResponseValue - Class in com.textkernel.tx.models.api.dataenrichment.skills.response
-
-
One entry in the ApiResponse.Value from a 'ExtractSkills' response
-
-
ExtractSkillsResponseValue() - Constructor for class com.textkernel.tx.models.api.dataenrichment.skills.response.ExtractSkillsResponseValue
-
 
-
extractSkillsV2(String, String, String, float) - Method in class com.textkernel.tx.TxClient
-
-
Extracts known skills from the given text.
-
-
extractSkillsV2(String) - Method in class com.textkernel.tx.TxClient
-
-
Extracts known skills from the given text.
-
-
- - - -

F

-
-
Facebook - Static variable in class com.textkernel.tx.models.resume.contactinfo.WebAddressType
-
-
A Facebook profile URL
-
-
Fact - Variable in class com.textkernel.tx.models.api.matching.response.CategoryScoreEvidence
-
-
Information regarding the outcome of one or more of the data points in the query.
-
-
FamilyComposition - Variable in class com.textkernel.tx.models.resume.PersonalAttributes
-
-
The family composition
-
-
FamilyName - Variable in class com.textkernel.tx.models.resume.contactinfo.PersonName
-
-
The family (last) name
-
-
FatalProblem - Static variable in class com.textkernel.tx.models.resume.metadata.ResumeQualityLevel
-
-
A fatal issue was found in the resume.
-
-
FathersName - Variable in class com.textkernel.tx.models.resume.PersonalAttributes
-
-
The candidate's father's name listed on the resume
-
-
FilterCriteria - Class in com.textkernel.tx.models.api.matching.request
-
-
Criteria for filtering search/match results
-
-
FilterCriteria() - Constructor for class com.textkernel.tx.models.api.matching.request.FilterCriteria
-
 
-
FilterCriteria - Variable in class com.textkernel.tx.models.api.matching.request.SearchMatchRequestBase
-
-
Required criteria for the result set.
-
-
FilterId - Variable in class com.textkernel.tx.models.api.matching.ui.FilterToShow
-
-
One of: - - JOB_TITLES - EXPERIENCE - SKILLS - INDUSTRIES - BOOLEAN - LANGUAGES - CERTIFICATIONS - EXECUTIVE_TYPES - LOCATION - EDUCATION - EMPLOYERS - TAGS - METADATA - UNCOMMON -
-
-
FilterLocation - Class in com.textkernel.tx.models.api.matching.request
-
-
A location used for filtering results by exact location or radius searching
-
-
FilterLocation() - Constructor for class com.textkernel.tx.models.api.matching.request.FilterLocation
-
 
-
FiltersToShow - Variable in class com.textkernel.tx.models.api.matching.ui.UIOptions
-
-
If specified, only allows the user to see/modify certain filter categories.
-
-
FilterToShow - Class in com.textkernel.tx.models.api.matching.ui
-
-
Used to change the order or titles of the filters in the Matching UI
-
-
FilterToShow() - Constructor for class com.textkernel.tx.models.api.matching.ui.FilterToShow
-
 
-
Findings - Variable in class com.textkernel.tx.models.resume.metadata.ResumeQualityAssessment
-
-
A list of findings of the same severity/level
-
-
FirstLineNumber - Variable in class com.textkernel.tx.models.resume.metadata.ResumeSection
-
-
The first line of the section (zero-based).
-
-
FlexRequest - Class in com.textkernel.tx.models.api.parsing
-
-
Custom requests to ask during parsing.
-
-
FlexRequest() - Constructor for class com.textkernel.tx.models.api.parsing.FlexRequest
-
 
-
FlexRequestDataType - Enum in com.textkernel.tx.models.api.parsing
-
-
Possible data types for FlexRequests
-
-
FlexRequests - Variable in class com.textkernel.tx.models.api.parsing.ParseOptions
-
-
Only used for resumes.
-
-
FlexResponse - Class in com.textkernel.tx.models.api.parsing
-
-
Information about the FlexRequests transaction, if any were provided.
-
-
FlexResponse() - Constructor for class com.textkernel.tx.models.api.parsing.FlexResponse
-
 
-
FlexResponse - Variable in class com.textkernel.tx.models.api.parsing.ParseResumeResponseValue
-
-
Information about the FlexRequests transaction, if any were provided.
-
-
FlexResponseItem - Class in com.textkernel.tx.models.api.parsing
-
-
Responses to FlexRequests
-
-
FlexResponseItem() - Constructor for class com.textkernel.tx.models.api.parsing.FlexResponseItem
-
 
-
FontFamily - Variable in class com.textkernel.tx.models.api.matching.ui.Style
-
-
A CSS font-family to use for all UI elements.
-
-
FontUrl - Variable in class com.textkernel.tx.models.api.matching.ui.Style
-
-
If you'd like to use a non-standard font, specify the URL where that font can be downloaded here.
-
-
formatResume(FormatResumeRequest) - Method in class com.textkernel.tx.TxClient
-
-
Format a resume into a standardized template that you provide
-
-
FormatResumeRequest - Class in com.textkernel.tx.models.api.formatter
-
-
Request body for the Format Resume With Template endpoint
-
-
FormatResumeRequest(ParsedResume, String, OutputDocumentFormat) - Constructor for class com.textkernel.tx.models.api.formatter.FormatResumeRequest
-
-
Creates a request to use when calling the Resume Formatter endpoint with a provided template document.
-
-
FormatResumeRequest(ParsedResume, byte[], OutputDocumentFormat) - Constructor for class com.textkernel.tx.models.api.formatter.FormatResumeRequest
-
-
Creates a request to use when calling the Resume Formatter endpoint with a provided template document.
-
-
FormatResumeResponse - Class in com.textkernel.tx.models.api.formatter
-
-
The response body for a Format Resume API call
-
-
FormatResumeResponse() - Constructor for class com.textkernel.tx.models.api.formatter.FormatResumeResponse
-
 
-
FormatResumeResponseValue - Class in com.textkernel.tx.models.api.formatter
-
-
The ApiResponse.Value from a Format Resume response
-
-
FormatResumeResponseValue() - Constructor for class com.textkernel.tx.models.api.formatter.FormatResumeResponseValue
-
 
-
FormattedName - Variable in class com.textkernel.tx.models.resume.contactinfo.PersonName
-
-
The full name in a standard format
-
-
Found - Variable in class com.textkernel.tx.models.api.matching.response.JobTitlesScoreData
-
-
List of job titles found in both documents.
-
-
Found - Variable in class com.textkernel.tx.models.api.matching.response.SimpleCategoryScoreData
-
-
List of terms found in both source and target documents
-
-
Found - Variable in class com.textkernel.tx.models.api.matching.response.SkillsScoreData
-
-
List of skills found in both source and target documents
-
-
FoundDay - Variable in class com.textkernel.tx.models.TxDate
-
-
true if the day was found in the text (eg: June 7, 2020), otherwise false (eg: June 2020)
-
-
FoundIn - Variable in class com.textkernel.tx.models.resume.skills.ResumeNormalizedSkill
-
-
Where the skill was found
-
-
FoundIn - Variable in class com.textkernel.tx.models.resume.skills.ResumeRawSkill
-
-
Where the skill was found
-
-
FoundIn - Variable in class com.textkernel.tx.models.resume.skills.ResumeSkillVariation
-
-
Where the skill was found
-
-
FoundInContext - Variable in class com.textkernel.tx.models.resume.Association
-
-
The full text in which this association was found
-
-
FoundInContext - Variable in class com.textkernel.tx.models.resume.LanguageCompetency
-
-
The full text where this language competency was found
-
-
FoundInContext - Variable in class com.textkernel.tx.models.resume.military.MilitaryDetails
-
-
The full text where this military post/job was found in the resume
-
-
FoundInContext - Variable in class com.textkernel.tx.models.resume.military.SecurityCredential
-
-
The full context of where this clearance/credential was found
-
-
FoundJobTitle - Class in com.textkernel.tx.models.api.matching.response
-
-
Information about a job title match
-
-
FoundJobTitle() - Constructor for class com.textkernel.tx.models.api.matching.response.FoundJobTitle
-
 
-
FoundMonth - Variable in class com.textkernel.tx.models.TxDate
-
-
true if the month was found in the text (eg: June 2020), otherwise false (eg: 2020)
-
-
FoundSections - Variable in class com.textkernel.tx.models.resume.metadata.ResumeMetadata
-
-
A list of sections found in the resume
-
-
FoundSkill - Class in com.textkernel.tx.models.api.matching.response
-
-
Information about a skill match
-
-
FoundSkill() - Constructor for class com.textkernel.tx.models.api.matching.response.FoundSkill
-
 
-
FoundSubTaxonomy - Class in com.textkernel.tx.models.skills
-
-
A subtaxonomy to group similar skills
-
-
FoundSubTaxonomy() - Constructor for class com.textkernel.tx.models.skills.FoundSubTaxonomy
-
 
-
FoundTaxonomy<T> - Class in com.textkernel.tx.models.skills
-
-
A container to group similar skills subtaxonomies (see SubTaxonomy)
-
-
FoundTaxonomy() - Constructor for class com.textkernel.tx.models.skills.FoundTaxonomy
-
 
-
FoundYear - Variable in class com.textkernel.tx.models.TxDate
-
-
true if the year was found in the text, otherwise false
-
-
fromFile(String) - Static method in class com.textkernel.tx.models.job.ParsedJob
-
-
Load a parsed job from a json file using UTF-8 encoding.
-
-
fromFile(String) - Static method in class com.textkernel.tx.models.resume.ParsedResume
-
-
Load a parsed resume from a json file using UTF-8 encoding.
-
-
fromJson(String) - Static method in class com.textkernel.tx.models.job.ParsedJob
-
-
Create a parsed job from json.
-
-
fromJson(String) - Static method in class com.textkernel.tx.models.resume.ParsedResume
-
-
Create a parsed resume from json.
-
-
FulltimeDirectHirePredictiveIndex - Variable in class com.textkernel.tx.models.resume.employment.ExperienceSummary
-
-
A score (0-100), where 0 means a candidate is more likely to have had (and want/pursue) short-term/part-time/temp/contracting - jobs and 100 means a candidate is more likely to have had (and want/pursue) traditional full-time, direct-hire jobs.
-
-
- - - -

G

-
-
Gab - Static variable in class com.textkernel.tx.models.resume.contactinfo.WebAddressType
-
-
A Gab username
-
-
Gender - Variable in class com.textkernel.tx.models.resume.PersonalAttributes
-
-
The candidate's gender listed on the resume
-
-
generateJobDescription(GenerateJobRequest) - Method in class com.textkernel.tx.TxClient
-
-
Generates a job description based on specified parameters.
-
-
GenerateJobRequest - Class in com.textkernel.tx.models.api.jobdescription
-
 
-
GenerateJobRequest() - Constructor for class com.textkernel.tx.models.api.jobdescription.GenerateJobRequest
-
 
-
GenerateJobResponse - Class in com.textkernel.tx.models.api.jobdescription
-
 
-
GenerateJobResponse() - Constructor for class com.textkernel.tx.models.api.jobdescription.GenerateJobResponse
-
 
-
GenerateJobResponseValue - Class in com.textkernel.tx.models.api.jobdescription
-
-
The ApiResponse.Value from a 'Generate Job' response
-
-
GenerateJobResponseValue() - Constructor for class com.textkernel.tx.models.api.jobdescription.GenerateJobResponseValue
-
 
-
GenerateJobSkill - Class in com.textkernel.tx.models.api.jobdescription
-
 
-
GenerateJobSkill() - Constructor for class com.textkernel.tx.models.api.jobdescription.GenerateJobSkill
-
 
-
GenerateUIRequest<T> - Class in com.textkernel.tx.models.api.matching.ui.request
-
-
The request body for generating a Matching UI session
-
-
GenerateUIRequest(T, MatchUISettings) - Constructor for class com.textkernel.tx.models.api.matching.ui.request.GenerateUIRequest
-
 
-
GenerateUIResponse - Class in com.textkernel.tx.models.api.matching.ui
-
-
The response body from a request to generate the Matching UI
-
-
GenerateUIResponse() - Constructor for class com.textkernel.tx.models.api.matching.ui.GenerateUIResponse
-
 
-
geocode(ParsedResume, GeocodeCredentials) - Method in class com.textkernel.tx.TxClient
-
-
Uses the address in the resume (if present) to look up geocoordinates and add them into the ParsedResume object.
-
-
geocode(ParsedResume, Address, GeocodeCredentials) - Method in class com.textkernel.tx.TxClient
-
-
Use this if you would like to provide an address for geocoding instead of using the one in the parsed - resume.
-
-
geocode(ParsedJob, GeocodeCredentials) - Method in class com.textkernel.tx.TxClient
-
-
Uses the address in the job (if present) to look up geocoordinates and add them into the ParsedJob object.
-
-
geocode(ParsedJob, Address, GeocodeCredentials) - Method in class com.textkernel.tx.TxClient
-
-
Use this if you would like to provide an address for geocoding instead of using the one in the parsed - job.
-
-
geocodeAndIndex(ParsedResume, IndexSingleDocumentInfo, boolean, GeocodeCredentials) - Method in class com.textkernel.tx.TxClient
-
-
Uses the address in the resume (if present) to look up geocoordinates and add them into the ParsedResume object.
-
-
geocodeAndIndex(ParsedResume, IndexSingleDocumentInfo, Address, boolean, GeocodeCredentials) - Method in class com.textkernel.tx.TxClient
-
-
Use this if you would like to provide an address for geocoding instead of using the one in the parsed - resume.
-
-
geocodeAndIndex(ParsedResume, IndexSingleDocumentInfo, GeoCoordinates, boolean, GeocodeCredentials) - Method in class com.textkernel.tx.TxClient
-
-
Use this if you already have latitude/longitude coordinates and simply wish to add them to your parsed resume.
-
-
geocodeAndIndex(ParsedJob, IndexSingleDocumentInfo, boolean, GeocodeCredentials) - Method in class com.textkernel.tx.TxClient
-
-
Uses the address in the job (if present) to look up geocoordinates and add them into the ParsedJob object.
-
-
geocodeAndIndex(ParsedJob, IndexSingleDocumentInfo, Address, boolean, GeocodeCredentials) - Method in class com.textkernel.tx.TxClient
-
-
Use this if you would like to provide an address for geocoding instead of using the one in the parsed - rjobesume.
-
-
geocodeAndIndex(ParsedJob, IndexSingleDocumentInfo, GeoCoordinates, boolean, GeocodeCredentials) - Method in class com.textkernel.tx.TxClient
-
-
Use this if you already have latitude/longitude coordinates and simply wish to add them to your parsed job.
-
-
GeocodeAndIndexJobRequest - Class in com.textkernel.tx.models.api.geocoding
-
-
Request body for geocoding a job and then adding into an index
-
-
GeocodeAndIndexJobRequest() - Constructor for class com.textkernel.tx.models.api.geocoding.GeocodeAndIndexJobRequest
-
 
-
GeocodeAndIndexJobResponse - Class in com.textkernel.tx.models.api.geocoding
-
-
The response body from a GeocodeAndIndexJob API call
-
-
GeocodeAndIndexJobResponse() - Constructor for class com.textkernel.tx.models.api.geocoding.GeocodeAndIndexJobResponse
-
 
-
GeocodeAndIndexJobResponseValue - Class in com.textkernel.tx.models.api.geocoding
-
-
The ApiResponse.Value from a 'geocode and index' response
-
-
GeocodeAndIndexJobResponseValue() - Constructor for class com.textkernel.tx.models.api.geocoding.GeocodeAndIndexJobResponseValue
-
 
-
GeocodeAndIndexRequest - Class in com.textkernel.tx.models.api.geocoding
-
-
Request body for geocoding a document and then adding into an index
-
-
GeocodeAndIndexRequest() - Constructor for class com.textkernel.tx.models.api.geocoding.GeocodeAndIndexRequest
-
 
-
GeocodeAndIndexResponseValue - Class in com.textkernel.tx.models.api.geocoding
-
-
The ApiResponse.Value from a 'geocode and index' response
-
-
GeocodeAndIndexResponseValue() - Constructor for class com.textkernel.tx.models.api.geocoding.GeocodeAndIndexResponseValue
-
 
-
GeocodeAndIndexResumeRequest - Class in com.textkernel.tx.models.api.geocoding
-
-
Request body for geocoding a resume and then adding into an index
-
-
GeocodeAndIndexResumeRequest() - Constructor for class com.textkernel.tx.models.api.geocoding.GeocodeAndIndexResumeRequest
-
 
-
GeocodeAndIndexResumeResponse - Class in com.textkernel.tx.models.api.geocoding
-
-
The response body from a GeocodeAndIndexResume API call
-
-
GeocodeAndIndexResumeResponse() - Constructor for class com.textkernel.tx.models.api.geocoding.GeocodeAndIndexResumeResponse
-
 
-
GeocodeAndIndexResumeResponseValue - Class in com.textkernel.tx.models.api.geocoding
-
-
The ApiResponse.Value from a 'geocode and index' response
-
-
GeocodeAndIndexResumeResponseValue() - Constructor for class com.textkernel.tx.models.api.geocoding.GeocodeAndIndexResumeResponseValue
-
 
-
GeocodeCredentials - Class in com.textkernel.tx.models.api.geocoding
-
-
Credentials for geocoding
-
-
GeocodeCredentials() - Constructor for class com.textkernel.tx.models.api.geocoding.GeocodeCredentials
-
 
-
GeocodedCoordinates - Class in com.textkernel.tx.models
-
-
Represents a lat/lon provided by a 3rd party service
-
-
GeocodedCoordinates() - Constructor for class com.textkernel.tx.models.GeocodedCoordinates
-
 
-
GeocodeJobRequest - Class in com.textkernel.tx.models.api.geocoding
-
-
Options for geocoding a job (specifying some location on Earth)
-
-
GeocodeJobRequest() - Constructor for class com.textkernel.tx.models.api.geocoding.GeocodeJobRequest
-
 
-
GeocodeJobResponse - Class in com.textkernel.tx.models.api.geocoding
-
-
The response body from a GeocodeJob API call
-
-
GeocodeJobResponse() - Constructor for class com.textkernel.tx.models.api.geocoding.GeocodeJobResponse
-
 
-
GeocodeJobResponseValue - Class in com.textkernel.tx.models.api.geocoding
-
-
The ApiResponse.Value from a 'geocode job' response
-
-
GeocodeJobResponseValue() - Constructor for class com.textkernel.tx.models.api.geocoding.GeocodeJobResponseValue
-
 
-
GeocodeOptions - Variable in class com.textkernel.tx.models.api.geocoding.GeocodeAndIndexRequest
-
-
Geocoding settings
-
-
GeocodeOptions - Class in com.textkernel.tx.models.api.geocoding
-
-
Options for geocoding a document (specifying some location on Earth)
-
-
GeocodeOptions() - Constructor for class com.textkernel.tx.models.api.geocoding.GeocodeOptions
-
 
-
GeocodeOptions - Variable in class com.textkernel.tx.models.api.matching.ui.request.MatchUISettings
-
-
Settings for geocoding within the Matching UI.
-
-
GeocodeOptions - Variable in class com.textkernel.tx.models.api.parsing.ParseOptions
-
-
Use this property to also include geocoding in this parse request.
-
-
GeocodeOptionsBase - Class in com.textkernel.tx.models.api.geocoding
-
-
Options for geocoding a document (specifying some location on Earth)
-
-
GeocodeOptionsBase() - Constructor for class com.textkernel.tx.models.api.geocoding.GeocodeOptionsBase
-
 
-
GeocodeProvider - Enum in com.textkernel.tx.models.api.geocoding
-
-
Geocode service providers
-
-
GeocodeProvider - Variable in class com.textkernel.tx.models.api.matching.request.LocationCriteria
-
-
The provider to lookup latitude/longitude if they are not specified.
-
-
GeocodeProviderKey - Variable in class com.textkernel.tx.models.api.matching.request.LocationCriteria
-
-
Your private API key for the geocoding provider.
-
-
GeocodeResponse - Variable in class com.textkernel.tx.models.api.geocoding.GeocodeAndIndexResponseValue
-
-
If geocoding was requested, the status of the geocode transaction will be output here
-
-
GeocodeResponse - Variable in class com.textkernel.tx.models.api.parsing.BaseParseResponseValue
-
-
If geocoding was requested in the ParseOptions.GeocodeOptions, - the status of the geocode transaction will be output here
-
-
GeocodeResumeRequest - Class in com.textkernel.tx.models.api.geocoding
-
-
Options for geocoding a resume (specifying some location on Earth)
-
-
GeocodeResumeRequest() - Constructor for class com.textkernel.tx.models.api.geocoding.GeocodeResumeRequest
-
 
-
GeocodeResumeResponse - Class in com.textkernel.tx.models.api.geocoding
-
-
The response body from a GeocodeResume API call
-
-
GeocodeResumeResponse() - Constructor for class com.textkernel.tx.models.api.geocoding.GeocodeResumeResponse
-
 
-
GeocodeResumeResponseValue - Class in com.textkernel.tx.models.api.geocoding
-
-
The ApiResponse.Value from a 'geocode resume' response
-
-
GeocodeResumeResponseValue() - Constructor for class com.textkernel.tx.models.api.geocoding.GeocodeResumeResponseValue
-
 
-
GeoCoordinates - Variable in class com.textkernel.tx.models.api.geocoding.GeocodeOptionsBase
-
-
The geographic coordinates (latitude/longitude) for your postal address.
-
-
GeoCoordinates - Class in com.textkernel.tx.models
-
-
Represents a lat/lon
-
-
GeoCoordinates() - Constructor for class com.textkernel.tx.models.GeoCoordinates
-
 
-
GeoCoordinates - Variable in class com.textkernel.tx.models.Location
-
-
If geocoding has been done, this is the lat/lon for the location
-
-
GeoPoint - Variable in class com.textkernel.tx.models.api.matching.request.FilterLocation
-
-
The geocordinates to be used in the location
-
-
getAccountInfo() - Method in class com.textkernel.tx.TxClient
-
-
Get the account info (remaining credits, max concurrency, etc).
-
-
GetAccountInfoResponse - Class in com.textkernel.tx.models.api.account
-
-
The response body from a GetAccount API call
-
-
GetAccountInfoResponse() - Constructor for class com.textkernel.tx.models.api.account.GetAccountInfoResponse
-
 
-
getAllIndexes() - Method in class com.textkernel.tx.TxClient
-
-
Get all existing indexes
-
-
GetAllIndexesResponse - Class in com.textkernel.tx.models.api.indexes
-
-
The response body from a GetAllIndexes API call
-
-
GetAllIndexesResponse() - Constructor for class com.textkernel.tx.models.api.indexes.GetAllIndexesResponse
-
 
-
getAsBase64() - Method in class com.textkernel.tx.models.Document
-
 
-
getData() - Method in class com.textkernel.tx.http.HttpResponse
-
 
-
getDefaults() - Static method in class com.textkernel.tx.models.skills.Taxonomy
-
 
-
getDocId() - Method in interface com.textkernel.tx.models.api.bimetricscoring.IParsedDocWithId
-
 
-
getDocId() - Method in class com.textkernel.tx.models.api.bimetricscoring.ParsedJobWithId
-
 
-
getDocId() - Method in class com.textkernel.tx.models.api.bimetricscoring.ParsedResumeWithId
-
 
-
GetIndexResponse - Class in com.textkernel.tx.models.api.indexes
-
-
The response body from a GetIndex API call
-
-
GetIndexResponse() - Constructor for class com.textkernel.tx.models.api.indexes.GetIndexResponse
-
 
-
getInfo() - Method in class com.textkernel.tx.models.api.ApiResponse
-
getInfo() - Method in interface com.textkernel.tx.models.api.ITxResponse
-
 
-
getJob(String, String) - Method in class com.textkernel.tx.TxClient
-
-
Retrieve an existing job from an index
-
-
GetJobResponse - Class in com.textkernel.tx.models.api.indexes
-
-
The response body from a GetJob API call
-
-
GetJobResponse() - Constructor for class com.textkernel.tx.models.api.indexes.GetJobResponse
-
 
-
GetMetadataResponse - Class in com.textkernel.tx.models.api.dataenrichment
-
-
The response body from a GetMetadata API call
-
-
GetMetadataResponse() - Constructor for class com.textkernel.tx.models.api.dataenrichment.GetMetadataResponse
-
 
-
getProfessionsTaxonomy(String, TaxonomyFormat) - Method in class com.textkernel.tx.TxClient
-
-
Get all professions in the taxonomy with associated IDs and descriptions in all supported languages.
-
-
getProfessionsTaxonomy() - Method in class com.textkernel.tx.TxClient
-
-
Get all professions in the taxonomy with associated IDs and descriptions in all supported languages.
-
-
getProfessionsTaxonomyMetadata() - Method in class com.textkernel.tx.TxClient
-
-
Get metadata about the professions taxonomy/service.
-
-
GetProfessionsTaxonomyResponse - Class in com.textkernel.tx.models.api.dataenrichment.professions.response
-
-
The response body from a GetProfessionsTaxonomy API call
-
-
GetProfessionsTaxonomyResponse() - Constructor for class com.textkernel.tx.models.api.dataenrichment.professions.response.GetProfessionsTaxonomyResponse
-
 
-
GetProfessionsTaxonomyResponseValue - Class in com.textkernel.tx.models.api.dataenrichment.professions.response
-
-
One entry in the ApiResponse.Value from a 'GetProfessionsTaxonomy' response
-
-
GetProfessionsTaxonomyResponseValue() - Constructor for class com.textkernel.tx.models.api.dataenrichment.professions.response.GetProfessionsTaxonomyResponseValue
-
 
-
getResponse() - Method in class com.textkernel.tx.http.HttpResponse
-
 
-
getResume(String, String) - Method in class com.textkernel.tx.TxClient
-
-
Retrieve an existing resume from an index
-
-
GetResumeResponse - Class in com.textkernel.tx.models.api.indexes
-
-
The response body from a GetResume API call
-
-
GetResumeResponse() - Constructor for class com.textkernel.tx.models.api.indexes.GetResumeResponse
-
 
-
getSkillsTaxonomy(TaxonomyFormat) - Method in class com.textkernel.tx.TxClient
-
-
Get all skills in the taxonomy with associated IDs and descriptions in all supported languages.
-
-
getSkillsTaxonomy() - Method in class com.textkernel.tx.TxClient
-
-
Get all skills in the taxonomy with associated IDs and descriptions in all supported languages.
-
-
getSkillsTaxonomyMetadata() - Method in class com.textkernel.tx.TxClient
-
-
Get metadata about the skills taxonomy/service.
-
-
getSkillsTaxonomyMetadataV2() - Method in class com.textkernel.tx.TxClient
-
-
Get metadata about the skills taxonomy/service.
-
-
GetSkillsTaxonomyResponse - Class in com.textkernel.tx.models.api.dataenrichment.skills.response
-
-
The response body from a GetSkillsTaxonomy API call
-
-
GetSkillsTaxonomyResponse() - Constructor for class com.textkernel.tx.models.api.dataenrichment.skills.response.GetSkillsTaxonomyResponse
-
 
-
GetSkillsTaxonomyResponseValue - Class in com.textkernel.tx.models.api.dataenrichment.skills.response
-
-
One entry in the ApiResponse.Value from a 'GetSkillsTaxonomy' response
-
-
GetSkillsTaxonomyResponseValue() - Constructor for class com.textkernel.tx.models.api.dataenrichment.skills.response.GetSkillsTaxonomyResponseValue
-
 
-
getSkillsTaxonomyV2(TaxonomyFormat) - Method in class com.textkernel.tx.TxClient
-
-
Get all skills in the taxonomy with associated IDs and descriptions in all supported languages.
-
-
getSkillsTaxonomyV2() - Method in class com.textkernel.tx.TxClient
-
-
Get all skills in the taxonomy with associated IDs and descriptions in all supported languages.
-
-
GitHub - Static variable in class com.textkernel.tx.models.resume.contactinfo.WebAddressType
-
-
A GitHub username/URL
-
-
GivenName - Variable in class com.textkernel.tx.models.resume.contactinfo.PersonName
-
-
The given (first) name
-
-
GPA - Variable in class com.textkernel.tx.models.resume.education.EducationDetails
-
-
The GPA/marks listed on the resume
-
-
GradePointAverage - Class in com.textkernel.tx.models.resume.education
-
-
Information about a GPA (or equivalent)
-
-
GradePointAverage() - Constructor for class com.textkernel.tx.models.resume.education.GradePointAverage
-
 
-
Graduated - Variable in class com.textkernel.tx.models.resume.education.EducationDetails
-
-
Whether or not the candidate graduated
-
-
Group - Variable in class com.textkernel.tx.models.dataenrichment.Profession
-
-
The group which this profession belongs to.
-
-
Group - Variable in class com.textkernel.tx.models.resume.employment.ParsingNormalizedProfession
-
-
The object of the group to which the profession concept belongs.
-
-
Groups - Variable in class com.textkernel.tx.models.skills.ProfessionClass
-
-
Array of objects representing groups of professions.
-
-
- - - -

H

-
-
HasPatents - Variable in class com.textkernel.tx.models.api.matching.request.FilterCriteria
-
-
If true, results must have/require patent experience.
-
-
HasSecurityCredentials - Variable in class com.textkernel.tx.models.api.matching.request.FilterCriteria
-
-
If true, results must have/require security credentials.
-
-
HeaderColor - Variable in class com.textkernel.tx.models.api.matching.ui.Style
-
-
An HTML color used for the background of the section/accordian headers.
-
-
HeaderTextFound - Variable in class com.textkernel.tx.models.resume.metadata.ResumeSection
-
-
The exact text that was used to identify the beginning of the section.
-
-
HideHtmlImages - Variable in class com.textkernel.tx.models.api.parsing.ParseOptions
-
-
true to remove any images in the converted HTML
-
-
HighestDegree - Variable in class com.textkernel.tx.models.resume.education.EducationHistory
-
-
The highest degree obtained by a candidate
-
-
HighestManagementScore - Variable in class com.textkernel.tx.models.job.ParsedJob
-
-
The management score.
-
-
Hobbies - Variable in class com.textkernel.tx.models.resume.ParsedResume
-
-
Any hobbies listed on the resume
-
-
Hooks - Variable in class com.textkernel.tx.models.api.matching.ui.UIOptions
-
-
Contains all the User Action Hooks - for the Match UI session.
-
-
HTML - Variable in class com.textkernel.tx.models.api.parsing.Conversions
-
-
If requested by ParseOptions.OutputHtml, this is the document converted to HTML.
-
-
HttpResponse<T extends ApiResponse<?>> - Class in com.textkernel.tx.http
-
-
A simple class to contain a raw OkHttp Response and a deserialized response body
-
-
HttpResponse(Response, Class<T>) - Constructor for class com.textkernel.tx.http.HttpResponse
-
 
-
HttpStatusCode - Variable in exception com.textkernel.tx.exceptions.TxException
-
-
The HTTP Status Code of the response.
-
-
HukouArea - Variable in class com.textkernel.tx.models.resume.PersonalAttributes
-
-
Used in Chinese resumes
-
-
HukouCity - Variable in class com.textkernel.tx.models.resume.PersonalAttributes
-
-
Used in Chinese resumes
-
-
- - - -

I

-
-
ICQ - Static variable in class com.textkernel.tx.models.resume.contactinfo.WebAddressType
-
-
An ICQ username
-
-
Id - Variable in class com.textkernel.tx.models.api.bimetricscoring.BimetricScoreResult
-
-
The document id of the result
-
-
Id - Variable in class com.textkernel.tx.models.api.bimetricscoring.ParsedJobWithId
-
-
The id of the document (used in the response body)
-
-
Id - Variable in class com.textkernel.tx.models.api.bimetricscoring.ParsedResumeWithId
-
-
The id of the document (used in the response body)
-
-
Id - Variable in class com.textkernel.tx.models.api.dataenrichment.ontology.response.SkillScore
-
-
The ID of the skill in the skills taxonomy.
-
-
Id - Variable in class com.textkernel.tx.models.api.matching.response.SearchResult
-
-
The document id of the search/match result
-
-
Id - Variable in class com.textkernel.tx.models.api.matching.response.TaxonomyInfo
-
-
Id for the taxonomy/subtaxonomy
-
-
Id - Variable in class com.textkernel.tx.models.dataenrichment.Skill
-
-
The ID of the skill in the taxonomy.
-
-
Id - Variable in class com.textkernel.tx.models.resume.education.EducationDetails
-
-
The id of this education entry (one-based, so EDU-1 is the first, etc)
-
-
Id - Variable in class com.textkernel.tx.models.resume.employment.Position
-
-
The id of this position (one-based, so POS-1 is the first, etc)
-
-
Id - Variable in class com.textkernel.tx.models.resume.SectionIdentifier
-
-
If applicable, the Position.Id or EducationDetails.Id
-
-
Id - Variable in class com.textkernel.tx.models.skills.ITaxonomy
-
-
The id of the skills taxonomy
-
-
Id - Variable in class com.textkernel.tx.models.skills.NormalizedSkill
-
-
Id of this skill in the skills taxonomy.
-
-
Id - Variable in class com.textkernel.tx.models.skills.ProfessionClass
-
-
Id of the related profession.
-
-
Id - Variable in class com.textkernel.tx.models.skills.ProfessionGroup
-
-
Id of the profession group.
-
-
Id - Variable in class com.textkernel.tx.models.skills.Skill
-
-
The Id of the skill
-
-
Identifier - Variable in class com.textkernel.tx.models.api.parsing.FlexRequest
-
-
Unique field name to be returned alongside the reply in the response
-
-
Identifier - Variable in class com.textkernel.tx.models.api.parsing.FlexResponseItem
-
-
Unique field name assigned to the respective FlexRequest
-
-
IncludeGeocoding - Variable in class com.textkernel.tx.models.api.geocoding.GeocodeOptions
-
-
true to geocode, otherwise false
-
-
Index - Class in com.textkernel.tx.models.matching
-
-
A document index to hold resumes or jobs
-
-
Index() - Constructor for class com.textkernel.tx.models.matching.Index
-
 
-
indexDocument(ParsedResume, String, String, List<String>) - Method in class com.textkernel.tx.TxClient
-
-
Add a resume to an existing index
-
-
indexDocument(ParsedJob, String, String, List<String>) - Method in class com.textkernel.tx.TxClient
-
-
Add a job to an existing index
-
-
IndexDocumentRequest - Class in com.textkernel.tx.models.api.indexes
-
-
Base class for 'index resume' or 'index job' request body
-
-
IndexDocumentRequest() - Constructor for class com.textkernel.tx.models.api.indexes.IndexDocumentRequest
-
 
-
IndexDocumentResponse - Class in com.textkernel.tx.models.api.indexes
-
-
The response body from a IndexDocument API call
-
-
IndexDocumentResponse() - Constructor for class com.textkernel.tx.models.api.indexes.IndexDocumentResponse
-
 
-
IndexedDocumentInfo - Class in com.textkernel.tx.models.api.indexes
-
-
A small container for identifying an indexed document
-
-
IndexedDocumentInfo() - Constructor for class com.textkernel.tx.models.api.indexes.IndexedDocumentInfo
-
 
-
IndexId - Variable in class com.textkernel.tx.models.api.indexes.IndexedDocumentInfo
-
-
The id for the index that contains the document (case-insensitive).
-
-
IndexId - Variable in class com.textkernel.tx.models.api.indexes.IndexSingleDocumentInfo
-
-
The id for the index where the document should be added (case-insensitive).
-
-
IndexId - Variable in class com.textkernel.tx.models.api.matching.response.SearchResult
-
-
The id of the index containing the document
-
-
IndexIdsToSearchInto - Variable in class com.textkernel.tx.models.api.matching.request.SearchMatchRequestBase
-
-
The ids of the indexes in which you want to find results (case-insensitive).
-
-
IndexIfGeocodeFails - Variable in class com.textkernel.tx.models.api.geocoding.GeocodeAndIndexRequest
-
-
Indicates whether or not the document should still be added to the index if the geocode request fails.
-
-
IndexingOptions - Variable in class com.textkernel.tx.models.api.geocoding.GeocodeAndIndexRequest
-
-
Where to index the resume
-
-
IndexingOptions - Variable in class com.textkernel.tx.models.api.parsing.ParseOptions
-
-
If you are using AI Matching, use this property to also index the document after it is parsed/geocoded.
-
-
IndexingResponse - Variable in class com.textkernel.tx.models.api.geocoding.GeocodeAndIndexResponseValue
-
-
If indexing was requested, the status of the index transaction will be output here
-
-
IndexingResponse - Variable in class com.textkernel.tx.models.api.parsing.BaseParseResponseValue
-
-
If indexing was requested in the ParseOptions.IndexingOptions, - the status of the index transaction will be output here
-
-
IndexJobInfo - Class in com.textkernel.tx.models.api.indexes
-
-
Information for adding a single job to an index as part of a 'batch upload'
-
-
IndexJobInfo() - Constructor for class com.textkernel.tx.models.api.indexes.IndexJobInfo
-
 
-
IndexJobRequest - Class in com.textkernel.tx.models.api.indexes
-
-
Request body for an 'index job' request
-
-
IndexJobRequest() - Constructor for class com.textkernel.tx.models.api.indexes.IndexJobRequest
-
 
-
IndexMultipleDocumentInfo - Class in com.textkernel.tx.models.api.indexes
-
-
Information for adding a single document to an index as part of a 'batch upload'
-
-
IndexMultipleDocumentInfo() - Constructor for class com.textkernel.tx.models.api.indexes.IndexMultipleDocumentInfo
-
 
-
IndexMultipleDocumentsResponse - Class in com.textkernel.tx.models.api.indexes
-
-
The response body from a IndexMultipleDocuments API call
-
-
IndexMultipleDocumentsResponse() - Constructor for class com.textkernel.tx.models.api.indexes.IndexMultipleDocumentsResponse
-
 
-
IndexMultipleDocumentsResponseValue - Class in com.textkernel.tx.models.api.indexes
-
-
One entry in the ApiResponse.Value from a 'index multiple documents' response
-
-
IndexMultipleDocumentsResponseValue() - Constructor for class com.textkernel.tx.models.api.indexes.IndexMultipleDocumentsResponseValue
-
 
-
indexMultipleJobs(List<IndexJobInfo>, String) - Method in class com.textkernel.tx.TxClient
-
-
Add several jobs to an existing index
-
-
IndexMultipleJobsRequest - Class in com.textkernel.tx.models.api.indexes
-
-
Request body for an 'index multiple jobs' request
-
-
IndexMultipleJobsRequest() - Constructor for class com.textkernel.tx.models.api.indexes.IndexMultipleJobsRequest
-
 
-
indexMultipleResumes(List<IndexResumeInfo>, String) - Method in class com.textkernel.tx.TxClient
-
-
Add several resumes to an existing index
-
-
IndexMultipleResumesRequest - Class in com.textkernel.tx.models.api.indexes
-
-
Request body for an 'index multiple resumes' request
-
-
IndexMultipleResumesRequest() - Constructor for class com.textkernel.tx.models.api.indexes.IndexMultipleResumesRequest
-
 
-
IndexResumeInfo - Class in com.textkernel.tx.models.api.indexes
-
-
Information for adding a single resume to an index as part of a 'batch upload'
-
-
IndexResumeInfo() - Constructor for class com.textkernel.tx.models.api.indexes.IndexResumeInfo
-
 
-
IndexResumeRequest - Class in com.textkernel.tx.models.api.indexes
-
-
Request body for an 'index resume' request
-
-
IndexResumeRequest() - Constructor for class com.textkernel.tx.models.api.indexes.IndexResumeRequest
-
 
-
IndexSingleDocumentInfo - Class in com.textkernel.tx.models.api.indexes
-
-
Information for adding a document to an index
-
-
IndexSingleDocumentInfo() - Constructor for class com.textkernel.tx.models.api.indexes.IndexSingleDocumentInfo
-
 
-
IndexType - Variable in class com.textkernel.tx.models.api.indexes.CreateIndexRequest
-
-
The type of documents this index will contain
-
-
IndexType - Variable in class com.textkernel.tx.models.matching.Index
-
-
The type of document in this index
-
-
IndexType - Enum in com.textkernel.tx.models.matching
-
-
Type of documents that an index holds
-
-
Industries - Variable in class com.textkernel.tx.models.api.matching.CategoryWeights
-
-
The weight of the Industries/Taxonomies category relative to other categories.
-
-
IndustriesHasData - Variable in class com.textkernel.tx.models.api.matching.CategoryWeights
-
-
If false, the Industries/Taxonomies category has no data and should be ignored/hidden.
-
-
Info - Variable in class com.textkernel.tx.models.api.ApiResponse
-
-
Contains information about the response and the customer
-
-
InnerException - Variable in exception com.textkernel.tx.exceptions.TxException
-
-
If this exception was caused by another exception, the root cause will be here.
-
-
InputSkillsNotInProfession - Variable in class com.textkernel.tx.models.api.dataenrichment.ontology.response.CompareSkillsToProfessionResponseValue
-
-
The list of given skill IDs that are not associated to the given profession.
-
-
Instagram - Static variable in class com.textkernel.tx.models.resume.contactinfo.WebAddressType
-
-
An Instagram username
-
-
IntegerRange - Class in com.textkernel.tx.models.api.matching.request
-
-
A range of integers
-
-
IntegerRange() - Constructor for class com.textkernel.tx.models.api.matching.request.IntegerRange
-
 
-
InternationalCountryCode - Variable in class com.textkernel.tx.models.resume.contactinfo.Telephone
-
-
The international country code part of the phone number
-
-
InternationalEducationLevel - Variable in class com.textkernel.tx.models.job.JobDegree
-
-
The normalized education level based on an international standard.
-
-
InvalidSkills - Variable in class com.textkernel.tx.models.api.dataenrichment.ontology.response.SuggestedProfessionsWarnings
-
-
A list of warnings about provided skills that are invalid.
-
-
IPAddress - Variable in class com.textkernel.tx.models.api.AccountInfo
-
-
The client IP Address where the API call originated
-
-
IParsedDocWithId - Interface in com.textkernel.tx.models.api.bimetricscoring
-
-
Interface to simplify Bimetric Score requests
-
-
IsAuthor - Variable in class com.textkernel.tx.models.api.matching.request.FilterCriteria
-
-
If true, results must have/require experience as an author.
-
-
IsBulk - Variable in class com.textkernel.tx.models.api.matching.ui.hooks.UserActionHook
-
-
Set to true to allow users to select multiple documents and perform this action on all of them at once.
-
-
Isco - Variable in class com.textkernel.tx.models.dataenrichment.Profession
-
-
/// The ISCO-2008 details of this profession.
-
-
ISCO - Variable in class com.textkernel.tx.models.resume.employment.ParsingNormalizedProfession
-
-
The object of the ISCO profession concept
-
-
IsCurrent - Variable in class com.textkernel.tx.models.api.matching.request.JobTitleFilter
-
-
Whether or not the job title must be a current job title
-
-
IsCurrent - Variable in class com.textkernel.tx.models.api.matching.request.SkillFilter
-
-
Whether or not the skill must be a current skill
-
-
IsCurrent - Variable in class com.textkernel.tx.models.api.matching.response.FoundJobTitle
-
-
true when the job title found is in the current time-frame.
-
-
IsCurrent - Variable in class com.textkernel.tx.models.api.matching.response.FoundSkill
-
-
true when the skill is found in the current time-frame.
-
-
IsCurrent - Variable in class com.textkernel.tx.models.resume.employment.Position
-
-
true if the job/position is listed as current on the resume
-
-
IsCurrentDate - Variable in class com.textkernel.tx.models.TxDate
-
-
true if this date represents '- current' and not an actual date
-
-
IsCurrentStudent - Variable in class com.textkernel.tx.models.api.matching.request.FilterCriteria
-
-
Results must have an education section listed as '- current'.
-
-
IsMilitary - Variable in class com.textkernel.tx.models.api.matching.request.FilterCriteria
-
-
If true, results must have/require military experience.
-
-
IsoCode - Variable in class com.textkernel.tx.models.dataenrichment.LangDescription
-
-
The ISO code for the language of the description.
-
-
IsoCode - Variable in class com.textkernel.tx.models.dataenrichment.Skill
-
-
The language ISO 639-1 code.
-
-
IsPublicSpeaker - Variable in class com.textkernel.tx.models.api.matching.request.FilterCriteria
-
-
If true, results must have/require public speaking experience.
-
-
IsRecentGraduate - Variable in class com.textkernel.tx.models.api.matching.request.FilterCriteria
-
-
Results must have graduated within the last 18 months.
-
-
IsRemote - Variable in class com.textkernel.tx.models.job.ParsedJob
-
-
Whether or not the position is remote.
-
-
IsSelfEmployed - Variable in class com.textkernel.tx.models.resume.employment.Position
-
-
true if the candidate was self-employed at this job/position
-
-
isSuccess() - Method in class com.textkernel.tx.models.api.ApiResponseInfoLite
-
 
-
isSuccess() - Method in class com.textkernel.tx.models.api.parsing.FlexResponse
-
 
-
IsTopStudent - Variable in class com.textkernel.tx.models.api.matching.request.FilterCriteria
-
-
Results must have an education with a normalized GPA of .75 or higher (for example, 3.0/4.0 or higher).
-
-
IsVariation - Variable in class com.textkernel.tx.models.resume.Certification
-
-
The parser generates several possible variations for some certifications to be used in AI Matching.
-
-
ITaxonomy<T> - Class in com.textkernel.tx.models.skills
-
-
A container to group similar skills subtaxonomies (see SubTaxonomy)
-
-
ITaxonomy() - Constructor for class com.textkernel.tx.models.skills.ITaxonomy
-
 
-
ITxResponse - Interface in com.textkernel.tx.models.api
-
-
The response body from a Tx API call
-
-
- - - -

J

-
-
JobData - Variable in class com.textkernel.tx.models.api.bimetricscoring.ParsedJobWithId
-
-
A job generated by the job parser
-
-
JobData - Variable in class com.textkernel.tx.models.api.geocoding.GeocodeAndIndexJobRequest
-
-
The job you wish to be geocoded/indexed
-
-
JobData - Variable in class com.textkernel.tx.models.api.geocoding.GeocodeAndIndexJobResponseValue
-
-
The job you sent to be geocoded/indexed with geolocation coordinates added
-
-
JobData - Variable in class com.textkernel.tx.models.api.geocoding.GeocodeJobRequest
-
-
The job you wish to be geocoded
-
-
JobData - Variable in class com.textkernel.tx.models.api.geocoding.GeocodeJobResponseValue
-
-
The job you sent to be geocoded with geolocation coordinates added
-
-
JobData - Variable in class com.textkernel.tx.models.api.indexes.IndexJobInfo
-
-
A job to index
-
-
JobData - Variable in class com.textkernel.tx.models.api.indexes.IndexJobRequest
-
-
A job to index
-
-
JobData - Variable in class com.textkernel.tx.models.api.matching.MatchJobRequest
-
-
The job to match.
-
-
JobData - Variable in class com.textkernel.tx.models.api.parsing.ParseJobResponseValue
-
-
The main output from the Job Parser
-
-
JobDegree - Class in com.textkernel.tx.models.job
-
-
A preferred/required educational degree found in a job
-
-
JobDegree() - Constructor for class com.textkernel.tx.models.job.JobDegree
-
 
-
JobDescription - Variable in class com.textkernel.tx.models.api.jobdescription.GenerateJobResponseValue
-
-
The generated job description
-
-
JobDescription - Variable in class com.textkernel.tx.models.job.ParsedJob
-
-
Section containing information about the job.
-
-
JobLevel - Variable in class com.textkernel.tx.models.resume.employment.Position
-
-
The level determined by length of experience and job titles.
-
-
JobMetadata - Class in com.textkernel.tx.models.job
-
-
Metadata about a parsed job
-
-
JobMetadata() - Constructor for class com.textkernel.tx.models.job.JobMetadata
-
 
-
JobMetadata - Variable in class com.textkernel.tx.models.job.ParsedJob
-
-
Metadata about the parsed job
-
-
JobNormalizedSkill - Class in com.textkernel.tx.models.job.skills
-
-
Normalized skill concept representing one or more raw skills that were extracted.
-
-
JobNormalizedSkill() - Constructor for class com.textkernel.tx.models.job.skills.JobNormalizedSkill
-
 
-
JobPredictiveIndex - Variable in class com.textkernel.tx.models.api.matching.request.FilterCriteria
-
-
Results much have ExperienceSummary.FulltimeDirectHirePredictiveIndex within this range.
-
-
JobRawSkill - Class in com.textkernel.tx.models.job.skills
-
-
Skill exactly as it was found in the plain text of the document.
-
-
JobRawSkill() - Constructor for class com.textkernel.tx.models.job.skills.JobRawSkill
-
 
-
JobRequirements - Variable in class com.textkernel.tx.models.job.ParsedJob
-
-
Full text of any requirements listed by the job.
-
-
Jobs - Variable in class com.textkernel.tx.models.api.indexes.IndexMultipleJobsRequest
-
-
The jobs to add into the index
-
-
JobSkill - Class in com.textkernel.tx.models.job.skills
-
-
A skill listed in a job
-
-
JobSkill() - Constructor for class com.textkernel.tx.models.job.skills.JobSkill
-
 
-
JobSkillVariation - Class in com.textkernel.tx.models.job.skills
-
-
A skill listed in a job
-
-
JobSkillVariation() - Constructor for class com.textkernel.tx.models.job.skills.JobSkillVariation
-
 
-
JobSubTaxonomy - Class in com.textkernel.tx.models.job.skills
-
-
A subtaxonomy to group similar skills
-
-
JobSubTaxonomy() - Constructor for class com.textkernel.tx.models.job.skills.JobSubTaxonomy
-
 
-
JobTaxonomy - Class in com.textkernel.tx.models.job.skills
-
-
A container to group similar skills subtaxonomies (see JobSubTaxonomy)
-
-
JobTaxonomy() - Constructor for class com.textkernel.tx.models.job.skills.JobTaxonomy
-
 
-
JobTaxonomyRoot - Class in com.textkernel.tx.models.job.skills
-
-
A container for skills taxonomies found in a job
-
-
JobTaxonomyRoot() - Constructor for class com.textkernel.tx.models.job.skills.JobTaxonomyRoot
-
 
-
JobTitle - Variable in class com.textkernel.tx.models.api.jobdescription.GenerateJobRequest
-
-
The title of the job.
-
-
JobTitle - Variable in class com.textkernel.tx.models.api.jobdescription.SuggestSkillsFromJobTitleRequest
-
-
The title of the job for which skills are being suggested.
-
-
JobTitle - Variable in class com.textkernel.tx.models.job.JobTitles
-
-
All job titles found in the job description
-
-
JobTitle - Class in com.textkernel.tx.models.resume.employment
-
-
A job title found in a resume
-
-
JobTitle() - Constructor for class com.textkernel.tx.models.resume.employment.JobTitle
-
 
-
JobTitle - Variable in class com.textkernel.tx.models.resume.employment.Position
-
-
The job title for this position/job
-
-
JobTitleFilter - Class in com.textkernel.tx.models.api.matching.request
-
-
Criteria for filtering on a specific job title
-
-
JobTitleFilter() - Constructor for class com.textkernel.tx.models.api.matching.request.JobTitleFilter
-
 
-
JobTitles - Variable in class com.textkernel.tx.models.api.dataenrichment.professions.request.NormalizeProfessionsRequest
-
-
The list of job titles to normalize (up to 10 job titles, each job title may not exceed 400 characters).
-
-
JobTitles - Variable in class com.textkernel.tx.models.api.matching.CategoryWeights
-
-
The weight of the JobTitles category relative to other categories.
-
-
JobTitles - Variable in class com.textkernel.tx.models.api.matching.request.FilterCriteria
-
-
Results must have at least one of the specified job titles.
-
-
JobTitles - Variable in class com.textkernel.tx.models.api.matching.response.EnrichedScoreData
-
-
Detailed match information for the JobTitles category.
-
-
JobTitles - Class in com.textkernel.tx.models.job
-
-
Job titles found in a job description
-
-
JobTitles() - Constructor for class com.textkernel.tx.models.job.JobTitles
-
 
-
JobTitles - Variable in class com.textkernel.tx.models.job.ParsedJob
-
-
The job titles found in the job.
-
-
JobTitlesHasData - Variable in class com.textkernel.tx.models.api.matching.CategoryWeights
-
-
If false, the JobTitles category has no data and should be ignored/hidden.
-
-
JobTitlesScoreData - Class in com.textkernel.tx.models.api.matching.response
-
-
Details about the score for the Job Titles category
-
-
JobTitlesScoreData() - Constructor for class com.textkernel.tx.models.api.matching.response.JobTitlesScoreData
-
 
-
JobTone - Enum in com.textkernel.tx.models.api.jobdescription
-
-
Tone to use when generating job descriptions
-
-
JobType - Variable in class com.textkernel.tx.models.resume.employment.Position
-
-
The type of job.
-
-
JobV2Skills - Class in com.textkernel.tx.models.job.skills
-
-
Skills output when version 2 of the taxonomy is utilized.
-
-
JobV2Skills() - Constructor for class com.textkernel.tx.models.job.skills.JobV2Skills
-
 
-
JsAction - Variable in class com.textkernel.tx.models.api.matching.ui.hooks.ClientSideHook
-
-
A Javascript action to perform when the user clicks the button.
-
-
JsAction - Class in com.textkernel.tx.models.api.matching.ui.hooks
-
-
An action performed in Javascript
-
-
JsAction() - Constructor for class com.textkernel.tx.models.api.matching.ui.hooks.JsAction
-
 
-
- - - -

K

-
-
Kldb2020 - Variable in class com.textkernel.tx.models.dataenrichment.Profession
-
-
/// The KLDB-2020 details of this profession.
-
-
- - - -

L

-
-
Label - Variable in class com.textkernel.tx.models.api.matching.ui.UserDefinedTagsPicklist
-
-
The label for this picklist in the UI
-
-
LangDescription - Class in com.textkernel.tx.models.dataenrichment
-
-
The description in thed particular language.
-
-
LangDescription() - Constructor for class com.textkernel.tx.models.dataenrichment.LangDescription
-
 
-
Language - Variable in class com.textkernel.tx.models.api.dataenrichment.professions.request.NormalizeProfessionsRequest
-
-
The language of the input job titles.
-
-
Language - Variable in class com.textkernel.tx.models.api.dataenrichment.skills.request.ExtractSkillsRequest
-
-
The language of the input text.
-
-
Language - Variable in class com.textkernel.tx.models.api.dataenrichment.skills.request.NormalizeSkillsRequest
-
-
The language of the given skills.
-
-
Language - Variable in class com.textkernel.tx.models.api.jobdescription.GenerateJobRequest
-
-
Language of the job description, in ISO 639-1 code format.
-
-
Language - Variable in class com.textkernel.tx.models.api.jobdescription.SuggestSkillsFromJobTitleRequest
-
-
Language of the suggested skills in ISO 639-1 code format.
-
-
Language - Variable in class com.textkernel.tx.models.resume.LanguageCompetency
-
-
The language name
-
-
LanguageCode - Variable in class com.textkernel.tx.models.resume.LanguageCompetency
-
-
The two-letter ISO 639-1 code for the language
-
-
LanguageCodes - Variable in class com.textkernel.tx.models.job.ParsedJob
-
-
Any languages listed in the job.
-
-
LanguageCompetencies - Variable in class com.textkernel.tx.models.resume.ParsedResume
-
-
Any language competencies (fluent in, can read, can write, etc) found in the resume.
-
-
LanguageCompetency - Class in com.textkernel.tx.models.resume
-
-
A language competency (fluent in, can read, can write, etc) found on a resume
-
-
LanguageCompetency() - Constructor for class com.textkernel.tx.models.resume.LanguageCompetency
-
 
-
Languages - Variable in class com.textkernel.tx.models.api.dataenrichment.AutocompleteRequest
-
-
The language(s) used to search for matching professions (the language of the provided Prefix).
-
-
Languages - Variable in class com.textkernel.tx.models.api.matching.CategoryWeights
-
-
The weight of the Languages category relative to other categories.
-
-
Languages - Variable in class com.textkernel.tx.models.api.matching.response.EnrichedScoreData
-
-
Detailed match information for the Languages category.
-
-
LanguagesHasData - Variable in class com.textkernel.tx.models.api.matching.CategoryWeights
-
-
If false, the Languages category has no data and should be ignored/hidden.
-
-
LanguagesKnown - Variable in class com.textkernel.tx.models.api.matching.request.FilterCriteria
-
-
Results must have/require these language competencies (2-letter ISO 639-1 language codes).
-
-
LanguagesKnownMustAllExist - Variable in class com.textkernel.tx.models.api.matching.request.FilterCriteria
-
-
When true, all of the languages in FilterCriteria.LanguagesKnown must be found.
-
-
LastEducationDate - Variable in class com.textkernel.tx.models.resume.education.EducationDetails
-
-
Deprecated. -
use EducationDetails.EndDate instead
-
-
-
LastLineNumber - Variable in class com.textkernel.tx.models.resume.metadata.ResumeSection
-
-
The last line of the section (zero-based).
-
-
LastModified - Variable in class com.textkernel.tx.models.Document
-
-
The last revised/modified date for this file.
-
-
LastUsed - Variable in class com.textkernel.tx.models.resume.skills.ResumeNormalizedSkill
-
-
Describes the date the candidate last used the skill (derived from position dates)
-
-
LastUsed - Variable in class com.textkernel.tx.models.resume.skills.ResumeRawSkill
-
-
Describes the date the candidate last used the skill (derived from position dates)
-
-
LastUsed - Variable in class com.textkernel.tx.models.resume.skills.ResumeSkillVariation
-
-
Describes the date the candidate last used the skill (derived from position dates)
-
-
Latitude - Variable in class com.textkernel.tx.models.GeoCoordinates
-
-
The latitude, in degrees
-
-
Level - Variable in class com.textkernel.tx.models.resume.metadata.ResumeQualityAssessment
-
-
The level/severity of this assessment.
-
-
LicenseDetails - Class in com.textkernel.tx.models.resume
-
-
A license found on a resume.
-
-
LicenseDetails() - Constructor for class com.textkernel.tx.models.resume.LicenseDetails
-
 
-
Licenses - Variable in class com.textkernel.tx.models.resume.ParsedResume
-
-
Licenses found on a resume.
-
-
LicenseSerialNumber - Variable in class com.textkernel.tx.models.api.parsing.ParsingMetadata
-
-
For self-hosted customers only.
-
-
Likelihood - Variable in class com.textkernel.tx.models.dataenrichment.SkillMatch
-
-
Likelihood that the matched term actually refers to a skill in the context of the text.
-
-
Limit - Variable in class com.textkernel.tx.models.api.dataenrichment.AutocompleteRequest
-
-
The maximum number of returned professions.
-
-
Limit - Variable in class com.textkernel.tx.models.api.dataenrichment.ontology.request.SuggestProfessionsRequest
-
-
The maximum amount of professions returned.
-
-
Limit - Variable in class com.textkernel.tx.models.api.dataenrichment.ontology.request.SuggestSkillsFromProfessionsRequest
-
-
The maximum amount of suggested skills returned.
-
-
Limit - Variable in class com.textkernel.tx.models.api.dataenrichment.ontology.request.SuggestSkillsFromSkillsRequest
-
-
The maximum amount of suggested skills returned.
-
-
Limit - Variable in class com.textkernel.tx.models.api.jobdescription.SuggestSkillsFromJobTitleRequest
-
-
Maximum number of skills to suggest.
-
-
LinkedIn - Static variable in class com.textkernel.tx.models.resume.contactinfo.WebAddressType
-
-
A LinkedIn URL
-
-
LinkText - Variable in class com.textkernel.tx.models.api.matching.ui.hooks.UserActionHook
-
-
Text to display on the button for the user action.
-
-
LocalEducationLevel - Variable in class com.textkernel.tx.models.job.JobDegree
-
-
The normalized education level based on the job's country.
-
-
Location - Variable in class com.textkernel.tx.models.api.jobdescription.GenerateJobRequest
-
-
Location of the job.
-
-
Location - Class in com.textkernel.tx.models
-
-
Represents a physical location on Earth (mostly used for addresses)
-
-
Location() - Constructor for class com.textkernel.tx.models.Location
-
 
-
Location - Variable in class com.textkernel.tx.models.resume.CandidateReference
-
-
The physical location of the reference
-
-
Location - Variable in class com.textkernel.tx.models.resume.contactinfo.ContactInformation
-
-
The candidate's location/address.
-
-
Location - Variable in class com.textkernel.tx.models.resume.education.EducationDetails
-
-
The Country/Region/City of the school, if found
-
-
Location - Variable in class com.textkernel.tx.models.resume.employment.Employer
-
-
The location/address of the employer
-
-
LocationCriteria - Variable in class com.textkernel.tx.models.api.matching.request.FilterCriteria
-
-
Use to filter results based on location.
-
-
LocationCriteria - Class in com.textkernel.tx.models.api.matching.request
-
-
Criteria for distance/range filtering
-
-
LocationCriteria() - Constructor for class com.textkernel.tx.models.api.matching.request.LocationCriteria
-
 
-
Locations - Variable in class com.textkernel.tx.models.api.matching.request.LocationCriteria
-
-
Results must be found within a certain distance of one of these specified locations.
-
-
Longitude - Variable in class com.textkernel.tx.models.GeoCoordinates
-
-
The longitude, in degrees
-
-
LookupProfessionCodesRequest - Class in com.textkernel.tx.models.api.dataenrichment.professions.request
-
-
Request body for a 'LookupProfessions' request
-
-
LookupProfessionCodesRequest() - Constructor for class com.textkernel.tx.models.api.dataenrichment.professions.request.LookupProfessionCodesRequest
-
 
-
LookupProfessionCodesResponse - Class in com.textkernel.tx.models.api.dataenrichment.professions.response
-
-
The response body from a LookupProfessions API call
-
-
LookupProfessionCodesResponse() - Constructor for class com.textkernel.tx.models.api.dataenrichment.professions.response.LookupProfessionCodesResponse
-
 
-
LookupProfessionCodesResponseValue - Class in com.textkernel.tx.models.api.dataenrichment.professions.response
-
-
One entry in the ApiResponse.Value from a 'LookupProfessions' response
-
-
LookupProfessionCodesResponseValue() - Constructor for class com.textkernel.tx.models.api.dataenrichment.professions.response.LookupProfessionCodesResponseValue
-
 
-
lookupProfessions(List<Integer>, String) - Method in class com.textkernel.tx.TxClient
-
-
Get details for the given professions in the taxonomy.
-
-
lookupProfessions(List<Integer>) - Method in class com.textkernel.tx.TxClient
-
-
Get details for the given professions in the taxonomy.
-
-
LookupSkillCodesResponse - Class in com.textkernel.tx.models.api.dataenrichment.skills.response
-
-
The response body from a LookupSkills API call
-
-
LookupSkillCodesResponse() - Constructor for class com.textkernel.tx.models.api.dataenrichment.skills.response.LookupSkillCodesResponse
-
 
-
LookupSkillCodesResponseValue - Class in com.textkernel.tx.models.api.dataenrichment.skills.response
-
-
One entry in the ApiResponse.Value from a 'LookupSkills' response
-
-
LookupSkillCodesResponseValue() - Constructor for class com.textkernel.tx.models.api.dataenrichment.skills.response.LookupSkillCodesResponseValue
-
 
-
lookupSkills(List<String>, String) - Method in class com.textkernel.tx.TxClient
-
-
Get the details associated with given skills in the taxonomy.
-
-
lookupSkills(List<String>) - Method in class com.textkernel.tx.TxClient
-
-
Get the details associated with given skills in the taxonomy.
-
-
LookupSkillsRequest - Class in com.textkernel.tx.models.api.dataenrichment.skills.request
-
-
Request body for a 'LookupSkills' request
-
-
LookupSkillsRequest() - Constructor for class com.textkernel.tx.models.api.dataenrichment.skills.request.LookupSkillsRequest
-
 
-
lookupSkillsV2(List<String>, String) - Method in class com.textkernel.tx.TxClient
-
-
Get the details associated with given skills in the taxonomy.
-
-
lookupSkillsV2(List<String>) - Method in class com.textkernel.tx.TxClient
-
-
Get the details associated with given skills in the taxonomy.
-
-
- - - -

M

-
-
MainEmployerName - Variable in class com.textkernel.tx.models.job.EmployerNames
-
-
The main/overall employer name
-
-
MainJobTitle - Variable in class com.textkernel.tx.models.job.JobTitles
-
-
The main/overall job title
-
-
MajorIssue - Static variable in class com.textkernel.tx.models.resume.metadata.ResumeQualityLevel
-
-
A major issue was found in the resume that will reduce the quality of parse results
-
-
Majors - Variable in class com.textkernel.tx.models.resume.education.EducationDetails
-
-
Any majors/areas of major focus
-
-
ManagementLevel - Variable in class com.textkernel.tx.models.api.matching.CategoryWeights
-
-
The weight of the ManagementLevel category relative to other categories.
-
-
ManagementLevel - Variable in class com.textkernel.tx.models.api.matching.response.EnrichedScoreData
-
-
Detailed match information for the ManagementLevel category.
-
-
ManagementLevel - Variable in class com.textkernel.tx.models.job.ParsedJob
-
-
The management level.
-
-
ManagementLevelHasData - Variable in class com.textkernel.tx.models.api.matching.CategoryWeights
-
-
If false, the ManagementLevel category has no data and should be ignored/hidden.
-
-
ManagementLevelScoreData - Class in com.textkernel.tx.models.api.matching.response
-
-
Details about the score for the Management Level category
-
-
ManagementLevelScoreData() - Constructor for class com.textkernel.tx.models.api.matching.response.ManagementLevelScoreData
-
 
-
ManagementScore - Variable in class com.textkernel.tx.models.resume.employment.ExperienceSummary
-
-
The highest score calculated from any of the position titles.
-
-
ManagementStory - Variable in class com.textkernel.tx.models.resume.employment.ExperienceSummary
-
-
A paragraph of text that summarizes the candidate's management experience (in English).
-
-
MaritalStatus - Variable in class com.textkernel.tx.models.resume.PersonalAttributes
-
-
The marital status listed on the resume
-
-
match(ParsedResume, List<String>, CategoryWeights, FilterCriteria, SearchMatchSettings, int) - Method in class com.textkernel.tx.TxClient
-
-
Find matches for a non-indexed resume.
-
-
match(ParsedJob, List<String>, CategoryWeights, FilterCriteria, SearchMatchSettings, int) - Method in class com.textkernel.tx.TxClient
-
-
Find matches for a non-indexed job.
-
-
match(String, String, List<String>, CategoryWeights, FilterCriteria, SearchMatchSettings, int) - Method in class com.textkernel.tx.TxClient
-
-
Find matches for a resume or job that is already indexed
-
-
match(ParsedResume, List<String>, CategoryWeights, FilterCriteria, SearchMatchSettings, int) - Method in class com.textkernel.tx.TxUIClient
-
-
Create a Matching UI session to find matches for a non-indexed resume.
-
-
match(ParsedJob, List<String>, CategoryWeights, FilterCriteria, SearchMatchSettings, int) - Method in class com.textkernel.tx.TxUIClient
-
-
Create a Matching UI session to find matches for a non-indexed job.
-
-
match(String, String, List<String>, CategoryWeights, FilterCriteria, SearchMatchSettings, int) - Method in class com.textkernel.tx.TxUIClient
-
-
Create a Matching UI session to find matches for a resume or job that is already indexed
-
-
MatchByDocumentIdOptions - Class in com.textkernel.tx.models.api.matching.request
-
-
Request body for a Match request
-
-
MatchByDocumentIdOptions() - Constructor for class com.textkernel.tx.models.api.matching.request.MatchByDocumentIdOptions
-
 
-
Matched - Variable in class com.textkernel.tx.models.api.matching.response.TaxonomyInfo
-
-
true when this taxonomy/subtaxonomy is found in both source and target documents
-
-
MatchedFromList - Variable in class com.textkernel.tx.models.resume.Certification
-
-
true if this was found by matching to a known list of certifications.
-
-
MatchedFromList - Variable in class com.textkernel.tx.models.resume.LicenseDetails
-
-
true if this was found by matching to a known list of licenses.
-
-
Matches - Variable in class com.textkernel.tx.models.api.matching.BaseSearchMatchResponseValue
-
-
The list of matches for the search/match
-
-
Matches - Variable in class com.textkernel.tx.models.dataenrichment.ExtractedSkill
-
-
A list of matches where this skill was found in the text.
-
-
MatchJobRequest - Class in com.textkernel.tx.models.api.matching
-
-
Request body for a Match request
-
-
MatchJobRequest() - Constructor for class com.textkernel.tx.models.api.matching.MatchJobRequest
-
 
-
MatchRequest - Class in com.textkernel.tx.models.api.matching.request
-
-
Request body for a Match request
-
-
MatchRequest() - Constructor for class com.textkernel.tx.models.api.matching.request.MatchRequest
-
 
-
MatchResponse - Class in com.textkernel.tx.models.api.matching
-
-
The response body from a Match API call
-
-
MatchResponse() - Constructor for class com.textkernel.tx.models.api.matching.MatchResponse
-
 
-
MatchResponseValue - Class in com.textkernel.tx.models.api.matching
-
-
The ApiResponse.Value from a Match response
-
-
MatchResponseValue() - Constructor for class com.textkernel.tx.models.api.matching.MatchResponseValue
-
 
-
MatchResult - Class in com.textkernel.tx.models.api.matching.response
-
-
A single result containing information about the bimetric score between a target and source document
-
-
MatchResult() - Constructor for class com.textkernel.tx.models.api.matching.response.MatchResult
-
 
-
MatchResumeRequest - Class in com.textkernel.tx.models.api.matching
-
-
Request body for a Match request
-
-
MatchResumeRequest() - Constructor for class com.textkernel.tx.models.api.matching.MatchResumeRequest
-
 
-
MatchUISettings - Class in com.textkernel.tx.models.api.matching.ui.request
-
-
Settings for generating a Matching UI session
-
-
MatchUISettings() - Constructor for class com.textkernel.tx.models.api.matching.ui.request.MatchUISettings
-
 
-
Maximum - Variable in class com.textkernel.tx.models.api.matching.request.IntegerRange
-
-
The maximum for this range
-
-
Maximum - Variable in class com.textkernel.tx.models.api.matching.request.RevisionDateRange
-
-
the maximum (most recent) date in ISO 8601 (yyyy-MM-dd) format
-
-
Maximum - Variable in class com.textkernel.tx.models.job.PayRange
-
-
The normalized maximum yearly salary
-
-
MaximumConcurrentRequests - Variable in class com.textkernel.tx.models.api.AccountInfo
-
-
The number of requests that can be made at one time
-
-
MaximumWorkingHours - Variable in class com.textkernel.tx.models.job.ParsedJob
-
-
The maximum number of working hours per week
-
-
MaximumYears - Variable in class com.textkernel.tx.models.job.ParsedJob
-
-
The maximum years experience for the job, if listed.
-
-
MaximumYearsManagement - Variable in class com.textkernel.tx.models.job.ParsedJob
-
-
The maximum years of management experience, if listed.
-
-
MaxScore - Variable in class com.textkernel.tx.models.resume.education.GradePointAverage
-
-
The max score in the GradePointAverage.ScoringSystem
-
-
Message - Variable in class com.textkernel.tx.models.api.ApiResponseInfoLite
-
-
A short human-readable description explaining the ApiResponseInfoLite.Code value
-
-
Message - Variable in class com.textkernel.tx.models.api.parsing.FlexResponse
-
-
A short human-readable description explaining the FlexResponse.Code value
-
-
Message - Variable in class com.textkernel.tx.models.resume.metadata.ResumeQualityFinding
-
-
A human-readable message explaining the issue that is being reported and possibly how to fix.
-
-
Method - Variable in class com.textkernel.tx.models.api.indexes.UpdateUserDefinedTagsRequest
-
-
Which method to use for the specified user-defined tags
-
-
MeWe - Static variable in class com.textkernel.tx.models.resume.contactinfo.WebAddressType
-
-
A MeWe username/URL
-
-
MiddleName - Variable in class com.textkernel.tx.models.resume.contactinfo.PersonName
-
-
The middle name or initial
-
-
MilitaryDetails - Class in com.textkernel.tx.models.resume.military
-
-
Information about military post/job listed on a resume
-
-
MilitaryDetails() - Constructor for class com.textkernel.tx.models.resume.military.MilitaryDetails
-
 
-
MilitaryExperience - Variable in class com.textkernel.tx.models.resume.ParsedResume
-
-
Any military experience listed on the resume
-
-
MilitaryService - Class in com.textkernel.tx.models.resume.military
-
-
A branch/name/rank for a military post/job
-
-
MilitaryService() - Constructor for class com.textkernel.tx.models.resume.military.MilitaryService
-
 
-
Minimum - Variable in class com.textkernel.tx.models.api.matching.request.IntegerRange
-
-
The minimum for this range
-
-
Minimum - Variable in class com.textkernel.tx.models.api.matching.request.RevisionDateRange
-
-
the minimum (oldest) date in ISO 8601 (yyyy-MM-dd) format
-
-
Minimum - Variable in class com.textkernel.tx.models.job.PayRange
-
-
The normalized minimum yearly salary
-
-
MinimumScore - Variable in class com.textkernel.tx.models.resume.education.GradePointAverage
-
-
The minimum score in the GradePointAverage.ScoringSystem
-
-
MinimumWorkingHours - Variable in class com.textkernel.tx.models.job.ParsedJob
-
-
The minimum number of working hours per week
-
-
MinimumYears - Variable in class com.textkernel.tx.models.job.ParsedJob
-
-
The minimum years experience for the job, if listed.
-
-
MinimumYearsManagement - Variable in class com.textkernel.tx.models.job.ParsedJob
-
-
The minimum years of management experience, if listed.
-
-
Minors - Variable in class com.textkernel.tx.models.resume.education.EducationDetails
-
-
Any minors/areas of minor focus
-
-
MissingSkills - Variable in class com.textkernel.tx.models.api.dataenrichment.ontology.response.SuggestedProfession
-
-
The list of skills relevant to this profession but missing from the given list of skills in the request.
-
-
MissingSkillsFoundInProfession - Variable in class com.textkernel.tx.models.api.dataenrichment.ontology.response.CompareSkillsToProfessionResponseValue
-
-
A list of skills associated with the profession but missing from list of provided skills.
-
-
Moniker - Variable in class com.textkernel.tx.models.resume.contactinfo.PersonName
-
-
The nickname/moniker, this is rarely populated
-
-
MonthsExperience - Variable in class com.textkernel.tx.models.api.matching.request.FilterCriteria
-
-
When specified, total work experience must fall within this range.
-
-
MonthsExperience - Variable in class com.textkernel.tx.models.resume.skills.ResumeNormalizedSkill
-
-
Describes the amount of experience a candidate has with this skill
-
-
MonthsExperience - Variable in class com.textkernel.tx.models.resume.skills.ResumeRawSkill
-
-
Describes the amount of experience a candidate has with this skill
-
-
MonthsExperience - Variable in class com.textkernel.tx.models.resume.skills.ResumeSkillVariation
-
-
Describes the amount of experience a candidate has with this skill
-
-
MonthsManagementExperience - Variable in class com.textkernel.tx.models.api.matching.request.FilterCriteria
-
-
Results must have management experience within this months range.
-
-
MonthsOfManagementExperience - Variable in class com.textkernel.tx.models.resume.employment.ExperienceSummary
-
-
The number of months of management experience as indicated by the range of - start and end date values in the various jobs/positions in the resume that have been - determined to be management-level positions.
-
-
MonthsOfWorkExperience - Variable in class com.textkernel.tx.models.resume.employment.ExperienceSummary
-
-
The number of months of work experience as indicated by the range of - start and end date values in the various jobs/positions in the resume.
-
-
MothersMaidenName - Variable in class com.textkernel.tx.models.resume.PersonalAttributes
-
-
The candidate's mother's maiden name listed on the resume
-
-
MotherTongue - Variable in class com.textkernel.tx.models.resume.PersonalAttributes
-
-
The candidate's mother tongue (native language) listed on the resume
-
-
Municipality - Variable in class com.textkernel.tx.models.api.geocoding.Address
-
-
The City/Municipality/Town
-
-
Municipality - Variable in class com.textkernel.tx.models.api.matching.request.FilterLocation
-
-
The City/Municipality/Town
-
-
Municipality - Variable in class com.textkernel.tx.models.Location
-
-
The City/Municipality/Town
-
-
- - - -

N

-
-
Name - Variable in class com.textkernel.tx.models.api.AccountInfo
-
-
The customer name on the account
-
-
Name - Variable in class com.textkernel.tx.models.api.jobdescription.GenerateJobSkill
-
-
The name of the skill
-
-
Name - Variable in class com.textkernel.tx.models.api.matching.response.TaxonomyInfo
-
-
Taxonomy/subtaxonomy name
-
-
Name - Variable in class com.textkernel.tx.models.job.JobDegree
-
-
The name of the educational degree
-
-
Name - Variable in class com.textkernel.tx.models.matching.Index
-
-
The name/id of this index
-
-
Name - Variable in class com.textkernel.tx.models.resume.Certification
-
-
The name of the certification
-
-
Name - Variable in class com.textkernel.tx.models.resume.education.Degree
-
-
The name of the degree
-
-
Name - Variable in class com.textkernel.tx.models.resume.employment.Employer
-
-
The name of the employer (and an accuracy probability)
-
-
Name - Variable in class com.textkernel.tx.models.resume.LicenseDetails
-
-
The name of the license
-
-
Name - Variable in class com.textkernel.tx.models.resume.military.MilitaryService
-
-
The name of the post/job
-
-
Name - Variable in class com.textkernel.tx.models.resume.military.SecurityCredential
-
-
The name of the credential/clearance
-
-
Name - Variable in class com.textkernel.tx.models.skills.ITaxonomy
-
-
The human-readable name
-
-
Name - Variable in class com.textkernel.tx.models.skills.NormalizedSkill
-
-
Name of the normalized skill.
-
-
Name - Variable in class com.textkernel.tx.models.skills.ProfessionClass
-
-
Name of the related profession.
-
-
Name - Variable in class com.textkernel.tx.models.skills.ProfessionGroup
-
-
Name of the profession group.
-
-
Name - Variable in class com.textkernel.tx.models.skills.RawSkill
-
-
The name of the skill
-
-
Name - Variable in class com.textkernel.tx.models.skills.Skill
-
-
The name of the skill
-
-
Names - Variable in class com.textkernel.tx.models.resume.metadata.ReservedData
-
-
All names found in the resume
-
-
NameVariation - Variable in class com.textkernel.tx.models.resume.employment.Employer
-
-
Sometimes a second possible company name is found, or a department/organization - within a company.
-
-
NationalIdentities - Variable in class com.textkernel.tx.models.resume.PersonalAttributes
-
-
Any national identities provided on the resume
-
-
NationalIdentity - Class in com.textkernel.tx.models.resume
-
-
A national identity found on a resume
-
-
NationalIdentity() - Constructor for class com.textkernel.tx.models.resume.NationalIdentity
-
 
-
Nationality - Variable in class com.textkernel.tx.models.resume.PersonalAttributes
-
-
The candidate's nationality listed on the resume
-
-
Normalize - Variable in class com.textkernel.tx.models.api.parsing.ProfessionsSettings
-
-
When true, the most recent 3 job titles will be normalized.
-
-
Normalize - Variable in class com.textkernel.tx.models.api.parsing.SkillsSettings
-
-
When true: - - Raw skills will be normalized.
-
-
Normalized - Variable in class com.textkernel.tx.models.job.skills.JobV2Skills
-
-
Normalized skills output when SkillsSettings.TaxonomyVersion is set to (or defaults to) V2 - and SkillsSettings.Normalize is set to true
-
-
Normalized - Variable in class com.textkernel.tx.models.resume.employment.JobTitle
-
-
Deprecated. -
use Position.NormalizedProfession instead
-
-
-
Normalized - Variable in class com.textkernel.tx.models.resume.NormalizedString
-
-
The normalized value
-
-
Normalized - Variable in class com.textkernel.tx.models.resume.skills.ResumeV2Skills
-
-
Normalized skills output when SkillsSettings.TaxonomyVersion is set to (or defaults to) V2 - and SkillsSettings.Normalize is set to true
-
-
NormalizedDegree - Class in com.textkernel.tx.models.resume.education
-
-
A normalized educational degree
-
-
NormalizedDegree() - Constructor for class com.textkernel.tx.models.resume.education.NormalizedDegree
-
 
-
NormalizedInternational - Variable in class com.textkernel.tx.models.resume.education.Degree
-
-
The normalized code/description of the degree based on an international standard.
-
-
NormalizedLocal - Variable in class com.textkernel.tx.models.resume.education.Degree
-
-
The normalized code/description of the degree based on the CV locale.
-
-
NormalizedProfession - Class in com.textkernel.tx.models.dataenrichment
-
-
A normalized profession and the confidence that the normalization is correct/fitting
-
-
NormalizedProfession() - Constructor for class com.textkernel.tx.models.dataenrichment.NormalizedProfession
-
 
-
NormalizedProfession - Variable in class com.textkernel.tx.models.job.JobTitles
-
-
Normalized profession for the main job title.
-
-
NormalizedProfession - Variable in class com.textkernel.tx.models.resume.employment.Position
-
-
Normalized profession of the Position.JobTitle
-
-
NormalizedScore - Variable in class com.textkernel.tx.models.resume.education.GradePointAverage
-
-
The GradePointAverage.Score, normalized to a 0.0-1.0 scale, with 1.0 being the top mark.
-
-
NormalizedSkill - Class in com.textkernel.tx.models.dataenrichment
-
-
A normalized skill object.
-
-
NormalizedSkill() - Constructor for class com.textkernel.tx.models.dataenrichment.NormalizedSkill
-
 
-
NormalizedSkill - Class in com.textkernel.tx.models.skills
-
-
Normalized skill concept representing one or more raw skills that were extracted.
-
-
NormalizedSkill() - Constructor for class com.textkernel.tx.models.skills.NormalizedSkill
-
 
-
NormalizedSkills - Variable in class com.textkernel.tx.models.skills.ProfessionGroup
-
-
Array of normalized skills associated to this profession group.
-
-
NormalizedString - Class in com.textkernel.tx.models.resume
-
-
A string with a raw and normalized value
-
-
NormalizedString() - Constructor for class com.textkernel.tx.models.resume.NormalizedString
-
 
-
NormalizeJobTitles - Variable in class com.textkernel.tx.models.api.matching.request.SearchMatchSettings
-
-
Normalize the first three job titles specified in FilterCriteria.JobTitles and automatically include them in the query - (additional charges apply).
-
-
NormalizeJobTitlesLanguage - Variable in class com.textkernel.tx.models.api.matching.request.SearchMatchSettings
-
-
Specify the language (ISO 639-1 code) of the Job Title to be normalized.
-
-
normalizeProfessions(List<String>, String, String) - Method in class com.textkernel.tx.TxClient
-
-
Normalize the given job titles to the most closely-related professions in the taxonomy.
-
-
normalizeProfessions(List<String>) - Method in class com.textkernel.tx.TxClient
-
-
Normalize the given job titles to the most closely-related professions in the taxonomy.
-
-
NormalizeProfessionsRequest - Class in com.textkernel.tx.models.api.dataenrichment.professions.request
-
-
Request body for a 'NormalizeProfessions' request
-
-
NormalizeProfessionsRequest() - Constructor for class com.textkernel.tx.models.api.dataenrichment.professions.request.NormalizeProfessionsRequest
-
 
-
NormalizeProfessionsResponse - Class in com.textkernel.tx.models.api.dataenrichment.professions.response
-
-
The response body from a NormalizeProfessions API call
-
-
NormalizeProfessionsResponse() - Constructor for class com.textkernel.tx.models.api.dataenrichment.professions.response.NormalizeProfessionsResponse
-
 
-
NormalizeProfessionsResponseValue - Class in com.textkernel.tx.models.api.dataenrichment.professions.response
-
-
One entry in the ApiResponse.Value from a 'NormalizeProfessions' response
-
-
NormalizeProfessionsResponseValue() - Constructor for class com.textkernel.tx.models.api.dataenrichment.professions.response.NormalizeProfessionsResponseValue
-
 
-
NormalizerData - Variable in class com.textkernel.tx.models.api.parsing.BasicParseOptions
-
-
Deprecated. -
use BasicParseOptions.SkillsSettings and BasicParseOptions.ProfessionsSettings instead
-
-
-
normalizeSkills(List<String>, String, String) - Method in class com.textkernel.tx.TxClient
-
-
Normalize the given skills to the most closely-related skills in the taxonomy.
-
-
normalizeSkills(List<String>) - Method in class com.textkernel.tx.TxClient
-
-
Normalize the given skills to the most closely-related skills in the taxonomy.
-
-
NormalizeSkillsRequest - Class in com.textkernel.tx.models.api.dataenrichment.skills.request
-
-
Request body for a 'NormalizeSkills' request
-
-
NormalizeSkillsRequest() - Constructor for class com.textkernel.tx.models.api.dataenrichment.skills.request.NormalizeSkillsRequest
-
 
-
NormalizeSkillsResponse - Class in com.textkernel.tx.models.api.dataenrichment.skills.response
-
-
The response body from a NormalizeSkills API call
-
-
NormalizeSkillsResponse() - Constructor for class com.textkernel.tx.models.api.dataenrichment.skills.response.NormalizeSkillsResponse
-
 
-
NormalizeSkillsResponseValue - Class in com.textkernel.tx.models.api.dataenrichment.skills.response
-
-
One entry in the ApiResponse.Value from a 'NormalizeSkills' response
-
-
NormalizeSkillsResponseValue() - Constructor for class com.textkernel.tx.models.api.dataenrichment.skills.response.NormalizeSkillsResponseValue
-
 
-
normalizeSkillsV2(List<String>, String, String) - Method in class com.textkernel.tx.TxClient
-
-
Normalize the given skills to the most closely-related skills in the taxonomy.
-
-
normalizeSkillsV2(List<String>) - Method in class com.textkernel.tx.TxClient
-
-
Normalize the given skills to the most closely-related skills in the taxonomy.
-
-
NotFound - Variable in class com.textkernel.tx.models.api.matching.response.JobTitlesScoreData
-
-
List of terms requested, but not found.
-
-
NotFound - Variable in class com.textkernel.tx.models.api.matching.response.SimpleCategoryScoreData
-
-
List of terms requested but not found
-
-
NotFound - Variable in class com.textkernel.tx.models.api.matching.response.SkillsScoreData
-
-
List of terms requested, but not found.
-
-
Number - Variable in class com.textkernel.tx.models.resume.NationalIdentity
-
-
The national identity number
-
-
NumberEmployeesSupervised - Variable in class com.textkernel.tx.models.resume.employment.Position
-
-
How many employees were supervised in this position/job
-
-
- - - -

O

-
-
Objective - Variable in class com.textkernel.tx.models.resume.ParsedResume
-
-
The candidate's written objective
-
-
ONET - Variable in class com.textkernel.tx.models.api.dataenrichment.professions.ProfessionNormalizationVersions
-
-
The ONET Version to use when normalizing Professions.
-
-
Onet - Variable in class com.textkernel.tx.models.dataenrichment.Profession
-
-
/// The O*NET 2010 (deprecated) details of this profession.
-
-
ONET - Variable in class com.textkernel.tx.models.resume.employment.ParsingNormalizedProfession
-
-
The object of the ONET profession concept
-
-
Onet2019 - Variable in class com.textkernel.tx.models.dataenrichment.Profession
-
-
/// The O*NET 2019 details of this profession.
-
-
ONETVersion - Enum in com.textkernel.tx.models.api.dataenrichment.professions
-
-
Available ONET Versions
-
-
Options - Variable in class com.textkernel.tx.models.api.matching.ui.UserDefinedTagsPicklist
-
-
A list of user-defined tags that the user will be able to pick from
-
-
Organization - Variable in class com.textkernel.tx.models.api.jobdescription.GenerateJobRequest
-
-
The organization offering the job.
-
-
Organization - Variable in class com.textkernel.tx.models.resume.Association
-
-
The name of the association/organization
-
-
OtherData - Variable in class com.textkernel.tx.models.resume.metadata.ReservedData
-
-
Any other PII that should be redacted
-
-
OutputCandidateImage - Variable in class com.textkernel.tx.models.api.parsing.ParseOptions
-
-
Only used for resumes.
-
-
OutputDocumentFormat - Enum in com.textkernel.tx.models.api.formatter
-
-
The document type to be output by the formatter endpoint
-
-
OutputHtml - Variable in class com.textkernel.tx.models.api.parsing.ParseOptions
-
-
true to output the document converted to HTML
-
-
OutputLanguage - Variable in class com.textkernel.tx.models.api.dataenrichment.AutocompleteRequest
-
-
The language to ouput the found professions in (default is 'en').
-
-
OutputLanguage - Variable in class com.textkernel.tx.models.api.dataenrichment.ontology.request.CompareProfessionsRequest
-
-
The language to use for the returned descriptions.
-
-
OutputLanguage - Variable in class com.textkernel.tx.models.api.dataenrichment.ontology.request.CompareSkillsToProfessionRequest
-
-
The language to use for the returned descriptions.
-
-
OutputLanguage - Variable in class com.textkernel.tx.models.api.dataenrichment.ontology.request.SuggestProfessionsRequest
-
-
The language to use for the returned descriptions.
-
-
OutputLanguage - Variable in class com.textkernel.tx.models.api.dataenrichment.ontology.request.SuggestSkillsFromProfessionsRequest
-
-
The language to use for the returned descriptions.
-
-
OutputLanguage - Variable in class com.textkernel.tx.models.api.dataenrichment.ontology.request.SuggestSkillsFromSkillsRequest
-
-
The language to use for the returned descriptions.
-
-
OutputLanguage - Variable in class com.textkernel.tx.models.api.dataenrichment.professions.request.LookupProfessionCodesRequest
-
-
The language to use for professions descriptions (default is en).
-
-
OutputLanguage - Variable in class com.textkernel.tx.models.api.dataenrichment.professions.request.NormalizeProfessionsRequest
-
-
The language to use for descriptions of the returned normalized professions.
-
-
OutputLanguage - Variable in class com.textkernel.tx.models.api.dataenrichment.skills.request.ExtractSkillsRequest
-
-
The language to use for the output skill descriptions.
-
-
OutputLanguage - Variable in class com.textkernel.tx.models.api.dataenrichment.skills.request.LookupSkillsRequest
-
-
The language to use for the output skill descriptions.
-
-
OutputLanguage - Variable in class com.textkernel.tx.models.api.dataenrichment.skills.request.NormalizeSkillsRequest
-
-
The language to use for the output skill descriptions.
-
-
OutputPdf - Variable in class com.textkernel.tx.models.api.parsing.ParseOptions
-
-
true to output the document converted to PDF
-
-
OutputRtf - Variable in class com.textkernel.tx.models.api.parsing.ParseOptions
-
-
true to output the document converted to RTF
-
-
OutputType - Variable in class com.textkernel.tx.models.api.formatter.FormatResumeRequest
-
-
The output document type
-
-
OutputValidityCode - Variable in class com.textkernel.tx.models.api.parsing.ConversionMetadata
-
-
The computed validity based on the source text.
-
-
OwnerId - Variable in class com.textkernel.tx.models.matching.Index
-
-
The account id of the owner for this index
-
-
Owners - Variable in class com.textkernel.tx.models.job.ParsedJob
-
-
Any owners of the job posting, if listed.
-
-
- - - -

P

-
-
PaginationSettings - Class in com.textkernel.tx.models.api.matching.request
-
-
Settings for pagination of results
-
-
PaginationSettings() - Constructor for class com.textkernel.tx.models.api.matching.request.PaginationSettings
-
 
-
PaginationSettings - Variable in class com.textkernel.tx.models.api.matching.SearchRequest
-
-
Used to choose which results to return from the list.
-
-
Parler - Static variable in class com.textkernel.tx.models.resume.contactinfo.WebAddressType
-
-
A Parler username
-
-
ParsedDocument - Class in com.textkernel.tx.models
-
-
Base class for parsed resumes/jobs
-
-
ParsedDocument() - Constructor for class com.textkernel.tx.models.ParsedDocument
-
 
-
ParsedDocumentMetadata - Class in com.textkernel.tx.models
-
-
Metadata about a parsed document
-
-
ParsedDocumentMetadata() - Constructor for class com.textkernel.tx.models.ParsedDocumentMetadata
-
 
-
ParsedJob - Class in com.textkernel.tx.models.job
-
-
All of the information extracted while parsing a job
-
-
ParsedJob() - Constructor for class com.textkernel.tx.models.job.ParsedJob
-
-
Deprecated. -
You should never create one of these. Instead, these are output by the Job Parser. - The API does not support manually-created jobs to be used in the AI Matching engine.
-
-
-
ParsedJobWithId - Class in com.textkernel.tx.models.api.bimetricscoring
-
-
A ParsedJob and id pair for a bimetric score request
-
-
ParsedJobWithId() - Constructor for class com.textkernel.tx.models.api.bimetricscoring.ParsedJobWithId
-
 
-
ParsedResume - Class in com.textkernel.tx.models.resume
-
-
All of the information extracted while parsing a resume
-
-
ParsedResume() - Constructor for class com.textkernel.tx.models.resume.ParsedResume
-
-
Deprecated. -
You should never create one of these. Instead, these are output by the Resume Parser. - The API does not support manually-created resumes to be used in the AI Matching engine.
-
-
-
ParsedResumeWithId - Class in com.textkernel.tx.models.api.bimetricscoring
-
-
A ParsedResume and id pair for a bimetric score request
-
-
ParsedResumeWithId() - Constructor for class com.textkernel.tx.models.api.bimetricscoring.ParsedResumeWithId
-
 
-
parseJob(ParseRequest) - Method in class com.textkernel.tx.TxClient
-
-
Parse a job
-
-
ParseJobResponse - Class in com.textkernel.tx.models.api.parsing
-
-
The response body from a ParseJob API call
-
-
ParseJobResponse() - Constructor for class com.textkernel.tx.models.api.parsing.ParseJobResponse
-
 
-
ParseJobResponseValue - Class in com.textkernel.tx.models.api.parsing
-
-
The ApiResponse.Value from a Parse response
-
-
ParseJobResponseValue() - Constructor for class com.textkernel.tx.models.api.parsing.ParseJobResponseValue
-
 
-
ParseOptions - Variable in class com.textkernel.tx.models.api.matching.ui.request.MatchUISettings
-
-
Options for parsing documents from external sources such as job boards - and custom web sourcing.
-
-
ParseOptions - Class in com.textkernel.tx.models.api.parsing
-
-
Options for parsing
-
-
ParseOptions() - Constructor for class com.textkernel.tx.models.api.parsing.ParseOptions
-
 
-
ParseRequest - Class in com.textkernel.tx.models.api.parsing
-
-
The request body for a Parse request
-
-
ParseRequest(Document, ParseOptions) - Constructor for class com.textkernel.tx.models.api.parsing.ParseRequest
-
 
-
parseResume(ParseRequest) - Method in class com.textkernel.tx.TxClient
-
-
Parse a resume
-
-
ParseResumeResponse - Class in com.textkernel.tx.models.api.parsing
-
-
The response body from a ParseResume API call
-
-
ParseResumeResponse() - Constructor for class com.textkernel.tx.models.api.parsing.ParseResumeResponse
-
 
-
ParseResumeResponseValue - Class in com.textkernel.tx.models.api.parsing
-
-
The ApiResponse.Value from a Parse response
-
-
ParseResumeResponseValue() - Constructor for class com.textkernel.tx.models.api.parsing.ParseResumeResponseValue
-
 
-
ParserSettings - Variable in class com.textkernel.tx.models.ParsedDocumentMetadata
-
-
The full parser settings that were used during parsing
-
-
ParserVersion - Variable in class com.textkernel.tx.models.api.parsing.ParsingMetadata
-
-
The version of the SaaS parser
-
-
ParsingMetadata - Variable in class com.textkernel.tx.models.api.parsing.BaseParseResponseValue
-
-
Information about the parsing transaction
-
-
ParsingMetadata - Class in com.textkernel.tx.models.api.parsing
-
-
Metadata about a parsing transaction
-
-
ParsingMetadata() - Constructor for class com.textkernel.tx.models.api.parsing.ParsingMetadata
-
 
-
ParsingNormalizedProfession - Class in com.textkernel.tx.models.resume.employment
-
-
Normalized profession related to a specific job title.
-
-
ParsingNormalizedProfession() - Constructor for class com.textkernel.tx.models.resume.employment.ParsingNormalizedProfession
-
 
-
ParsingResponse - Variable in class com.textkernel.tx.models.api.parsing.BaseParseResponseValue
-
-
The status of the parse transaction
-
-
PassportNumber - Variable in class com.textkernel.tx.models.resume.PersonalAttributes
-
-
The candidate's passport number listed on the resume
-
-
Patents - Variable in class com.textkernel.tx.models.resume.ParsedResume
-
-
Any patents listed on the resume
-
-
PayRange - Class in com.textkernel.tx.models.job
-
-
An object containing details about a job position's pay.
-
-
PayRange() - Constructor for class com.textkernel.tx.models.job.PayRange
-
 
-
PDF - Variable in class com.textkernel.tx.models.api.parsing.Conversions
-
-
If requested by ParseOptions.OutputPdf, this is the document converted to a PDF.
-
-
Percent - Variable in class com.textkernel.tx.models.skills.ProfessionClass
-
-
Percent of overall document that relates to this profession.
-
-
Percent - Variable in class com.textkernel.tx.models.skills.ProfessionGroup
-
-
Percent of overall document described by this profession group.
-
-
PercentOfOverall - Variable in class com.textkernel.tx.models.skills.FoundSubTaxonomy
-
-
The percent (0-100) of skills found in this subtaxonomy compared to all subtaxonomies
-
-
PercentOfOverall - Variable in class com.textkernel.tx.models.skills.FoundTaxonomy
-
-
The percent (0-100) of skills found in the document that belong to this taxonomy
-
-
PercentOfParent - Variable in class com.textkernel.tx.models.skills.FoundSubTaxonomy
-
-
The percent (0-100) of skills found in this subtaxonomy compared to other subtaxonomies in the parent taxonomy
-
-
PersonalAttributes - Variable in class com.textkernel.tx.models.resume.ParsedResume
-
-
Personal information provided by the candidate on the resume
-
-
PersonalAttributes - Class in com.textkernel.tx.models.resume
-
-
Personal attributes found on a resume
-
-
PersonalAttributes() - Constructor for class com.textkernel.tx.models.resume.PersonalAttributes
-
 
-
PersonalWebsite - Static variable in class com.textkernel.tx.models.resume.contactinfo.WebAddressType
-
-
A personal website URL
-
-
PersonName - Class in com.textkernel.tx.models.resume.contactinfo
-
-
A name broken into its constituent parts
-
-
PersonName() - Constructor for class com.textkernel.tx.models.resume.contactinfo.PersonName
-
 
-
Phones - Variable in class com.textkernel.tx.models.resume.metadata.ReservedData
-
-
All phone numbers found in the resume
-
-
Phrase - Variable in class com.textkernel.tx.models.resume.NationalIdentity
-
-
The type of identity/number this is (for example, SSN)
-
-
PlainText - Variable in class com.textkernel.tx.models.ParsedDocumentMetadata
-
-
The plain text that was used for parsing
-
-
Position - Class in com.textkernel.tx.models.resume.employment
-
-
A position/job on a resume
-
-
Position() - Constructor for class com.textkernel.tx.models.resume.employment.Position
-
 
-
Positions - Variable in class com.textkernel.tx.models.resume.employment.EmploymentHistory
-
-
A list of jobs/positions found on the resume
-
-
PositionTitlesMustHaveAnExactMatch - Variable in class com.textkernel.tx.models.api.matching.request.SearchMatchSettings
-
-
Set to true to turn off variation matches in job titles.
-
-
PostalAddress - Variable in class com.textkernel.tx.models.api.geocoding.GeocodeOptionsBase
-
-
The address you wish to geocode.
-
-
PostalCode - Variable in class com.textkernel.tx.models.api.geocoding.Address
-
-
The Postal or Zip code
-
-
PostalCode - Variable in class com.textkernel.tx.models.api.matching.request.FilterLocation
-
-
The Postal or Zip code
-
-
PostalCode - Variable in class com.textkernel.tx.models.Location
-
-
The Postal or Zip code
-
-
PostedDate - Variable in class com.textkernel.tx.models.job.ApplicationDetails
-
-
Date the job was posted
-
-
PreferredCategoryWeights - Variable in class com.textkernel.tx.models.api.bimetricscoring.BimetricScoreRequest
-
-
The weights you want to use for scoring.
-
-
PreferredCategoryWeights - Variable in class com.textkernel.tx.models.api.matching.request.MatchRequest
-
-
The weights you want to use for scoring.
-
-
PreferredLocation - Variable in class com.textkernel.tx.models.resume.PersonalAttributes
-
-
The candidate's preferred location listed on the resume
-
-
Prefix - Variable in class com.textkernel.tx.models.api.dataenrichment.AutocompleteRequest
-
-
The job title prefix to be completed.
-
-
Prefix - Variable in class com.textkernel.tx.models.resume.contactinfo.PersonName
-
-
A prefix for a name, such as Dr.
-
-
Primary - Variable in class com.textkernel.tx.models.api.matching.response.DocumentTaxonomies
-
-
Best fit taxonomy (industry) evidence.
-
-
PrimaryColor - Variable in class com.textkernel.tx.models.api.matching.ui.Style
-
-
An HTML color used to generate several related colors for various UI elements.
-
-
Priority - Variable in class com.textkernel.tx.models.api.jobdescription.GenerateJobSkill
-
-
Priority of the skill
-
-
Probability - Variable in class com.textkernel.tx.models.resume.employment.CompanyNameWithProbability
-
-
The degree of certainty that the company name is accurate.
-
-
Probability - Variable in class com.textkernel.tx.models.resume.employment.JobTitle
-
-
The degree of certainty that the job title value is accurate.
-
-
Profession - Class in com.textkernel.tx.models.dataenrichment
-
-
A normalized profession from the Professions Taxonomy
-
-
Profession() - Constructor for class com.textkernel.tx.models.dataenrichment.Profession
-
 
-
Profession - Variable in class com.textkernel.tx.models.resume.employment.ParsingNormalizedProfession
-
-
Object containing the details of the profession concept.
-
-
ProfessionACodeId - Variable in class com.textkernel.tx.models.api.dataenrichment.ontology.request.CompareProfessionsRequest
-
-
A profession code ID from the Professions Taxonomy to compare.
-
-
ProfessionalSummary - Variable in class com.textkernel.tx.models.resume.ParsedResume
-
-
The professional summary from the resume
-
-
ProfessionBCodeId - Variable in class com.textkernel.tx.models.api.dataenrichment.ontology.request.CompareProfessionsRequest
-
-
A profession code ID from the Professions Taxonomy to compare.
-
-
ProfessionClass - Class in com.textkernel.tx.models.skills
-
-
Profession Class that describes a percentage of the source document.
-
-
ProfessionClass() - Constructor for class com.textkernel.tx.models.skills.ProfessionClass
-
 
-
ProfessionClassification<T> - Class in com.textkernel.tx.models.dataenrichment
-
-
Object representing a profession concept
-
-
ProfessionClassification() - Constructor for class com.textkernel.tx.models.dataenrichment.ProfessionClassification
-
 
-
ProfessionClassification<T> - Class in com.textkernel.tx.models.resume.employment
-
-
Object representing a profession concept
-
-
ProfessionClassification() - Constructor for class com.textkernel.tx.models.resume.employment.ProfessionClassification
-
 
-
ProfessionCodeId - Variable in class com.textkernel.tx.models.api.dataenrichment.ontology.request.CompareSkillsToProfessionRequest
-
-
The profession code ID from the Professions Taxonomy to compare the skill set to.
-
-
ProfessionCodeId - Variable in class com.textkernel.tx.models.api.dataenrichment.ontology.response.ProfessionExclusiveSkills
-
-
The code ID of the profession in the Professions Taxonomy.
-
-
ProfessionCodeIds - Variable in class com.textkernel.tx.models.api.dataenrichment.ontology.request.SuggestSkillsFromProfessionsRequest
-
-
The profession code IDs from the Professions Taxonomy for which the service should return related skills.
-
-
ProfessionExclusiveSkills - Class in com.textkernel.tx.models.api.dataenrichment.ontology.response
-
-
An exclusive skill per profession.
-
-
ProfessionExclusiveSkills() - Constructor for class com.textkernel.tx.models.api.dataenrichment.ontology.response.ProfessionExclusiveSkills
-
 
-
ProfessionGroup - Class in com.textkernel.tx.models.skills
-
-
Profession Group that describes a percentage of the Profession Class.
-
-
ProfessionGroup() - Constructor for class com.textkernel.tx.models.skills.ProfessionGroup
-
 
-
ProfessionMultipleDescriptions - Class in com.textkernel.tx.models.dataenrichment
-
-
A skill object.
-
-
ProfessionMultipleDescriptions() - Constructor for class com.textkernel.tx.models.dataenrichment.ProfessionMultipleDescriptions
-
-
The description of the skill in the requested language.
NOTE: if multiple languages were requested, this is simply the first from Descriptions
-
-
ProfessionNormalizationResponse - Variable in class com.textkernel.tx.models.api.parsing.BaseParseResponseValue
-
-
If profession normalization was requested in the BasicParseOptions.ProfessionsSettings, - the status of the profession normalization transaction will be output here
-
-
ProfessionNormalizationVersions - Class in com.textkernel.tx.models.api.dataenrichment.professions
-
-
Versions to use when normalizing professions if more than one is available for a taxonomy
-
-
ProfessionNormalizationVersions() - Constructor for class com.textkernel.tx.models.api.dataenrichment.professions.ProfessionNormalizationVersions
-
 
-
Professions - Variable in class com.textkernel.tx.models.api.dataenrichment.professions.response.GetProfessionsTaxonomyResponseValue
-
-
A list of returned professions.
-
-
Professions - Variable in class com.textkernel.tx.models.api.dataenrichment.professions.response.LookupProfessionCodesResponseValue
-
-
A list of returned professions.
-
-
Professions - Variable in class com.textkernel.tx.models.api.dataenrichment.professions.response.NormalizeProfessionsResponseValue
-
-
A list of returned professions.
-
-
Professions - Variable in class com.textkernel.tx.models.api.dataenrichment.professions.response.ProfessionsAutoCompleteResponseValue
-
-
A list of professions that match the given Prefix.
-
-
ProfessionsAutoCompleteResponse - Class in com.textkernel.tx.models.api.dataenrichment.professions.response
-
-
The response body from a ProfessionsAutocomplete API call
-
-
ProfessionsAutoCompleteResponse() - Constructor for class com.textkernel.tx.models.api.dataenrichment.professions.response.ProfessionsAutoCompleteResponse
-
 
-
ProfessionsAutoCompleteResponseValue - Class in com.textkernel.tx.models.api.dataenrichment.professions.response
-
-
One entry in the ApiResponse.Value from a 'ProfessionsAutocomplete' response
-
-
ProfessionsAutoCompleteResponseValue() - Constructor for class com.textkernel.tx.models.api.dataenrichment.professions.response.ProfessionsAutoCompleteResponseValue
-
 
-
ProfessionsSettings - Variable in class com.textkernel.tx.models.api.parsing.BasicParseOptions
-
-
Enable normalization of job titles using our proprietary taxonomy and international standards.
-
-
ProfessionsSettings - Class in com.textkernel.tx.models.api.parsing
-
-
Enable normalization of job titles using our proprietary taxonomy and international standards.
-
-
ProfessionsSettings() - Constructor for class com.textkernel.tx.models.api.parsing.ProfessionsSettings
-
 
-
Prompt - Variable in class com.textkernel.tx.models.api.parsing.FlexRequest
-
-
The prompt to be sent to the LLM Parsing Engine
-
-
Provider - Variable in class com.textkernel.tx.models.api.geocoding.GeocodeCredentials
-
-
The provider you wish to use to geocode the postal address.
-
-
ProviderKey - Variable in class com.textkernel.tx.models.api.geocoding.GeocodeCredentials
-
-
Your private API key for the geocoding provider.
-
-
Publications - Variable in class com.textkernel.tx.models.resume.ParsedResume
-
-
Any publications listed on the resume
-
-
- - - -

Q

-
-
QQ - Static variable in class com.textkernel.tx.models.resume.contactinfo.WebAddressType
-
-
A QQ username/number
-
-
Qualifications - Variable in class com.textkernel.tx.models.resume.TrainingDetails
-
-
Any text within the TrainingDetails.Text that is recognized as a qualification (such as DDS), - degree (such as B.S.), or a certification (such as PMP).
-
-
QualificationsSummary - Variable in class com.textkernel.tx.models.resume.ParsedResume
-
-
A standalone 'skills' section, if listed on the resume
-
-
QualityCode - Variable in class com.textkernel.tx.models.resume.metadata.ResumeQualityFinding
-
-
A unique 3-digit code to identify what type of issue was found.
-
-
Quora - Static variable in class com.textkernel.tx.models.resume.contactinfo.WebAddressType
-
-
A Quora username
-
-
- - - -

R

-
-
Rank - Variable in class com.textkernel.tx.models.resume.military.MilitaryService
-
-
The military rank of the candidate
-
-
Raw - Variable in class com.textkernel.tx.models.job.skills.JobV2Skills
-
-
Array of skills exactly as found in the plain text of the document.
-
-
Raw - Variable in class com.textkernel.tx.models.resume.employment.JobTitle
-
-
The raw text as it was found in the resume
-
-
Raw - Variable in class com.textkernel.tx.models.resume.NormalizedString
-
-
The raw value found in the text
-
-
Raw - Variable in class com.textkernel.tx.models.resume.skills.ResumeV2Skills
-
-
Array of skills exactly as found in the plain text of the document.
-
-
RawMaximum - Variable in class com.textkernel.tx.models.job.PayRange
-
-
The raw, un-normalized, maximum value.
-
-
RawMinimum - Variable in class com.textkernel.tx.models.job.PayRange
-
-
The raw, un-normalized, minimum value.
-
-
RawSkill - Class in com.textkernel.tx.models.skills
-
-
Skill exactly as it was found in the plain text of the document.
-
-
RawSkill() - Constructor for class com.textkernel.tx.models.skills.RawSkill
-
 
-
RawSkills - Variable in class com.textkernel.tx.models.skills.NormalizedSkill
-
-
Array of raw skills that were extracted that normalized to this skill.
-
-
RawTerm - Variable in class com.textkernel.tx.models.api.matching.response.FoundJobTitle
-
-
Exact term found.
-
-
RawText - Variable in class com.textkernel.tx.models.dataenrichment.NormalizedSkill
-
-
The raw text that matched to a skill description in the provided language.
-
-
RawText - Variable in class com.textkernel.tx.models.dataenrichment.SkillMatch
-
-
The actual term that was found as evidence of this skill (the substring from BeginSpan to EndSpan).
-
-
RedactedResumeData - Variable in class com.textkernel.tx.models.api.parsing.ParseResumeResponseValue
-
-
Similar to ParseResumeResponseValue.ResumeData, but with all of the - Personally Identifiable Information (PII) redacted.
-
-
Reddit - Static variable in class com.textkernel.tx.models.resume.contactinfo.WebAddressType
-
-
A Reddit username/URL
-
-
ReferenceName - Variable in class com.textkernel.tx.models.resume.CandidateReference
-
-
The name of the reference
-
-
ReferenceNumber - Variable in class com.textkernel.tx.models.job.ApplicationDetails
-
-
Any reference number found for the job application
-
-
References - Variable in class com.textkernel.tx.models.resume.ParsedResume
-
-
References listed on a resume.
-
-
Region - Variable in class com.textkernel.tx.models.api.AccountInfo
-
-
The region for the account, also known as the 'Data Center'
-
-
Region - Variable in class com.textkernel.tx.models.api.geocoding.Address
-
-
The Region/District/State
-
-
Region - Variable in class com.textkernel.tx.models.api.matching.request.FilterLocation
-
-
The Region/District/State
-
-
Regions - Variable in class com.textkernel.tx.models.Location
-
-
The Regions/Districts/States
-
-
RelatedProfessionClasses - Variable in class com.textkernel.tx.models.job.skills.JobV2Skills
-
-
Professions most related to the document.
-
-
RelatedProfessionClasses - Variable in class com.textkernel.tx.models.resume.skills.ResumeV2Skills
-
-
Professions most related to the document.
-
-
RelatedToByCompanyName - Variable in class com.textkernel.tx.models.resume.employment.Position
-
-
A list of Position.Ids that have the same Employer as this Position
-
-
RelatedToByDates - Variable in class com.textkernel.tx.models.resume.employment.Position
-
-
A list of Position.Ids that have overlapping dates with this Position
-
-
Reply - Variable in class com.textkernel.tx.models.api.parsing.FlexResponseItem
-
-
Reply to the FlexRequest Prompt
-
-
ReplyList - Variable in class com.textkernel.tx.models.api.parsing.FlexResponseItem
-
-
List of replies to the FlexRequest Prompt if the FlexRequest had a FlexRequestDataType.Enumeration DataType
-
-
RequestBody - Variable in exception com.textkernel.tx.exceptions.TxException
-
-
The JSON request body, will only have a value if TxClient.ShowFullRequestBodyInExceptions is true
-
-
Required - Variable in class com.textkernel.tx.models.job.skills.JobNormalizedSkill
-
-
true if this skill was listed as 'required' on the job description
-
-
Required - Variable in class com.textkernel.tx.models.job.skills.JobRawSkill
-
-
true if this skill was listed as 'required' on the job description
-
-
Required - Variable in class com.textkernel.tx.models.job.skills.JobSkillVariation
-
-
true if this skill was listed as 'required' on the job description
-
-
RequiredDegree - Variable in class com.textkernel.tx.models.job.ParsedJob
-
-
The required educational degree, if listed.
-
-
RequiredSalary - Variable in class com.textkernel.tx.models.resume.PersonalAttributes
-
-
The candidate's required salary listed on the resume
-
-
ReservedData - Class in com.textkernel.tx.models.resume.metadata
-
-
Used to redact PII
-
-
ReservedData() - Constructor for class com.textkernel.tx.models.resume.metadata.ReservedData
-
 
-
ReservedData - Variable in class com.textkernel.tx.models.resume.metadata.ResumeMetadata
-
-
Used to redact PII.
-
-
Response - Variable in exception com.textkernel.tx.exceptions.TxUsableJobException
-
-
This may or may not be null or incomplete depending on what specific error occurred
-
-
Response - Variable in exception com.textkernel.tx.exceptions.TxUsableResumeException
-
-
This may or may not be null or incomplete depending on what specific error occurred
-
-
Responses - Variable in class com.textkernel.tx.models.api.parsing.FlexResponse
-
-
Responses to FlexRequests
-
-
RestResponse - Variable in exception com.textkernel.tx.exceptions.TxException
-
-
The raw response from the API
-
-
ResumeData - Variable in class com.textkernel.tx.models.api.bimetricscoring.ParsedResumeWithId
-
-
A resume generated by the resume parser
-
-
ResumeData - Variable in class com.textkernel.tx.models.api.formatter.FormatResumeRequest
-
-
The resume to use to populate the template
-
-
ResumeData - Variable in class com.textkernel.tx.models.api.geocoding.GeocodeAndIndexResumeRequest
-
-
The resume you wish to be geocoded/indexed
-
-
ResumeData - Variable in class com.textkernel.tx.models.api.geocoding.GeocodeAndIndexResumeResponseValue
-
-
The resume you sent to be geocoded/indexed with geolocation coordinates added
-
-
ResumeData - Variable in class com.textkernel.tx.models.api.geocoding.GeocodeResumeRequest
-
-
The resume you wish to be geocoded
-
-
ResumeData - Variable in class com.textkernel.tx.models.api.geocoding.GeocodeResumeResponseValue
-
-
The resume you sent to be geocoded with geolocation coordinates added
-
-
ResumeData - Variable in class com.textkernel.tx.models.api.indexes.IndexResumeInfo
-
-
A resume to index
-
-
ResumeData - Variable in class com.textkernel.tx.models.api.indexes.IndexResumeRequest
-
-
A resume to index
-
-
ResumeData - Variable in class com.textkernel.tx.models.api.matching.MatchResumeRequest
-
-
The resume to match.
-
-
ResumeData - Variable in class com.textkernel.tx.models.api.parsing.ParseResumeResponseValue
-
-
The main output from the Resume Parser
-
-
ResumeMetadata - Class in com.textkernel.tx.models.resume.metadata
-
-
Metadata about a parsed resume
-
-
ResumeMetadata() - Constructor for class com.textkernel.tx.models.resume.metadata.ResumeMetadata
-
 
-
ResumeMetadata - Variable in class com.textkernel.tx.models.resume.ParsedResume
-
-
Metadata about the parsed resume
-
-
ResumeNormalizedSkill - Class in com.textkernel.tx.models.resume.skills
-
-
Normalized skill concept representing one or more raw skills that were extracted.
-
-
ResumeNormalizedSkill() - Constructor for class com.textkernel.tx.models.resume.skills.ResumeNormalizedSkill
-
 
-
ResumeQuality - Variable in class com.textkernel.tx.models.resume.metadata.ResumeMetadata
-
-
This is an advanced level feature.
-
-
ResumeQualityAssessment - Class in com.textkernel.tx.models.resume.metadata
-
-
A list of ResumeQualityFinding of the same level/severity
-
-
ResumeQualityAssessment() - Constructor for class com.textkernel.tx.models.resume.metadata.ResumeQualityAssessment
-
 
-
ResumeQualityFinding - Class in com.textkernel.tx.models.resume.metadata
-
-
A single resume quality issue
-
-
ResumeQualityFinding() - Constructor for class com.textkernel.tx.models.resume.metadata.ResumeQualityFinding
-
 
-
ResumeQualityLevel - Class in com.textkernel.tx.models.resume.metadata
-
-
The level/severity of a ResumeQualityAssessment
-
-
ResumeRawSkill - Class in com.textkernel.tx.models.resume.skills
-
-
Skill exactly as it was found in the plain text of the document.
-
-
ResumeRawSkill() - Constructor for class com.textkernel.tx.models.resume.skills.ResumeRawSkill
-
 
-
Resumes - Variable in class com.textkernel.tx.models.api.indexes.IndexMultipleResumesRequest
-
-
The resumes to add into the index
-
-
ResumeSection - Class in com.textkernel.tx.models.resume.metadata
-
-
A section in the resume (work history, education, etc)
-
-
ResumeSection() - Constructor for class com.textkernel.tx.models.resume.metadata.ResumeSection
-
 
-
ResumeSkill - Class in com.textkernel.tx.models.resume.skills
-
-
A skill listed in a resume or job
-
-
ResumeSkill() - Constructor for class com.textkernel.tx.models.resume.skills.ResumeSkill
-
 
-
ResumeSkillVariation - Class in com.textkernel.tx.models.resume.skills
-
-
A skill listed in a resume or job
-
-
ResumeSkillVariation() - Constructor for class com.textkernel.tx.models.resume.skills.ResumeSkillVariation
-
 
-
ResumeSubTaxonomy - Class in com.textkernel.tx.models.resume.skills
-
-
A subtaxonomy to group similar skills
-
-
ResumeSubTaxonomy() - Constructor for class com.textkernel.tx.models.resume.skills.ResumeSubTaxonomy
-
 
-
ResumeTaxonomy - Class in com.textkernel.tx.models.resume.skills
-
-
A container to group similar skills subtaxonomies (see ResumeSubTaxonomy)
-
-
ResumeTaxonomy() - Constructor for class com.textkernel.tx.models.resume.skills.ResumeTaxonomy
-
 
-
ResumeTaxonomyRoot - Class in com.textkernel.tx.models.resume.skills
-
-
A container for skills taxonomies found in a resume
-
-
ResumeTaxonomyRoot() - Constructor for class com.textkernel.tx.models.resume.skills.ResumeTaxonomyRoot
-
 
-
ResumeV2Skills - Class in com.textkernel.tx.models.resume.skills
-
-
Skills output when version 2 of the taxonomy is utilized.
-
-
ResumeV2Skills() - Constructor for class com.textkernel.tx.models.resume.skills.ResumeV2Skills
-
 
-
ReturnMissingSkills - Variable in class com.textkernel.tx.models.api.dataenrichment.ontology.request.SuggestProfessionsRequest
-
-
Flag to enable returning a list of missing skills per suggested profession.
-
-
ReverseCompatibilityScore - Variable in class com.textkernel.tx.models.api.bimetricscoring.BimetricScoreResult
-
-
An integer score from 0-100 which represents how well the target document matched to the source document.
-
-
ReverseCompatibilityScore - Variable in class com.textkernel.tx.models.api.matching.response.MatchResult
-
-
An integer score from 0-100 which represents how well the target document matched to the source document.
-
-
RevisionDateRange - Variable in class com.textkernel.tx.models.api.matching.request.FilterCriteria
-
-
When specified, the revision date of documents must fall within this range.
-
-
RevisionDateRange - Class in com.textkernel.tx.models.api.matching.request
-
-
A range of revision dates in ISO 8601 (yyyy-MM-dd) format
-
-
RevisionDateRange() - Constructor for class com.textkernel.tx.models.api.matching.request.RevisionDateRange
-
 
-
Role - Variable in class com.textkernel.tx.models.resume.Association
-
-
The role the candidate held
-
-
Root - Variable in class com.textkernel.tx.models.job.skills.JobTaxonomyRoot
-
-
The name of the skills list that these taxonomies belong to
-
-
Root - Variable in class com.textkernel.tx.models.resume.skills.ResumeTaxonomyRoot
-
-
The name of the skills list that these taxonomies belong to
-
-
RTF - Variable in class com.textkernel.tx.models.api.parsing.Conversions
-
-
If requested by ParseOptions.OutputRtf, this is the document converted to RTF.
-
-
- - - -

S

-
-
SaasRequest - Variable in class com.textkernel.tx.models.api.matching.ui.request.GenerateUIRequest
-
-
The SaaS request that defines the match/search.
-
-
Salary - Variable in class com.textkernel.tx.models.job.ParsedJob
-
-
The salary found for the position.
-
-
Salary - Class in com.textkernel.tx.models.resume
-
-
A salary found in a resume
-
-
Salary() - Constructor for class com.textkernel.tx.models.resume.Salary
-
 
-
SchoolName - Variable in class com.textkernel.tx.models.resume.education.EducationDetails
-
-
The name of the school attended
-
-
SchoolNames - Variable in class com.textkernel.tx.models.api.matching.request.FilterCriteria
-
-
Results must have at least one of the specified school names.
-
-
SchoolNames - Variable in class com.textkernel.tx.models.job.ParsedJob
-
-
Any school names listed in the job
-
-
SchoolType - Variable in class com.textkernel.tx.models.resume.education.EducationDetails
-
-
The type of the school attended.
-
-
Score - Variable in class com.textkernel.tx.models.api.dataenrichment.ontology.response.SkillScore
-
-
A value from [0 - 1] indicating how relative this skill is to all of the given professions.
-
-
Score - Variable in class com.textkernel.tx.models.api.dataenrichment.ontology.response.SuggestedProfession
-
-
A value from [0 - 1] indicating how relative the given skills are to this profession.
-
-
Score - Variable in class com.textkernel.tx.models.resume.education.GradePointAverage
-
-
The score found in the resume
-
-
ScoringSystem - Variable in class com.textkernel.tx.models.resume.education.GradePointAverage
-
-
The scoring system used on the resume
-
-
search(List<String>, FilterCriteria, SearchMatchSettings, PaginationSettings) - Method in class com.textkernel.tx.TxClient
-
-
Search for resumes or jobs that meet specific criteria
-
-
search(List<String>, FilterCriteria, SearchMatchSettings, PaginationSettings) - Method in class com.textkernel.tx.TxUIClient
-
-
Create a Matching UI session to search for resumes or jobs that meet specific criteria
-
-
SearchExpression - Variable in class com.textkernel.tx.models.api.matching.request.FilterCriteria
-
-
Full-text boolean semantic expresion.
-
-
SearchMatchRequestBase - Class in com.textkernel.tx.models.api.matching.request
-
-
Base class for match/search requests
-
-
SearchMatchRequestBase() - Constructor for class com.textkernel.tx.models.api.matching.request.SearchMatchRequestBase
-
 
-
SearchMatchSettings - Class in com.textkernel.tx.models.api.matching.request
-
-
Settings for searching/matching
-
-
SearchMatchSettings() - Constructor for class com.textkernel.tx.models.api.matching.request.SearchMatchSettings
-
 
-
SearchRequest - Class in com.textkernel.tx.models.api.matching
-
-
Request body for a search request
-
-
SearchRequest() - Constructor for class com.textkernel.tx.models.api.matching.SearchRequest
-
 
-
SearchResponse - Class in com.textkernel.tx.models.api.matching
-
-
The response body from a Search API call
-
-
SearchResponse() - Constructor for class com.textkernel.tx.models.api.matching.SearchResponse
-
 
-
SearchResponseValue - Class in com.textkernel.tx.models.api.matching
-
-
The ApiResponse.Value from a Search response
-
-
SearchResponseValue() - Constructor for class com.textkernel.tx.models.api.matching.SearchResponseValue
-
 
-
SearchResult - Class in com.textkernel.tx.models.api.matching.response
-
-
A single result from a search query
-
-
SearchResult() - Constructor for class com.textkernel.tx.models.api.matching.response.SearchResult
-
 
-
Secondary - Variable in class com.textkernel.tx.models.api.matching.response.DocumentTaxonomies
-
-
Second best fit taxonomy (industry) evidence.
-
-
SectionIdentifier - Class in com.textkernel.tx.models.resume
-
-
Information about a particular section of a resume
-
-
SectionIdentifier() - Constructor for class com.textkernel.tx.models.resume.SectionIdentifier
-
 
-
SectionIdentifiers - Variable in class com.textkernel.tx.models.resume.metadata.ResumeQualityFinding
-
-
If applicable, areas in the resume where this issue was found or that are affected by this issue.
-
-
SectionType - Variable in class com.textkernel.tx.models.resume.metadata.ResumeSection
-
-
The type of section.
-
-
SectionType - Variable in class com.textkernel.tx.models.resume.SectionIdentifier
-
-
The section type
-
-
SecurityCredential - Class in com.textkernel.tx.models.resume.military
-
-
A security credential/clearance found on a resume
-
-
SecurityCredential() - Constructor for class com.textkernel.tx.models.resume.military.SecurityCredential
-
 
-
SecurityCredentials - Variable in class com.textkernel.tx.models.api.matching.request.FilterCriteria
-
-
Results must have/require at least one of the security credentials specified.
-
-
SecurityCredentials - Variable in class com.textkernel.tx.models.resume.ParsedResume
-
-
Any security credentials/clearances listed on the resume
-
-
serialize(Object) - Static method in class com.textkernel.tx.utilities.TxJsonSerializer
-
 
-
serialize(Object, boolean) - Static method in class com.textkernel.tx.utilities.TxJsonSerializer
-
 
-
Server - Variable in class com.textkernel.tx.models.api.matching.ui.hooks.UserActionHookCollection
-
-
The server-side (HTTP POST) - User Action Hooks - for a Matching UI session.
-
-
ServerSideHook - Class in com.textkernel.tx.models.api.matching.ui.hooks
-
-
A hook that does some server-side action (performs an HTTP POST to your server)
-
-
ServerSideHook() - Constructor for class com.textkernel.tx.models.api.matching.ui.hooks.ServerSideHook
-
 
-
Service - Variable in class com.textkernel.tx.models.resume.military.MilitaryDetails
-
-
The branch/name/rank for this post/job
-
-
ServiceVersion - Variable in class com.textkernel.tx.models.dataenrichment.TaxonomyMetadata
-
-
The version number of the professions service.
-
-
Settings - Variable in class com.textkernel.tx.models.api.bimetricscoring.BimetricScoreRequest
-
-
The settings to use during scoring calculations
-
-
Settings - Variable in class com.textkernel.tx.models.api.matching.request.SearchMatchRequestBase
-
-
The settings to use during searching/matching queries
-
-
ShowBanner - Variable in class com.textkernel.tx.models.api.matching.ui.UIOptions
-
-
true to show the banner containing your account logo inside the matching UI (default = true).
-
-
ShowDetailsButton - Variable in class com.textkernel.tx.models.api.matching.ui.UIOptions
-
-
true to show a button that opens the 'details' popup containing detailed job/resume info (default = true).
-
-
ShowFilterCriteria - Variable in class com.textkernel.tx.models.api.matching.ui.UIOptions
-
-
true to allow the user to see/modify the filter criteria (default = true).
-
-
ShowFindSimilar - Variable in class com.textkernel.tx.models.api.matching.ui.UIOptions
-
-
true to add a button in the Actions menu that matches other jobs/resumes similar to the current one (default = true).
-
-
ShowFullRequestBodyInExceptions - Variable in class com.textkernel.tx.TxClient
-
-
Set to true for debugging API errors.
-
-
ShowJobBoards - Variable in class com.textkernel.tx.models.api.matching.ui.UIOptions
-
-
true to include job boards in search/match results.
-
-
ShowSavedSearches - Variable in class com.textkernel.tx.models.api.matching.ui.UIOptions
-
-
true to allow the user to save custom searches or select from pre-made criteria templates (default = false).
-
-
ShowWebSourcing - Variable in class com.textkernel.tx.models.api.matching.ui.UIOptions
-
-
true to include custom web sourcing in search/match results.
-
-
ShowWeights - Variable in class com.textkernel.tx.models.api.matching.ui.UIOptions
-
-
true to allow the user to see/modify the category weights (default = true).
-
-
Signal - Static variable in class com.textkernel.tx.models.resume.contactinfo.WebAddressType
-
-
A Signal username/number
-
-
SimilarityScore - Variable in class com.textkernel.tx.models.api.dataenrichment.ontology.response.CompareProfessionsResponseValue
-
-
A value from [0 - 1] indicating the similarity between the two professions.
-
-
SimilarityScore - Variable in class com.textkernel.tx.models.api.dataenrichment.ontology.response.CompareSkillsToProfessionResponseValue
-
-
A value from[0 - 1] indicating the similarity of the skill set and profession.
-
-
SimilarityScore - Variable in class com.textkernel.tx.models.api.dataenrichment.ontology.response.SkillsSimilarityScoreResponseValue
-
-
A value from [0 - 1] representing how closely related skill set A and skill set B are, based on the relations between skills.
-
-
SimpleCategoryScoreData - Class in com.textkernel.tx.models.api.matching.response
-
-
Details about the score for a specific category
-
-
SimpleCategoryScoreData() - Constructor for class com.textkernel.tx.models.api.matching.response.SimpleCategoryScoreData
-
 
-
Skill - Variable in class com.textkernel.tx.models.api.matching.response.FoundSkill
-
-
Name of the skill found.
-
-
Skill - Class in com.textkernel.tx.models.dataenrichment
-
-
A skill from the Skills Taxonomy
-
-
Skill() - Constructor for class com.textkernel.tx.models.dataenrichment.Skill
-
 
-
Skill - Class in com.textkernel.tx.models.skills
-
-
A skill listed in a resume or job
-
-
Skill() - Constructor for class com.textkernel.tx.models.skills.Skill
-
 
-
SkillAndConfidence - Class in com.textkernel.tx.models.dataenrichment
-
-
A skill from the skill taxonomy, and the confidence that this is the correct skill for the given input.
-
-
SkillAndConfidence() - Constructor for class com.textkernel.tx.models.dataenrichment.SkillAndConfidence
-
 
-
SkillExperienceLevel - Enum in com.textkernel.tx.models.api.matching.request
-
-
Amount of experience obtained/required for a skill
-
-
SkillFilter - Class in com.textkernel.tx.models.api.matching.request
-
-
Filter for a specific skill
-
-
SkillFilter() - Constructor for class com.textkernel.tx.models.api.matching.request.SkillFilter
-
 
-
SkillIds - Variable in class com.textkernel.tx.models.api.dataenrichment.skills.request.LookupSkillsRequest
-
-
The IDs of the skills to get details about.
-
-
SkillMatch - Class in com.textkernel.tx.models.dataenrichment
-
-
A matched skill that was found in the text provided.
-
-
SkillMatch() - Constructor for class com.textkernel.tx.models.dataenrichment.SkillMatch
-
 
-
SkillMultipleDescriptions - Class in com.textkernel.tx.models.dataenrichment
-
-
A skill object.
-
-
SkillMultipleDescriptions() - Constructor for class com.textkernel.tx.models.dataenrichment.SkillMultipleDescriptions
-
-
The description of the skill in the requested language.
-
-
SkillName - Variable in class com.textkernel.tx.models.api.matching.request.SkillFilter
-
-
The name of the skill.
-
-
SkillPriority - Enum in com.textkernel.tx.models.api.jobdescription
-
-
Priority of skills for generating job descriptions
-
-
Skills - Variable in class com.textkernel.tx.models.api.dataenrichment.ontology.request.CompareSkillsToProfessionRequest
-
-
The skills which should be compared against the given profession.
-
-
Skills - Variable in class com.textkernel.tx.models.api.dataenrichment.ontology.request.SuggestProfessionsRequest
-
-
The skills used to return the most relevant professions.
-
-
Skills - Variable in class com.textkernel.tx.models.api.dataenrichment.ontology.request.SuggestSkillsFromSkillsRequest
-
-
The skills for which the service should return related skills.
-
-
Skills - Variable in class com.textkernel.tx.models.api.dataenrichment.skills.request.NormalizeSkillsRequest
-
-
The list of skills to normalize (up to 50 skills, each skill may not exceed 100 characters).
-
-
Skills - Variable in class com.textkernel.tx.models.api.dataenrichment.skills.response.AutocompleteSkillsResponseValue
-
-
A list of skills based on the given Prefix.
-
-
Skills - Variable in class com.textkernel.tx.models.api.dataenrichment.skills.response.ExtractSkillsResponseValue
-
-
A list of extracted skills.
-
-
Skills - Variable in class com.textkernel.tx.models.api.dataenrichment.skills.response.GetSkillsTaxonomyResponseValue
-
-
A list of skills objects.
-
-
Skills - Variable in class com.textkernel.tx.models.api.dataenrichment.skills.response.LookupSkillCodesResponseValue
-
-
List of skills in from the skills taxonomy.
-
-
Skills - Variable in class com.textkernel.tx.models.api.dataenrichment.skills.response.NormalizeSkillsResponseValue
-
-
A list of skills objects.
-
-
Skills - Variable in class com.textkernel.tx.models.api.jobdescription.GenerateJobRequest
-
-
List of skill requirements for the job.
-
-
Skills - Variable in class com.textkernel.tx.models.api.matching.CategoryWeights
-
-
The weight of the Skills category relative to other categories.
-
-
Skills - Variable in class com.textkernel.tx.models.api.matching.request.FilterCriteria
-
-
Results must have/require at least one of the specified skills.
-
-
Skills - Variable in class com.textkernel.tx.models.api.matching.response.EnrichedScoreData
-
-
Detailed match information for the Skills category.
-
-
Skills - Variable in class com.textkernel.tx.models.job.ParsedJob
-
-
Skills output when SkillsSettings.TaxonomyVersion is set to (or defaults to) V2.
-
-
Skills - Variable in class com.textkernel.tx.models.job.skills.JobSubTaxonomy
-
-
The skills from this subtaxonomy that were found
-
-
Skills - Variable in class com.textkernel.tx.models.resume.ParsedResume
-
-
Skills output when SkillsSettings.TaxonomyVersion is set to (or defaults to) V2.
-
-
Skills - Variable in class com.textkernel.tx.models.resume.skills.ResumeSubTaxonomy
-
-
The skills from this subtaxonomy that were found
-
-
SkillsA - Variable in class com.textkernel.tx.models.api.dataenrichment.ontology.request.SkillsSimilarityScoreRequest
-
-
A set of skills (and optionally, scores) to score against the other set of skills.
-
-
SkillsAutoCompleteCustomSkillsList - Variable in class com.textkernel.tx.models.api.matching.ui.UIOptions
-
-
If you are using custom skills, provide your custom skills list names here.
-
-
SkillsAutoCompleteRequest - Class in com.textkernel.tx.models.api.dataenrichment.skills.request
-
-
Request body for a 'SkillsAutocomplete' request
-
-
SkillsAutoCompleteRequest() - Constructor for class com.textkernel.tx.models.api.dataenrichment.skills.request.SkillsAutoCompleteRequest
-
 
-
SkillsB - Variable in class com.textkernel.tx.models.api.dataenrichment.ontology.request.SkillsSimilarityScoreRequest
-
-
A set of skills (and optionally, scores) to score against the other set of skills.
-
-
SkillScore - Class in com.textkernel.tx.models.api.dataenrichment.ontology.response
-
-
A skill related to the given profession.
-
-
SkillScore() - Constructor for class com.textkernel.tx.models.api.dataenrichment.ontology.response.SkillScore
-
 
-
SkillScore(String) - Constructor for class com.textkernel.tx.models.api.dataenrichment.ontology.response.SkillScore
-
 
-
SkillsData - Variable in class com.textkernel.tx.models.api.parsing.BasicParseOptions
-
-
Deprecated. -
use BasicParseOptions.SkillsSettings instead
-
-
-
SkillsData - Variable in class com.textkernel.tx.models.job.ParsedJob
-
-
Deprecated. -
use ParsedJob.Skills instead for better results
-
-
-
SkillsData - Variable in class com.textkernel.tx.models.resume.ParsedResume
-
-
Deprecated. -
use ParsedResume.Skills instead for better results
-
-
-
SkillsFoundOnlyInThisProfession - Variable in class com.textkernel.tx.models.api.dataenrichment.ontology.response.ProfessionExclusiveSkills
-
-
A list of skills that are relative to this profession, but not the other.
-
-
SkillsHasData - Variable in class com.textkernel.tx.models.api.matching.CategoryWeights
-
-
If false, the Skills category has no data and should be ignored/hidden.
-
-
SkillsMustAllExist - Variable in class com.textkernel.tx.models.api.matching.request.FilterCriteria
-
-
When true, all of the skills in FilterCriteria.Skills must be found.
-
-
SkillsScoreData - Class in com.textkernel.tx.models.api.matching.response
-
-
Details about the score for the Skills category
-
-
SkillsScoreData() - Constructor for class com.textkernel.tx.models.api.matching.response.SkillsScoreData
-
 
-
SkillsSettings - Variable in class com.textkernel.tx.models.api.parsing.BasicParseOptions
-
-
Enable skills normalization and enhanced candidate summarization, and specify the version of the skills taxonomy for this parsing transaction.
-
-
SkillsSettings - Class in com.textkernel.tx.models.api.parsing
-
-
Enable skills normalization and enhanced candidate summarization, and specify the version of the skills taxonomy for this parsing transaction.
-
-
SkillsSettings() - Constructor for class com.textkernel.tx.models.api.parsing.SkillsSettings
-
 
-
skillsSimilarityScore(List<SkillScore>, List<SkillScore>) - Method in class com.textkernel.tx.TxClient
-
-
Determines how closely related one set of skills is to another.
-
-
SkillsSimilarityScoreRequest - Class in com.textkernel.tx.models.api.dataenrichment.ontology.request
-
-
Request body for a 'SuggestProfessions' request
-
-
SkillsSimilarityScoreRequest() - Constructor for class com.textkernel.tx.models.api.dataenrichment.ontology.request.SkillsSimilarityScoreRequest
-
 
-
SkillsSimilarityScoreResponse - Class in com.textkernel.tx.models.api.dataenrichment.ontology.response
-
-
The response body from a SuggestSkills API call
-
-
SkillsSimilarityScoreResponse() - Constructor for class com.textkernel.tx.models.api.dataenrichment.ontology.response.SkillsSimilarityScoreResponse
-
 
-
SkillsSimilarityScoreResponseValue - Class in com.textkernel.tx.models.api.dataenrichment.ontology.response
-
-
One entry in the ApiResponse.Value from a 'skills Similarity Score' response
-
-
SkillsSimilarityScoreResponseValue() - Constructor for class com.textkernel.tx.models.api.dataenrichment.ontology.response.SkillsSimilarityScoreResponseValue
-
 
-
skillsSimilarityScoreV2(List<SkillScore>, List<SkillScore>) - Method in class com.textkernel.tx.TxClient
-
-
Determines how closely related one set of skills is to another.
-
-
SkillsWithoutProfessionRelation - Variable in class com.textkernel.tx.models.api.dataenrichment.ontology.response.SuggestedProfessionsWarnings
-
-
A list of warnings about provided skills that do not have a profession relation.
-
-
Skip - Variable in class com.textkernel.tx.models.api.matching.request.PaginationSettings
-
-
How many results to skip.
-
-
Skype - Static variable in class com.textkernel.tx.models.resume.contactinfo.WebAddressType
-
-
A Skype username/URL
-
-
Source - Variable in class com.textkernel.tx.models.GeocodedCoordinates
-
-
The geocoding source, such as Google or Bing
-
-
SourceJob - Variable in class com.textkernel.tx.models.api.bimetricscoring.BimetricScoreJobRequest
-
-
The job to use as the 'source' document for the bimetric score.
-
-
SourceResume - Variable in class com.textkernel.tx.models.api.bimetricscoring.BimetricScoreResumeRequest
-
-
The resume to use as the 'source' document for the bimetric score.
-
-
Sourcing - Variable in class com.textkernel.tx.models.api.matching.ui.hooks.UserActionHookCollection
-
-
The server-side (HTTP POST) - User Action Hooks - for 'Sourcing' results during a Matching UI session.
-
-
SourcingHook - Class in com.textkernel.tx.models.api.matching.ui.hooks
-
-
A hook that does some server-side action for sourcing results (performs and HTTP POST to your server) -
NOTE: Bulk actions are not supported for Sourcing hooks, yet.
-
-
SourcingHook() - Constructor for class com.textkernel.tx.models.api.matching.ui.hooks.SourcingHook
-
 
-
SovScore - Variable in class com.textkernel.tx.models.api.bimetricscoring.BimetricScoreResult
-
-
An integer score representing the overall fit of the match.
-
-
SovScore - Variable in class com.textkernel.tx.models.api.matching.response.MatchResult
-
-
An integer score representing the overall fit of the match.
-
-
SpeakingEngagements - Variable in class com.textkernel.tx.models.resume.ParsedResume
-
-
Any speaking engagements/appearances listed on the resume
-
-
SquareCorners - Variable in class com.textkernel.tx.models.api.matching.ui.Style
-
-
true to use square corners for UI elements.
-
-
StackOverflow - Static variable in class com.textkernel.tx.models.resume.contactinfo.WebAddressType
-
-
A Stack Overflow username/URL
-
-
StartDate - Variable in class com.textkernel.tx.models.job.ParsedJob
-
-
The start date of the job.
-
-
StartDate - Variable in class com.textkernel.tx.models.resume.education.EducationDetails
-
-
The date education started
-
-
StartDate - Variable in class com.textkernel.tx.models.resume.employment.Position
-
-
The start date listed for this position
-
-
StartDate - Variable in class com.textkernel.tx.models.resume.military.MilitaryDetails
-
-
The start date for this post/job
-
-
StartDate - Variable in class com.textkernel.tx.models.resume.TrainingDetails
-
-
The date the training started
-
-
StreetAddressLines - Variable in class com.textkernel.tx.models.Location
-
-
Street address lines
-
-
Style - Class in com.textkernel.tx.models.api.matching.ui
-
-
Options for styling the Matching UI
-
-
Style() - Constructor for class com.textkernel.tx.models.api.matching.ui.Style
-
 
-
Style - Variable in class com.textkernel.tx.models.api.matching.ui.UIOptions
-
-
Specifies custom style options for the Matching UI session.
-
-
SubscriberNumber - Variable in class com.textkernel.tx.models.resume.contactinfo.Telephone
-
-
The subscriber number part of the phone number
-
-
SubTaxonomies - Variable in class com.textkernel.tx.models.skills.ITaxonomy
-
-
The subtaxonomy children of this taxonomy (more specific groupings of skills)
-
-
Subtaxonomy - Variable in class com.textkernel.tx.models.api.matching.response.TaxonomyEvidence
-
-
Child subtaxonomy (specialization)
-
-
SubTaxonomy - Class in com.textkernel.tx.models.skills
-
-
A subtaxonomy to group similar skills
-
-
SubTaxonomy() - Constructor for class com.textkernel.tx.models.skills.SubTaxonomy
-
 
-
SubTaxonomyId - Variable in class com.textkernel.tx.models.skills.SubTaxonomy
-
-
The id of this subtaxonomy
-
-
SubTaxonomyName - Variable in class com.textkernel.tx.models.resume.employment.Position
-
-
Deprecated. -
use Position.NormalizedProfession instead
-
-
-
SubTaxonomyName - Variable in class com.textkernel.tx.models.skills.SubTaxonomy
-
-
The human-readable name of this subtaxonomy
-
-
Suffix - Variable in class com.textkernel.tx.models.resume.contactinfo.PersonName
-
-
A suffix for a name, such as Jr.
-
-
SuggestedCategoryWeights - Variable in class com.textkernel.tx.models.api.matching.BaseScoredResponseValue
-
-
The weights suggested based solely on the data in the source document.
-
-
SuggestedFileExtension - Variable in class com.textkernel.tx.models.api.parsing.ConversionMetadata
-
-
The suggested extension based on the ConversionMetadata.DetectedType
-
-
SuggestedImprovement - Static variable in class com.textkernel.tx.models.resume.metadata.ResumeQualityLevel
-
-
Only minor issues were found
-
-
SuggestedProfession - Class in com.textkernel.tx.models.api.dataenrichment.ontology.response
-
-
A profession that was most relevant to the given skill.
-
-
SuggestedProfession() - Constructor for class com.textkernel.tx.models.api.dataenrichment.ontology.response.SuggestedProfession
-
 
-
SuggestedProfessions - Variable in class com.textkernel.tx.models.api.dataenrichment.ontology.response.SuggestProfessionsResponseValue
-
-
A list of professions most relevant to the given skills.
-
-
SuggestedProfessionsWarnings - Class in com.textkernel.tx.models.api.dataenrichment.ontology.response
-
-
Warnings when trying to suggest professions from skills.
-
-
SuggestedProfessionsWarnings() - Constructor for class com.textkernel.tx.models.api.dataenrichment.ontology.response.SuggestedProfessionsWarnings
-
 
-
SuggestedSkills - Variable in class com.textkernel.tx.models.api.dataenrichment.ontology.response.SuggestSkillsResponseValue
-
-
A list of skills related to the given professions.
-
-
SuggestedSkills - Variable in class com.textkernel.tx.models.api.jobdescription.SuggestSkillsFromJobTitleResponseValue
-
-
List of skills suggested for the job title.
-
-
suggestProfessionsFromSkills(ParsedResume, int, boolean, String, boolean) - Method in class com.textkernel.tx.TxClient
-
-
Suggest professions based on the skills within a given resume.
-
-
suggestProfessionsFromSkills(ParsedResume, String) - Method in class com.textkernel.tx.TxClient
-
-
Suggest professions based on the skills within a given resume.
-
-
suggestProfessionsFromSkills(ParsedResume) - Method in class com.textkernel.tx.TxClient
-
-
Suggest professions based on the skills within a given resume.
-
-
suggestProfessionsFromSkills(ParsedJob, int, boolean, String) - Method in class com.textkernel.tx.TxClient
-
-
Suggest professions based on the skills within a given job.
-
-
suggestProfessionsFromSkills(ParsedJob, String) - Method in class com.textkernel.tx.TxClient
-
-
Suggest professions based on the skills within a given job.
-
-
suggestProfessionsFromSkills(ParsedJob) - Method in class com.textkernel.tx.TxClient
-
-
Suggest professions based on the skills within a given job.
-
-
suggestProfessionsFromSkills(List<SkillScore>, int, boolean, String) - Method in class com.textkernel.tx.TxClient
-
-
Suggest professions based on a given set of skills.
-
-
suggestProfessionsFromSkills(List<String>, String) - Method in class com.textkernel.tx.TxClient
-
-
Suggest professions based on a given set of skill IDs.
-
-
suggestProfessionsFromSkillsV2(ParsedResume, int, boolean, String, boolean) - Method in class com.textkernel.tx.TxClient
-
-
Suggest professions based on the skills within a given resume.
-
-
suggestProfessionsFromSkillsV2(ParsedResume, String) - Method in class com.textkernel.tx.TxClient
-
-
Suggest professions based on the skills within a given resume.
-
-
suggestProfessionsFromSkillsV2(ParsedResume) - Method in class com.textkernel.tx.TxClient
-
-
Suggest professions based on the skills within a given resume.
-
-
suggestProfessionsFromSkillsV2(ParsedJob, int, boolean, String) - Method in class com.textkernel.tx.TxClient
-
-
Suggest professions based on the skills within a given job.
-
-
suggestProfessionsFromSkillsV2(ParsedJob, String) - Method in class com.textkernel.tx.TxClient
-
-
Suggest professions based on the skills within a given job.
-
-
suggestProfessionsFromSkillsV2(ParsedJob) - Method in class com.textkernel.tx.TxClient
-
-
Suggest professions based on the skills within a given job.
-
-
suggestProfessionsFromSkillsV2(List<SkillScore>, int, boolean, String) - Method in class com.textkernel.tx.TxClient
-
-
Suggest professions based on a given set of skills.
-
-
suggestProfessionsFromSkillsV2(List<String>, String) - Method in class com.textkernel.tx.TxClient
-
-
Suggest professions based on a given set of skill IDs.
-
-
SuggestProfessionsRequest - Class in com.textkernel.tx.models.api.dataenrichment.ontology.request
-
-
Request body for a 'SuggestProfessions' request
-
-
SuggestProfessionsRequest() - Constructor for class com.textkernel.tx.models.api.dataenrichment.ontology.request.SuggestProfessionsRequest
-
 
-
SuggestProfessionsResponse - Class in com.textkernel.tx.models.api.dataenrichment.ontology.response
-
-
The response body from a SuggestProfessions API call
-
-
SuggestProfessionsResponse() - Constructor for class com.textkernel.tx.models.api.dataenrichment.ontology.response.SuggestProfessionsResponse
-
 
-
SuggestProfessionsResponseValue - Class in com.textkernel.tx.models.api.dataenrichment.ontology.response
-
-
One entry in the ApiResponse.Value from a 'SuggestProfessions' response
-
-
SuggestProfessionsResponseValue() - Constructor for class com.textkernel.tx.models.api.dataenrichment.ontology.response.SuggestProfessionsResponseValue
-
 
-
suggestSkillsFromJobTitle(String, String, Integer) - Method in class com.textkernel.tx.TxClient
-
-
Takes a job title and suggests relevant skills.
-
-
suggestSkillsFromJobTitle(String) - Method in class com.textkernel.tx.TxClient
-
-
Takes a job title and suggests relevant skills.
-
-
SuggestSkillsFromJobTitleRequest - Class in com.textkernel.tx.models.api.jobdescription
-
-
Request body for 'Suggest Skills for Job Title' request
-
-
SuggestSkillsFromJobTitleRequest() - Constructor for class com.textkernel.tx.models.api.jobdescription.SuggestSkillsFromJobTitleRequest
-
 
-
SuggestSkillsFromJobTitleResponse - Class in com.textkernel.tx.models.api.jobdescription
-
-
Response body for a 'Suggest Skills from Job Title' response
-
-
SuggestSkillsFromJobTitleResponse() - Constructor for class com.textkernel.tx.models.api.jobdescription.SuggestSkillsFromJobTitleResponse
-
 
-
SuggestSkillsFromJobTitleResponseValue - Class in com.textkernel.tx.models.api.jobdescription
-
-
The ApiResponse.Value from a 'Suggest Skills from Job Title' response
-
-
SuggestSkillsFromJobTitleResponseValue() - Constructor for class com.textkernel.tx.models.api.jobdescription.SuggestSkillsFromJobTitleResponseValue
-
 
-
suggestSkillsFromProfessions(List<Integer>, int, String) - Method in class com.textkernel.tx.TxClient
-
-
Suggests skills related to given professions.
-
-
suggestSkillsFromProfessions(List<Integer>, String) - Method in class com.textkernel.tx.TxClient
-
-
Suggests skills related to given professions.
-
-
suggestSkillsFromProfessions(ParsedResume, String) - Method in class com.textkernel.tx.TxClient
-
-
Suggests skills related to a resume based on the recent professions in the resume.
-
-
suggestSkillsFromProfessions(ParsedResume) - Method in class com.textkernel.tx.TxClient
-
-
Suggests skills related to a resume based on the recent professions in the resume.
-
-
suggestSkillsFromProfessions(ParsedJob, String) - Method in class com.textkernel.tx.TxClient
-
-
Suggests skills related to a job based on the profession title in the job.
-
-
suggestSkillsFromProfessions(ParsedJob) - Method in class com.textkernel.tx.TxClient
-
-
Suggests skills related to a job based on the profession title in the job.
-
-
SuggestSkillsFromProfessionsRequest - Class in com.textkernel.tx.models.api.dataenrichment.ontology.request
-
-
Request body for a 'SuggestSkills' request
-
-
SuggestSkillsFromProfessionsRequest() - Constructor for class com.textkernel.tx.models.api.dataenrichment.ontology.request.SuggestSkillsFromProfessionsRequest
-
 
-
suggestSkillsFromProfessionsV2(List<Integer>, int, String, List<String>) - Method in class com.textkernel.tx.TxClient
-
-
Suggests skills related to given professions.
-
-
suggestSkillsFromProfessionsV2(List<Integer>, String) - Method in class com.textkernel.tx.TxClient
-
-
Suggests skills related to given professions.
-
-
suggestSkillsFromProfessionsV2(ParsedResume, String) - Method in class com.textkernel.tx.TxClient
-
-
Suggests skills related to a resume based on the recent professions in the resume.
-
-
suggestSkillsFromProfessionsV2(ParsedResume) - Method in class com.textkernel.tx.TxClient
-
-
Suggests skills related to a resume based on the recent professions in the resume.
-
-
suggestSkillsFromProfessionsV2(ParsedJob, String) - Method in class com.textkernel.tx.TxClient
-
-
Suggests skills related to a job based on the profession title in the job.
-
-
suggestSkillsFromProfessionsV2(ParsedJob) - Method in class com.textkernel.tx.TxClient
-
-
Suggests skills related to a job based on the profession title in the job.
-
-
suggestSkillsFromSkills(List<SkillScore>, int, String) - Method in class com.textkernel.tx.TxClient
-
-
Returns skills related to a given skill or set of skills.
-
-
suggestSkillsFromSkills(List<String>, String) - Method in class com.textkernel.tx.TxClient
-
-
Returns skills related to a given skill or set of skills.
-
-
suggestSkillsFromSkills(ParsedJob, int, String) - Method in class com.textkernel.tx.TxClient
-
-
Suggests skills related to a job (but not in the job) based on the skills in the job.
-
-
suggestSkillsFromSkills(ParsedJob, String) - Method in class com.textkernel.tx.TxClient
-
-
Suggests skills related to a job (but not in the job) based on the skills in the job.
-
-
suggestSkillsFromSkills(ParsedResume, int, String, boolean) - Method in class com.textkernel.tx.TxClient
-
-
Suggests skills related to a resume (but not in the resume) based on the skills in the resume.
-
-
suggestSkillsFromSkills(ParsedResume, String) - Method in class com.textkernel.tx.TxClient
-
-
Suggests skills related to a resume (but not in the resume) based on the skills in the resume.
-
-
SuggestSkillsFromSkillsRequest - Class in com.textkernel.tx.models.api.dataenrichment.ontology.request
-
-
Request body for a 'SuggestProfessions' request
-
-
SuggestSkillsFromSkillsRequest() - Constructor for class com.textkernel.tx.models.api.dataenrichment.ontology.request.SuggestSkillsFromSkillsRequest
-
 
-
suggestSkillsFromSkillsV2(List<SkillScore>, int, String, List<String>) - Method in class com.textkernel.tx.TxClient
-
-
Returns skills related to a given skill or set of skills.
-
-
suggestSkillsFromSkillsV2(List<String>, String) - Method in class com.textkernel.tx.TxClient
-
-
Returns skills related to a given skill or set of skills.
-
-
suggestSkillsFromSkillsV2(ParsedJob, int, String) - Method in class com.textkernel.tx.TxClient
-
-
Suggests skills related to a job (but not in the job) based on the skills in the job.
-
-
suggestSkillsFromSkillsV2(ParsedJob, String) - Method in class com.textkernel.tx.TxClient
-
-
Suggests skills related to a job (but not in the job) based on the skills in the job.
-
-
suggestSkillsFromSkillsV2(ParsedResume, int, String, boolean) - Method in class com.textkernel.tx.TxClient
-
-
Suggests skills related to a resume (but not in the resume) based on the skills in the resume.
-
-
suggestSkillsFromSkillsV2(ParsedResume, String) - Method in class com.textkernel.tx.TxClient
-
-
Suggests skills related to a resume (but not in the resume) based on the skills in the resume.
-
-
SuggestSkillsResponse - Class in com.textkernel.tx.models.api.dataenrichment.ontology.response
-
-
The response body from a SuggestSkills API call
-
-
SuggestSkillsResponse() - Constructor for class com.textkernel.tx.models.api.dataenrichment.ontology.response.SuggestSkillsResponse
-
 
-
SuggestSkillsResponseValue - Class in com.textkernel.tx.models.api.dataenrichment.ontology.response
-
-
One entry in the ApiResponse.Value from a 'SuggestSkills' response
-
-
SuggestSkillsResponseValue() - Constructor for class com.textkernel.tx.models.api.dataenrichment.ontology.response.SuggestSkillsResponseValue
-
 
-
- - - -

T

-
-
Take - Variable in class com.textkernel.tx.models.api.matching.request.MatchRequest
-
-
The number of results to return.
-
-
Take - Variable in class com.textkernel.tx.models.api.matching.request.PaginationSettings
-
-
How many results to return
-
-
Target - Variable in class com.textkernel.tx.models.api.matching.ui.hooks.JsAction
-
-
One of "parent" or "opener", depending if you use an iFrame to show the Matching UI - in your system, or if you open it in a separate tab/window.
-
-
Target - Variable in class com.textkernel.tx.models.api.matching.ui.hooks.UrlAction
-
-
Use "tx" to open a popup inside the Matching UI and display the webpage.
-
-
TargetJobs - Variable in class com.textkernel.tx.models.api.bimetricscoring.BimetricScoreRequest
-
-
A list of parsed jobs containing the document name/identifier and the parsed job data.
-
-
TargetOrigin - Variable in class com.textkernel.tx.models.api.matching.ui.hooks.JsAction
-
-
The 'targetOrigin' parameter for the window.postMessage() call.
-
-
TargetResumes - Variable in class com.textkernel.tx.models.api.bimetricscoring.BimetricScoreRequest
-
-
A list of parsed resumes containing the document name/identifier and the parsed resume data.
-
-
Taxonomies - Variable in class com.textkernel.tx.models.api.matching.request.FilterCriteria
-
-
Results must contain at least one of the specified best-fit taxonomy IDs or best-fit subtaxonomy IDs.
-
-
Taxonomies - Variable in class com.textkernel.tx.models.api.matching.response.EnrichedScoreData
-
-
Detailed match information for the Taxonomies category.
-
-
Taxonomies - Variable in class com.textkernel.tx.models.job.skills.JobTaxonomyRoot
-
-
The taxonomies found in a job
-
-
Taxonomies - Variable in class com.textkernel.tx.models.resume.skills.ResumeTaxonomyRoot
-
-
The skills taxonomies found in a resume
-
-
TaxonomiesScoreData - Class in com.textkernel.tx.models.api.matching.response
-
-
Details about the score for the Taxonomies category
-
-
TaxonomiesScoreData() - Constructor for class com.textkernel.tx.models.api.matching.response.TaxonomiesScoreData
-
 
-
Taxonomy - Variable in class com.textkernel.tx.models.api.matching.response.TaxonomyEvidence
-
-
Parent taxonomy (industry)
-
-
Taxonomy - Class in com.textkernel.tx.models.dataenrichment
-
-
Base class for Skills and Professions taxonomies
-
-
Taxonomy() - Constructor for class com.textkernel.tx.models.dataenrichment.Taxonomy
-
 
-
Taxonomy - Class in com.textkernel.tx.models.skills
-
 
-
Taxonomy() - Constructor for class com.textkernel.tx.models.skills.Taxonomy
-
 
-
TaxonomyEvidence - Class in com.textkernel.tx.models.api.matching.response
-
-
A taxonomy/subtaxonomy (industry/specialization) pair
-
-
TaxonomyEvidence() - Constructor for class com.textkernel.tx.models.api.matching.response.TaxonomyEvidence
-
 
-
TaxonomyFormat - Enum in com.textkernel.tx.models.api.dataenrichment
-
-
The format used to retrieve the DES skills or professions taxonomy
-
-
TaxonomyInfo - Class in com.textkernel.tx.models.api.matching.response
-
-
Evidence for a specific taxonomy/subtaxonomy
-
-
TaxonomyInfo() - Constructor for class com.textkernel.tx.models.api.matching.response.TaxonomyInfo
-
 
-
TaxonomyMetadata - Class in com.textkernel.tx.models.dataenrichment
-
-
Metadata about the Skills or Professions taxonomies
-
-
TaxonomyMetadata() - Constructor for class com.textkernel.tx.models.dataenrichment.TaxonomyMetadata
-
 
-
TaxonomyName - Variable in class com.textkernel.tx.models.resume.employment.Position
-
-
Deprecated. -
use Position.NormalizedProfession instead
-
-
-
TaxonomyPercentage - Variable in class com.textkernel.tx.models.resume.employment.Position
-
-
Deprecated. -
use Position.NormalizedProfession instead
-
-
-
TaxonomyReleaseDate - Variable in class com.textkernel.tx.models.dataenrichment.TaxonomyMetadata
-
-
The date the taxonomy was released.
-
-
TaxonomyVersion - Variable in class com.textkernel.tx.models.api.parsing.SkillsSettings
-
-
Specifies the version of the skills taxonomy to use.
-
-
Telegram - Static variable in class com.textkernel.tx.models.resume.contactinfo.WebAddressType
-
-
A Telegram username
-
-
Telegraph - Static variable in class com.textkernel.tx.models.resume.contactinfo.WebAddressType
-
-
A Telegraph username
-
-
Telephone - Class in com.textkernel.tx.models.resume.contactinfo
-
-
A phone number listed on the resume
-
-
Telephone() - Constructor for class com.textkernel.tx.models.resume.contactinfo.Telephone
-
 
-
Telephones - Variable in class com.textkernel.tx.models.resume.CandidateReference
-
-
Phone numbers listed for the reference
-
-
Telephones - Variable in class com.textkernel.tx.models.resume.contactinfo.ContactInformation
-
-
The candidate's phone numbers.
-
-
Template - Variable in class com.textkernel.tx.models.api.formatter.FormatResumeRequest
-
-
A base64-encoded string of the DOCX template document file bytes.
-
-
TermsOfInterest - Variable in class com.textkernel.tx.models.job.ParsedJob
-
-
Terms of interest listed in the job
-
-
Text - Variable in class com.textkernel.tx.models.api.dataenrichment.skills.request.ExtractSkillsRequest
-
-
The text to extract skills from.
-
-
Text - Variable in class com.textkernel.tx.models.api.matching.ui.UserDefinedTagOption
-
-
The text that will be shown to the user for the tag.
-
-
Text - Variable in class com.textkernel.tx.models.resume.education.EducationDetails
-
-
The raw text from the resume
-
-
Text - Variable in class com.textkernel.tx.models.resume.employment.Bullet
-
-
The text value of the bullet-list item (excluding the bullet point character)
-
-
Text - Variable in class com.textkernel.tx.models.resume.TrainingDetails
-
-
The text that was found on the resume
-
-
Text - Variable in class com.textkernel.tx.models.resume.TrainingHistory
-
-
The full text where we found all training history
-
-
Threshold - Variable in class com.textkernel.tx.models.api.dataenrichment.skills.request.ExtractSkillsRequest
-
-
A value from [0 - 1] for the minimum confidence threshold for extracted skills.
-
-
TimedOut - Variable in class com.textkernel.tx.models.api.parsing.ParsingMetadata
-
-
Whether or not the transaction timed out.
-
-
TimedOutAtMilliseconds - Variable in class com.textkernel.tx.models.api.parsing.ParsingMetadata
-
-
If ParsingMetadata.TimedOut is true, this is how much time was spent parsing before the timeout occurred
-
-
TimeScale - Variable in class com.textkernel.tx.models.job.PayRange
-
-
Time scale applied to the raw values to get the minimum and maximum annual salary.
-
-
Title - Variable in class com.textkernel.tx.models.api.matching.request.JobTitleFilter
-
-
The name of the Job Title.
-
-
Title - Variable in class com.textkernel.tx.models.api.matching.ui.FilterToShow
-
-
An optional value to override the title that is shown for a specific filter.
-
-
Title - Variable in class com.textkernel.tx.models.resume.CandidateReference
-
-
The job title of the reference
-
-
toFile(String, boolean) - Method in class com.textkernel.tx.models.ParsedDocument
-
-
Save the json to disk using UTF-8 encoding
-
-
toJson(boolean) - Method in class com.textkernel.tx.models.ParsedDocument
-
 
-
Tone - Variable in class com.textkernel.tx.models.api.jobdescription.GenerateJobRequest
-
-
The tone of the job description.
-
-
toString() - Method in class com.textkernel.tx.models.ParsedDocument
-
 
-
TotalCount - Variable in class com.textkernel.tx.models.api.matching.BaseSearchMatchResponseValue
-
-
The total number of results that fit the query/criteria
-
-
TotalElapsedMilliseconds - Variable in class com.textkernel.tx.models.api.ApiResponseInfo
-
-
How long the transaction took on the server, in milliseconds.
-
-
Training - Variable in class com.textkernel.tx.models.resume.ParsedResume
-
-
Any training listed on the resume
-
-
TrainingDetails - Class in com.textkernel.tx.models.resume
-
-
A training history found on a resume
-
-
TrainingDetails() - Constructor for class com.textkernel.tx.models.resume.TrainingDetails
-
 
-
TrainingHistory - Class in com.textkernel.tx.models.resume
-
-
All training info found in a resume
-
-
TrainingHistory() - Constructor for class com.textkernel.tx.models.resume.TrainingHistory
-
 
-
Trainings - Variable in class com.textkernel.tx.models.resume.TrainingHistory
-
-
Information about each training history we found
-
-
TransactionId - Variable in exception com.textkernel.tx.exceptions.TxException
-
-
The Id of the transaction, use this when reporting errors to Support
-
-
TransactionId - Variable in class com.textkernel.tx.models.api.ApiResponseInfo
-
-
The id for a specific API transaction.
-
-
Truncated - Variable in class com.textkernel.tx.models.api.dataenrichment.skills.response.ExtractSkillsResponseValue
-
-
Whether the input text was truncated or not due to length.
-
-
Twitter - Static variable in class com.textkernel.tx.models.resume.contactinfo.WebAddressType
-
-
A Twitter handle
-
-
TxClient - Class in com.textkernel.tx
-
-
The SDK client to perform Tx API calls.
-
-
TxClient(String, String, DataCenter) - Constructor for class com.textkernel.tx.TxClient
-
-
Create an SDK client to perform Tx API calls with the account information found at https://cloud.textkernel.com/tx/console
-
-
TxClient(String, String, DataCenter, List<String>) - Constructor for class com.textkernel.tx.TxClient
-
-
Create an SDK client to perform Tx API calls with the account information found at https://cloud.textkernel.com/tx/console
-
-
TxClient(String, String, DataCenter, List<String>, long) - Constructor for class com.textkernel.tx.TxClient
-
-
Create an SDK client to perform Tx API calls with the account information found at https://cloud.textkernel.com/tx/console
-
-
TxDate - Class in com.textkernel.tx.models
-
-
the custom Date type that represents dates found in resumes/jobs.
-
-
TxDate() - Constructor for class com.textkernel.tx.models.TxDate
-
 
-
TxErrorCode - Variable in exception com.textkernel.tx.exceptions.TxException
-
-
The Info.Code of the response.
-
-
TxException - Exception in com.textkernel.tx.exceptions
-
-
The most generic exception thrown by the SDK as a result of an error response from the API
-
-
TxException(String, Response, ApiResponseInfoLite, String) - Constructor for exception com.textkernel.tx.exceptions.TxException
-
 
-
TxException(String, Response, ApiResponseInfo) - Constructor for exception com.textkernel.tx.exceptions.TxException
-
 
-
TxGeocodeJobException - Exception in com.textkernel.tx.exceptions
-
-
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)
-
-
TxGeocodeJobException(Response, ApiResponseInfoLite, String, ParseJobResponse) - Constructor for exception com.textkernel.tx.exceptions.TxGeocodeJobException
-
 
-
TxGeocodeResumeException - Exception in com.textkernel.tx.exceptions
-
-
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)
-
-
TxGeocodeResumeException(Response, ApiResponseInfoLite, String, ParseResumeResponse) - Constructor for exception com.textkernel.tx.exceptions.TxGeocodeResumeException
-
 
-
TxIndexJobException - Exception in com.textkernel.tx.exceptions
-
-
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)
-
-
TxIndexJobException(Response, ApiResponseInfoLite, String, ParseJobResponse) - Constructor for exception com.textkernel.tx.exceptions.TxIndexJobException
-
 
-
TxIndexResumeException - Exception in com.textkernel.tx.exceptions
-
-
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)
-
-
TxIndexResumeException(Response, ApiResponseInfoLite, String, ParseResumeResponse) - Constructor for exception com.textkernel.tx.exceptions.TxIndexResumeException
-
 
-
TxJsonSerializer - Class in com.textkernel.tx.utilities
-
 
-
TxJsonSerializer() - Constructor for class com.textkernel.tx.utilities.TxJsonSerializer
-
 
-
TxPrimitive<T> - Class in com.textkernel.tx.models
-
-
Represents a native type (int, boolean, etc) that can have a value or be null
-
-
TxPrimitive() - Constructor for class com.textkernel.tx.models.TxPrimitive
-
 
-
TxProfessionNormalizationJobException - Exception in com.textkernel.tx.exceptions
-
-
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)
-
-
TxProfessionNormalizationJobException(Response, ApiResponseInfoLite, String, ParseJobResponse) - Constructor for exception com.textkernel.tx.exceptions.TxProfessionNormalizationJobException
-
 
-
TxProfessionNormalizationResumeException - Exception in com.textkernel.tx.exceptions
-
-
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)
-
-
TxProfessionNormalizationResumeException(Response, ApiResponseInfoLite, String, ParseResumeResponse) - Constructor for exception com.textkernel.tx.exceptions.TxProfessionNormalizationResumeException
-
 
-
TxUIClient - Class in com.textkernel.tx
-
-
Extension methods to generate the Matching UI.
-
-
TxUsableJobException - Exception in com.textkernel.tx.exceptions
-
-
This exception is thrown when an error happens, but the service was still able to produce a usable Resume object (see the Response property)
-
-
TxUsableJobException(Response, ApiResponseInfoLite, String, ParseJobResponse) - Constructor for exception com.textkernel.tx.exceptions.TxUsableJobException
-
 
-
TxUsableResumeException - Exception in com.textkernel.tx.exceptions
-
-
This exception is thrown when an error happens, but the service was still able to produce a usable Resume object (see the Response property)
-
-
TxUsableResumeException(Response, ApiResponseInfoLite, String, ParseResumeResponse) - Constructor for exception com.textkernel.tx.exceptions.TxUsableResumeException
-
 
-
Type - Variable in class com.textkernel.tx.models.api.matching.response.CategoryScoreEvidence
-
-
The sentiment of the CategoryScoreEvidence.Fact.
-
-
Type - Variable in class com.textkernel.tx.models.dataenrichment.Skill
-
-
Type of skill.
-
-
Type - Variable in class com.textkernel.tx.models.job.JobDegree
-
-
The type of the educational degree
-
-
Type - Variable in class com.textkernel.tx.models.resume.CandidateReference
-
-
The type of reference
-
-
Type - Variable in class com.textkernel.tx.models.resume.contactinfo.WebAddress
-
-
The type of address.
-
-
Type - Variable in class com.textkernel.tx.models.resume.education.Degree
-
-
Deprecated.
-
-
Type - Variable in class com.textkernel.tx.models.resume.employment.Bullet
-
-
The type of text/term found for this bullet point.
-
-
Type - Variable in class com.textkernel.tx.models.skills.NormalizedSkill
-
-
Type of skill.
-
-
Types - Variable in class com.textkernel.tx.models.api.dataenrichment.ontology.request.SuggestSkillsFromProfessionsRequest
-
-
If specified, only these types of skills will be returned.
-
-
Types - Variable in class com.textkernel.tx.models.api.dataenrichment.ontology.request.SuggestSkillsFromSkillsRequest
-
-
If specified, only these types of skills will be returned.
-
-
Types - Variable in class com.textkernel.tx.models.api.dataenrichment.skills.request.SkillsAutoCompleteRequest
-
-
If specified, only these types of skills will be returned.
-
-
- - - -

U

-
-
ui(MatchUISettings) - Method in class com.textkernel.tx.TxClient
-
-
Access methods for generating Matching UI sessions.
-
-
UIBimetricScoreJobRequest - Class in com.textkernel.tx.models.api.matching.ui.request
-
-
The request body for generating a Matching UI session
-
-
UIBimetricScoreJobRequest(BimetricScoreJobRequest, MatchUISettings) - Constructor for class com.textkernel.tx.models.api.matching.ui.request.UIBimetricScoreJobRequest
-
 
-
UIBimetricScoreResumeRequest - Class in com.textkernel.tx.models.api.matching.ui.request
-
-
The request body for generating a Matching UI session
-
-
UIBimetricScoreResumeRequest(BimetricScoreResumeRequest, MatchUISettings) - Constructor for class com.textkernel.tx.models.api.matching.ui.request.UIBimetricScoreResumeRequest
-
 
-
UIMatchByDocumentIdOptions - Class in com.textkernel.tx.models.api.matching.ui.request
-
-
The request body for generating a Matching UI session
-
-
UIMatchByDocumentIdOptions(MatchByDocumentIdOptions, MatchUISettings) - Constructor for class com.textkernel.tx.models.api.matching.ui.request.UIMatchByDocumentIdOptions
-
 
-
UIMatchJobRequest - Class in com.textkernel.tx.models.api.matching.ui.request
-
-
The request body for generating a Matching UI session
-
-
UIMatchJobRequest(MatchJobRequest, MatchUISettings) - Constructor for class com.textkernel.tx.models.api.matching.ui.request.UIMatchJobRequest
-
 
-
UIMatchResumeRequest - Class in com.textkernel.tx.models.api.matching.ui.request
-
-
The request body for generating a Matching UI session
-
-
UIMatchResumeRequest(MatchResumeRequest, MatchUISettings) - Constructor for class com.textkernel.tx.models.api.matching.ui.request.UIMatchResumeRequest
-
 
-
UIOptions - Variable in class com.textkernel.tx.models.api.matching.ui.request.MatchUISettings
-
-
Various options for the Matching UI user experience
-
-
UIOptions - Class in com.textkernel.tx.models.api.matching.ui
-
-
Options for creating the Matching UI
-
-
UIOptions() - Constructor for class com.textkernel.tx.models.api.matching.ui.UIOptions
-
 
-
UISearchRequest - Class in com.textkernel.tx.models.api.matching.ui.request
-
-
The request body for generating a Matching UI session
-
-
UISearchRequest(SearchRequest, MatchUISettings) - Constructor for class com.textkernel.tx.models.api.matching.ui.request.UISearchRequest
-
 
-
UkSoc2010 - Variable in class com.textkernel.tx.models.dataenrichment.Profession
-
-
/// The UK-SOC-2010 details of this profession.
-
-
Unknown - Static variable in class com.textkernel.tx.models.resume.contactinfo.WebAddressType
-
-
An unknown internet handle/URL (the platform/website/app was not specified)
-
-
UnweightedScore - Variable in class com.textkernel.tx.models.api.matching.response.CategoryScoreData
-
-
An unweighted score from 0-100.
-
-
updateJobUserDefinedTags(String, String, List<String>, UserDefinedTagsMethod) - Method in class com.textkernel.tx.TxClient
-
-
Updates the user-defined tags for a job
-
-
updateResumeUserDefinedTags(String, String, List<String>, UserDefinedTagsMethod) - Method in class com.textkernel.tx.TxClient
-
-
Updates the user-defined tags for a resume
-
-
UpdateUserDefinedTagsRequest - Class in com.textkernel.tx.models.api.indexes
-
-
Request body to update (add/remove/overwrite) user-defined tags on an indexed - document
-
-
UpdateUserDefinedTagsRequest() - Constructor for class com.textkernel.tx.models.api.indexes.UpdateUserDefinedTagsRequest
-
 
-
UpdateUserDefinedTagsResponse - Class in com.textkernel.tx.models.api.indexes
-
-
The response body from a UpdateUserDefinedTags API call
-
-
UpdateUserDefinedTagsResponse() - Constructor for class com.textkernel.tx.models.api.indexes.UpdateUserDefinedTagsResponse
-
 
-
url - Variable in class com.textkernel.tx.models.api.matching.ui.GenerateUIResponse
-
-
The URL to navigate to (or set as the src for an iFrame) that will - display the Matching UI.
-
-
Url - Variable in class com.textkernel.tx.models.api.matching.ui.hooks.ServerSideHook
-
-
The URL for an HTTP POST call to perform some action in your system.
-
-
Url - Variable in class com.textkernel.tx.models.api.matching.ui.hooks.UrlAction
-
-
The URL to show (either in another tab/window or in an iFrame inside the Matching UI).
-
-
UrlAction - Variable in class com.textkernel.tx.models.api.matching.ui.hooks.ClientSideHook
-
-
A URL action to perform when the user clicks the button.
-
-
UrlAction - Class in com.textkernel.tx.models.api.matching.ui.hooks
-
-
An action performed with a URL (opening a new window, displaying some webpage)
-
-
UrlAction() - Constructor for class com.textkernel.tx.models.api.matching.ui.hooks.UrlAction
-
 
-
Urls - Variable in class com.textkernel.tx.models.resume.metadata.ReservedData
-
-
All personal urls found in the resume
-
-
US - Static variable in class com.textkernel.tx.DataCenter
-
-
Represents the US datacenter.
-
-
UseLLMParser - Variable in class com.textkernel.tx.models.api.parsing.ParseOptions
-
-
Only used for resumes.
-
-
UserActionHook - Class in com.textkernel.tx.models.api.matching.ui.hooks
-
-
A base class for all 3 kinds of hooks
-
-
UserActionHook() - Constructor for class com.textkernel.tx.models.api.matching.ui.hooks.UserActionHook
-
 
-
UserActionHookCollection - Class in com.textkernel.tx.models.api.matching.ui.hooks
-
-
A collection of Matching UI User Action Hooks
-
-
UserActionHookCollection() - Constructor for class com.textkernel.tx.models.api.matching.ui.hooks.UserActionHookCollection
-
 
-
UserDefinedTagOption - Class in com.textkernel.tx.models.api.matching.ui
-
-
A label/value pair for user-defined tags in the UI
-
-
UserDefinedTagOption() - Constructor for class com.textkernel.tx.models.api.matching.ui.UserDefinedTagOption
-
 
-
UserDefinedTags - Variable in class com.textkernel.tx.models.api.indexes.IndexDocumentRequest
-
-
The user-defined tags the document should have
-
-
UserDefinedTags - Variable in class com.textkernel.tx.models.api.indexes.IndexMultipleDocumentInfo
-
-
The user-defined tags the document should have
-
-
UserDefinedTags - Variable in class com.textkernel.tx.models.api.indexes.UpdateUserDefinedTagsRequest
-
-
The user-defined tags to add/delete/etc
-
-
UserDefinedTags - Variable in class com.textkernel.tx.models.api.matching.request.FilterCriteria
-
-
List of user-defined tags.
-
-
UserDefinedTags - Variable in class com.textkernel.tx.models.job.ParsedJob
-
-
A list of User-Defined Tags - that are assigned to this job.
-
-
UserDefinedTags - Variable in class com.textkernel.tx.models.resume.ParsedResume
-
-
A list of User-Defined Tags - that are assigned to this resume.
-
-
UserDefinedTagsMethod - Enum in com.textkernel.tx.models.api.indexes
-
-
A method to use when updating user-defined tags on a document
-
-
UserDefinedTagsMustAllExist - Variable in class com.textkernel.tx.models.api.matching.request.FilterCriteria
-
-
When true, all of the user-defined tags in FilterCriteria.UserDefinedTags must be found.
-
-
UserDefinedTagsPicklist - Class in com.textkernel.tx.models.api.matching.ui
-
-
A picklist to show to a user for filtering on user-defined tags
-
-
UserDefinedTagsPicklist() - Constructor for class com.textkernel.tx.models.api.matching.ui.UserDefinedTagsPicklist
-
 
-
UserDefinedTagsPicklists - Variable in class com.textkernel.tx.models.api.matching.ui.UIOptions
-
-
Picklists shown in the UI for your users to filter on your user-defined tags.
-
-
Username - Variable in class com.textkernel.tx.models.api.matching.ui.UIOptions
-
-
The username of the user for which you are generating a Matching UI session.
-
-
UwvBoc - Variable in class com.textkernel.tx.models.dataenrichment.Profession
-
-
/// The UWV-BOC details of this profession.
-
-
- - - -

V

-
-
Value - Variable in class com.textkernel.tx.models.api.ApiResponse
-
-
The data returned based on the request type/content
-
-
Value - Variable in class com.textkernel.tx.models.api.matching.ui.UserDefinedTagOption
-
-
The value of the tag.
-
-
Value - Variable in class com.textkernel.tx.models.resume.contactinfo.WebAddressType
-
-
The raw string value
-
-
Value - Variable in class com.textkernel.tx.models.resume.metadata.ResumeQualityLevel
-
-
The string value for this level/severity
-
-
Value - Variable in class com.textkernel.tx.models.TxPrimitive
-
-
The value for this object
-
-
valueOf(String) - Static method in enum com.textkernel.tx.models.api.dataenrichment.professions.ONETVersion
-
-
Returns the enum constant of this type with the specified name.
-
-
valueOf(String) - Static method in enum com.textkernel.tx.models.api.dataenrichment.TaxonomyFormat
-
-
Returns the enum constant of this type with the specified name.
-
-
valueOf(String) - Static method in enum com.textkernel.tx.models.api.formatter.OutputDocumentFormat
-
-
Returns the enum constant of this type with the specified name.
-
-
valueOf(String) - Static method in enum com.textkernel.tx.models.api.geocoding.GeocodeProvider
-
-
Returns the enum constant of this type with the specified name.
-
-
valueOf(String) - Static method in enum com.textkernel.tx.models.api.indexes.UserDefinedTagsMethod
-
-
Returns the enum constant of this type with the specified name.
-
-
valueOf(String) - Static method in enum com.textkernel.tx.models.api.jobdescription.JobTone
-
-
Returns the enum constant of this type with the specified name.
-
-
valueOf(String) - Static method in enum com.textkernel.tx.models.api.jobdescription.SkillPriority
-
-
Returns the enum constant of this type with the specified name.
-
-
valueOf(String) - Static method in enum com.textkernel.tx.models.api.matching.request.DistanceUnit
-
-
Returns the enum constant of this type with the specified name.
-
-
valueOf(String) - Static method in enum com.textkernel.tx.models.api.matching.request.SkillExperienceLevel
-
-
Returns the enum constant of this type with the specified name.
-
-
valueOf(String) - Static method in enum com.textkernel.tx.models.api.parsing.FlexRequestDataType
-
-
Returns the enum constant of this type with the specified name.
-
-
valueOf(String) - Static method in enum com.textkernel.tx.models.matching.IndexType
-
-
Returns the enum constant of this type with the specified name.
-
-
values() - Static method in enum com.textkernel.tx.models.api.dataenrichment.professions.ONETVersion
-
-
Returns an array containing the constants of this enum type, in -the order they are declared.
-
-
values() - Static method in enum com.textkernel.tx.models.api.dataenrichment.TaxonomyFormat
-
-
Returns an array containing the constants of this enum type, in -the order they are declared.
-
-
values() - Static method in enum com.textkernel.tx.models.api.formatter.OutputDocumentFormat
-
-
Returns an array containing the constants of this enum type, in -the order they are declared.
-
-
values() - Static method in enum com.textkernel.tx.models.api.geocoding.GeocodeProvider
-
-
Returns an array containing the constants of this enum type, in -the order they are declared.
-
-
values() - Static method in enum com.textkernel.tx.models.api.indexes.UserDefinedTagsMethod
-
-
Returns an array containing the constants of this enum type, in -the order they are declared.
-
-
values() - Static method in enum com.textkernel.tx.models.api.jobdescription.JobTone
-
-
Returns an array containing the constants of this enum type, in -the order they are declared.
-
-
values() - Static method in enum com.textkernel.tx.models.api.jobdescription.SkillPriority
-
-
Returns an array containing the constants of this enum type, in -the order they are declared.
-
-
values() - Static method in enum com.textkernel.tx.models.api.matching.request.DistanceUnit
-
-
Returns an array containing the constants of this enum type, in -the order they are declared.
-
-
values() - Static method in enum com.textkernel.tx.models.api.matching.request.SkillExperienceLevel
-
-
Returns an array containing the constants of this enum type, in -the order they are declared.
-
-
values() - Static method in enum com.textkernel.tx.models.api.parsing.FlexRequestDataType
-
-
Returns an array containing the constants of this enum type, in -the order they are declared.
-
-
values() - Static method in enum com.textkernel.tx.models.matching.IndexType
-
-
Returns an array containing the constants of this enum type, in -the order they are declared.
-
-
VariationOf - Variable in class com.textkernel.tx.models.api.matching.response.FoundJobTitle
-
-
Original term that the variation was derived from (or null if the FoundJobTitle.RawTerm was an exact match)
-
-
Variations - Variable in class com.textkernel.tx.models.job.skills.JobSkill
-
-
The variations (synonyms) of this skill that were found
-
-
Variations - Variable in class com.textkernel.tx.models.resume.employment.JobTitle
-
-
Deprecated. -
use Position.NormalizedProfession instead
-
-
-
Variations - Variable in class com.textkernel.tx.models.resume.skills.ResumeSkill
-
-
The variations (synonyms) of this skill that were found
-
-
Version - Variable in class com.textkernel.tx.models.api.parsing.ProfessionsSettings
-
-
Specifies the versions to use when normalizing professions if more than one is available for a taxonomy.
-
-
Version - Variable in class com.textkernel.tx.models.dataenrichment.VersionedProfessionClassification
-
-
The version of the profession taxonomy
-
-
Version - Variable in class com.textkernel.tx.models.resume.employment.VersionedNormalizedProfessionClassification
-
-
The version of the profession taxonomy
-
-
VersionedNormalizedProfessionClassification<T> - Class in com.textkernel.tx.models.resume.employment
-
-
Object representing a profession concept with taxonomy version
-
-
VersionedNormalizedProfessionClassification() - Constructor for class com.textkernel.tx.models.resume.employment.VersionedNormalizedProfessionClassification
-
 
-
VersionedProfessionClassification<T> - Class in com.textkernel.tx.models.dataenrichment
-
-
Object representing a profession concept with taxonomy version
-
-
VersionedProfessionClassification() - Constructor for class com.textkernel.tx.models.dataenrichment.VersionedProfessionClassification
-
 
-
VisaStatus - Variable in class com.textkernel.tx.models.resume.PersonalAttributes
-
-
The candidate's visa status listed on the resume
-
-
- - - -

W

-
-
Warnings - Variable in class com.textkernel.tx.models.api.dataenrichment.ontology.response.SuggestProfessionsResponseValue
-
-
Any warnings when attempting to suggest professions from the given skills.
-
-
WebAddress - Class in com.textkernel.tx.models.resume.contactinfo
-
-
A web address (URL, twitter handle, etc)
-
-
WebAddress() - Constructor for class com.textkernel.tx.models.resume.contactinfo.WebAddress
-
 
-
WebAddresses - Variable in class com.textkernel.tx.models.resume.CandidateReference
-
-
Other web addresses listed for the reference
-
-
WebAddresses - Variable in class com.textkernel.tx.models.resume.contactinfo.ContactInformation
-
-
The candidate's web addresses (URLs, social media) listed on the resume
-
-
WebAddressType - Class in com.textkernel.tx.models.resume.contactinfo
-
-
A type of WebAddress.
-
-
Website - Variable in class com.textkernel.tx.models.job.ApplicationDetails
-
-
Validated and normalized displayable website of the organization.
-
-
WeChat - Static variable in class com.textkernel.tx.models.resume.contactinfo.WebAddressType
-
-
A WeChat username
-
-
WeightedScore - Variable in class com.textkernel.tx.models.api.bimetricscoring.BimetricScoreResult
-
-
An integer score from 0-100 representing how well the current document matched the source document.
-
-
WeightedScore - Variable in class com.textkernel.tx.models.api.matching.response.MatchResult
-
-
An integer score from 0-100 representing how well the current document matched the source document.
-
-
WhatsApp - Static variable in class com.textkernel.tx.models.resume.contactinfo.WebAddressType
-
-
A WhatsApp username/number
-
-
WillingToRelocate - Variable in class com.textkernel.tx.models.resume.PersonalAttributes
-
-
Whether the candidate is willing to relocate
-
-
WorkingHours - Variable in class com.textkernel.tx.models.job.ParsedJob
-
-
The type of working hours.
-
-
- - - -

_

-
-
_asBase64 - Variable in class com.textkernel.tx.models.Document
-
 
-
-A B C D E F G H I J K L M N O P Q R S T U V W _ 
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/index.html b/docs/index.html deleted file mode 100644 index 4ac6f1dd4..000000000 --- a/docs/index.html +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - -Textkernel Tx Java SDK 2.3.3 API - - - - - - - - - -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> -<h2>Frame Alert</h2> -<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="overview-summary.html">Non-frame version</a>.</p> - - - diff --git a/docs/overview-frame.html b/docs/overview-frame.html deleted file mode 100644 index 6c4059f30..000000000 --- a/docs/overview-frame.html +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - -Overview List (Textkernel Tx Java SDK 2.3.3 API) - - - - - -
All Classes
-
-

Packages

- -
-

 

- - diff --git a/docs/overview-summary.html b/docs/overview-summary.html deleted file mode 100644 index 1795d15f3..000000000 --- a/docs/overview-summary.html +++ /dev/null @@ -1,292 +0,0 @@ - - - - - - -Overview (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Textkernel Tx Java SDK 2.3.3 API

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Packages 
PackageDescription
com.textkernel.tx 
com.textkernel.tx.exceptions 
com.textkernel.tx.http 
com.textkernel.tx.models 
com.textkernel.tx.models.api 
com.textkernel.tx.models.api.account 
com.textkernel.tx.models.api.bimetricscoring 
com.textkernel.tx.models.api.dataenrichment 
com.textkernel.tx.models.api.dataenrichment.ontology.request 
com.textkernel.tx.models.api.dataenrichment.ontology.response 
com.textkernel.tx.models.api.dataenrichment.professions 
com.textkernel.tx.models.api.dataenrichment.professions.request 
com.textkernel.tx.models.api.dataenrichment.professions.response 
com.textkernel.tx.models.api.dataenrichment.skills.request 
com.textkernel.tx.models.api.dataenrichment.skills.response 
com.textkernel.tx.models.api.formatter 
com.textkernel.tx.models.api.geocoding 
com.textkernel.tx.models.api.indexes 
com.textkernel.tx.models.api.jobdescription 
com.textkernel.tx.models.api.matching 
com.textkernel.tx.models.api.matching.request 
com.textkernel.tx.models.api.matching.response 
com.textkernel.tx.models.api.matching.ui 
com.textkernel.tx.models.api.matching.ui.hooks 
com.textkernel.tx.models.api.matching.ui.request 
com.textkernel.tx.models.api.parsing 
com.textkernel.tx.models.dataenrichment 
com.textkernel.tx.models.job 
com.textkernel.tx.models.job.skills 
com.textkernel.tx.models.matching 
com.textkernel.tx.models.resume 
com.textkernel.tx.models.resume.contactinfo 
com.textkernel.tx.models.resume.education 
com.textkernel.tx.models.resume.employment 
com.textkernel.tx.models.resume.metadata 
com.textkernel.tx.models.resume.military 
com.textkernel.tx.models.resume.skills 
com.textkernel.tx.models.skills 
com.textkernel.tx.utilities 
-
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/overview-tree.html b/docs/overview-tree.html deleted file mode 100644 index 9f6206af7..000000000 --- a/docs/overview-tree.html +++ /dev/null @@ -1,649 +0,0 @@ - - - - - - -Class Hierarchy (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For All Packages

-Package Hierarchies: - -
-
-

Class Hierarchy

- -

Interface Hierarchy

- -

Enum Hierarchy

- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/package-list b/docs/package-list deleted file mode 100644 index a388d4a83..000000000 --- a/docs/package-list +++ /dev/null @@ -1,39 +0,0 @@ -com.textkernel.tx -com.textkernel.tx.exceptions -com.textkernel.tx.http -com.textkernel.tx.models -com.textkernel.tx.models.api -com.textkernel.tx.models.api.account -com.textkernel.tx.models.api.bimetricscoring -com.textkernel.tx.models.api.dataenrichment -com.textkernel.tx.models.api.dataenrichment.ontology.request -com.textkernel.tx.models.api.dataenrichment.ontology.response -com.textkernel.tx.models.api.dataenrichment.professions -com.textkernel.tx.models.api.dataenrichment.professions.request -com.textkernel.tx.models.api.dataenrichment.professions.response -com.textkernel.tx.models.api.dataenrichment.skills.request -com.textkernel.tx.models.api.dataenrichment.skills.response -com.textkernel.tx.models.api.formatter -com.textkernel.tx.models.api.geocoding -com.textkernel.tx.models.api.indexes -com.textkernel.tx.models.api.jobdescription -com.textkernel.tx.models.api.matching -com.textkernel.tx.models.api.matching.request -com.textkernel.tx.models.api.matching.response -com.textkernel.tx.models.api.matching.ui -com.textkernel.tx.models.api.matching.ui.hooks -com.textkernel.tx.models.api.matching.ui.request -com.textkernel.tx.models.api.parsing -com.textkernel.tx.models.dataenrichment -com.textkernel.tx.models.job -com.textkernel.tx.models.job.skills -com.textkernel.tx.models.matching -com.textkernel.tx.models.resume -com.textkernel.tx.models.resume.contactinfo -com.textkernel.tx.models.resume.education -com.textkernel.tx.models.resume.employment -com.textkernel.tx.models.resume.metadata -com.textkernel.tx.models.resume.military -com.textkernel.tx.models.resume.skills -com.textkernel.tx.models.skills -com.textkernel.tx.utilities diff --git a/docs/script.js b/docs/script.js deleted file mode 100644 index b34635693..000000000 --- a/docs/script.js +++ /dev/null @@ -1,30 +0,0 @@ -function show(type) -{ - count = 0; - for (var key in methods) { - var row = document.getElementById(key); - if ((methods[key] & type) != 0) { - row.style.display = ''; - row.className = (count++ % 2) ? rowColor : altColor; - } - else - row.style.display = 'none'; - } - updateTabs(type); -} - -function updateTabs(type) -{ - for (var value in tabs) { - var sNode = document.getElementById(tabs[value][0]); - var spanNode = sNode.firstChild; - if (value == type) { - sNode.className = activeTableTab; - spanNode.innerHTML = tabs[value][1]; - } - else { - sNode.className = tableTab; - spanNode.innerHTML = "" + tabs[value][1] + ""; - } - } -} diff --git a/docs/serialized-form.html b/docs/serialized-form.html deleted file mode 100644 index 1ca1507e0..000000000 --- a/docs/serialized-form.html +++ /dev/null @@ -1,240 +0,0 @@ - - - - - - -Serialized Form (Textkernel Tx Java SDK 2.3.3 API) - - - - - - - - -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -
-

Serialized Form

-
-
- -
- -
- - -
Skip navigation links
- - - - -
-
- - - -
- -
- - -
- -

Copyright © 2024. All rights reserved.

- - diff --git a/docs/stylesheet.css b/docs/stylesheet.css deleted file mode 100644 index 98055b22d..000000000 --- a/docs/stylesheet.css +++ /dev/null @@ -1,574 +0,0 @@ -/* Javadoc style sheet */ -/* -Overall document style -*/ - -@import url('resources/fonts/dejavu.css'); - -body { - background-color:#ffffff; - color:#353833; - font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; - font-size:14px; - margin:0; -} -a:link, a:visited { - text-decoration:none; - color:#4A6782; -} -a:hover, a:focus { - text-decoration:none; - color:#bb7a2a; -} -a:active { - text-decoration:none; - color:#4A6782; -} -a[name] { - color:#353833; -} -a[name]:hover { - text-decoration:none; - color:#353833; -} -pre { - font-family:'DejaVu Sans Mono', monospace; - font-size:14px; -} -h1 { - font-size:20px; -} -h2 { - font-size:18px; -} -h3 { - font-size:16px; - font-style:italic; -} -h4 { - font-size:13px; -} -h5 { - font-size:12px; -} -h6 { - font-size:11px; -} -ul { - list-style-type:disc; -} -code, tt { - font-family:'DejaVu Sans Mono', monospace; - font-size:14px; - padding-top:4px; - margin-top:8px; - line-height:1.4em; -} -dt code { - font-family:'DejaVu Sans Mono', monospace; - font-size:14px; - padding-top:4px; -} -table tr td dt code { - font-family:'DejaVu Sans Mono', monospace; - font-size:14px; - vertical-align:top; - padding-top:4px; -} -sup { - font-size:8px; -} -/* -Document title and Copyright styles -*/ -.clear { - clear:both; - height:0px; - overflow:hidden; -} -.aboutLanguage { - float:right; - padding:0px 21px; - font-size:11px; - z-index:200; - margin-top:-9px; -} -.legalCopy { - margin-left:.5em; -} -.bar a, .bar a:link, .bar a:visited, .bar a:active { - color:#FFFFFF; - text-decoration:none; -} -.bar a:hover, .bar a:focus { - color:#bb7a2a; -} -.tab { - background-color:#0066FF; - color:#ffffff; - padding:8px; - width:5em; - font-weight:bold; -} -/* -Navigation bar styles -*/ -.bar { - background-color:#4D7A97; - color:#FFFFFF; - padding:.8em .5em .4em .8em; - height:auto;/*height:1.8em;*/ - font-size:11px; - margin:0; -} -.topNav { - background-color:#4D7A97; - color:#FFFFFF; - float:left; - padding:0; - width:100%; - clear:right; - height:2.8em; - padding-top:10px; - overflow:hidden; - font-size:12px; -} -.bottomNav { - margin-top:10px; - background-color:#4D7A97; - color:#FFFFFF; - float:left; - padding:0; - width:100%; - clear:right; - height:2.8em; - padding-top:10px; - overflow:hidden; - font-size:12px; -} -.subNav { - background-color:#dee3e9; - float:left; - width:100%; - overflow:hidden; - font-size:12px; -} -.subNav div { - clear:left; - float:left; - padding:0 0 5px 6px; - text-transform:uppercase; -} -ul.navList, ul.subNavList { - float:left; - margin:0 25px 0 0; - padding:0; -} -ul.navList li{ - list-style:none; - float:left; - padding: 5px 6px; - text-transform:uppercase; -} -ul.subNavList li{ - list-style:none; - float:left; -} -.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { - color:#FFFFFF; - text-decoration:none; - text-transform:uppercase; -} -.topNav a:hover, .bottomNav a:hover { - text-decoration:none; - color:#bb7a2a; - text-transform:uppercase; -} -.navBarCell1Rev { - background-color:#F8981D; - color:#253441; - margin: auto 5px; -} -.skipNav { - position:absolute; - top:auto; - left:-9999px; - overflow:hidden; -} -/* -Page header and footer styles -*/ -.header, .footer { - clear:both; - margin:0 20px; - padding:5px 0 0 0; -} -.indexHeader { - margin:10px; - position:relative; -} -.indexHeader span{ - margin-right:15px; -} -.indexHeader h1 { - font-size:13px; -} -.title { - color:#2c4557; - margin:10px 0; -} -.subTitle { - margin:5px 0 0 0; -} -.header ul { - margin:0 0 15px 0; - padding:0; -} -.footer ul { - margin:20px 0 5px 0; -} -.header ul li, .footer ul li { - list-style:none; - font-size:13px; -} -/* -Heading styles -*/ -div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { - background-color:#dee3e9; - border:1px solid #d0d9e0; - margin:0 0 6px -8px; - padding:7px 5px; -} -ul.blockList ul.blockList ul.blockList li.blockList h3 { - background-color:#dee3e9; - border:1px solid #d0d9e0; - margin:0 0 6px -8px; - padding:7px 5px; -} -ul.blockList ul.blockList li.blockList h3 { - padding:0; - margin:15px 0; -} -ul.blockList li.blockList h2 { - padding:0px 0 20px 0; -} -/* -Page layout container styles -*/ -.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer { - clear:both; - padding:10px 20px; - position:relative; -} -.indexContainer { - margin:10px; - position:relative; - font-size:12px; -} -.indexContainer h2 { - font-size:13px; - padding:0 0 3px 0; -} -.indexContainer ul { - margin:0; - padding:0; -} -.indexContainer ul li { - list-style:none; - padding-top:2px; -} -.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { - font-size:12px; - font-weight:bold; - margin:10px 0 0 0; - color:#4E4E4E; -} -.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { - margin:5px 0 10px 0px; - font-size:14px; - font-family:'DejaVu Sans Mono',monospace; -} -.serializedFormContainer dl.nameValue dt { - margin-left:1px; - font-size:1.1em; - display:inline; - font-weight:bold; -} -.serializedFormContainer dl.nameValue dd { - margin:0 0 0 1px; - font-size:1.1em; - display:inline; -} -/* -List styles -*/ -ul.horizontal li { - display:inline; - font-size:0.9em; -} -ul.inheritance { - margin:0; - padding:0; -} -ul.inheritance li { - display:inline; - list-style:none; -} -ul.inheritance li ul.inheritance { - margin-left:15px; - padding-left:15px; - padding-top:1px; -} -ul.blockList, ul.blockListLast { - margin:10px 0 10px 0; - padding:0; -} -ul.blockList li.blockList, ul.blockListLast li.blockList { - list-style:none; - margin-bottom:15px; - line-height:1.4; -} -ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { - padding:0px 20px 5px 10px; - border:1px solid #ededed; - background-color:#f8f8f8; -} -ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { - padding:0 0 5px 8px; - background-color:#ffffff; - border:none; -} -ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { - margin-left:0; - padding-left:0; - padding-bottom:15px; - border:none; -} -ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { - list-style:none; - border-bottom:none; - padding-bottom:0; -} -table tr td dl, table tr td dl dt, table tr td dl dd { - margin-top:0; - margin-bottom:1px; -} -/* -Table styles -*/ -.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary { - width:100%; - border-left:1px solid #EEE; - border-right:1px solid #EEE; - border-bottom:1px solid #EEE; -} -.overviewSummary, .memberSummary { - padding:0px; -} -.overviewSummary caption, .memberSummary caption, .typeSummary caption, -.useSummary caption, .constantsSummary caption, .deprecatedSummary caption { - position:relative; - text-align:left; - background-repeat:no-repeat; - color:#253441; - font-weight:bold; - clear:none; - overflow:hidden; - padding:0px; - padding-top:10px; - padding-left:1px; - margin:0px; - white-space:pre; -} -.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, -.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link, -.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, -.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, -.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, -.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, -.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, -.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited { - color:#FFFFFF; -} -.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, -.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span { - white-space:nowrap; - padding-top:5px; - padding-left:12px; - padding-right:12px; - padding-bottom:7px; - display:inline-block; - float:left; - background-color:#F8981D; - border: none; - height:16px; -} -.memberSummary caption span.activeTableTab span { - white-space:nowrap; - padding-top:5px; - padding-left:12px; - padding-right:12px; - margin-right:3px; - display:inline-block; - float:left; - background-color:#F8981D; - height:16px; -} -.memberSummary caption span.tableTab span { - white-space:nowrap; - padding-top:5px; - padding-left:12px; - padding-right:12px; - margin-right:3px; - display:inline-block; - float:left; - background-color:#4D7A97; - height:16px; -} -.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab { - padding-top:0px; - padding-left:0px; - padding-right:0px; - background-image:none; - float:none; - display:inline; -} -.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, -.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd { - display:none; - width:5px; - position:relative; - float:left; - background-color:#F8981D; -} -.memberSummary .activeTableTab .tabEnd { - display:none; - width:5px; - margin-right:3px; - position:relative; - float:left; - background-color:#F8981D; -} -.memberSummary .tableTab .tabEnd { - display:none; - width:5px; - margin-right:3px; - position:relative; - background-color:#4D7A97; - float:left; - -} -.overviewSummary td, .memberSummary td, .typeSummary td, -.useSummary td, .constantsSummary td, .deprecatedSummary td { - text-align:left; - padding:0px 0px 12px 10px; -} -th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th, -td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{ - vertical-align:top; - padding-right:0px; - padding-top:8px; - padding-bottom:3px; -} -th.colFirst, th.colLast, th.colOne, .constantsSummary th { - background:#dee3e9; - text-align:left; - padding:8px 3px 3px 7px; -} -td.colFirst, th.colFirst { - white-space:nowrap; - font-size:13px; -} -td.colLast, th.colLast { - font-size:13px; -} -td.colOne, th.colOne { - font-size:13px; -} -.overviewSummary td.colFirst, .overviewSummary th.colFirst, -.useSummary td.colFirst, .useSummary th.colFirst, -.overviewSummary td.colOne, .overviewSummary th.colOne, -.memberSummary td.colFirst, .memberSummary th.colFirst, -.memberSummary td.colOne, .memberSummary th.colOne, -.typeSummary td.colFirst{ - width:25%; - vertical-align:top; -} -td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { - font-weight:bold; -} -.tableSubHeadingColor { - background-color:#EEEEFF; -} -.altColor { - background-color:#FFFFFF; -} -.rowColor { - background-color:#EEEEEF; -} -/* -Content styles -*/ -.description pre { - margin-top:0; -} -.deprecatedContent { - margin:0; - padding:10px 0; -} -.docSummary { - padding:0; -} - -ul.blockList ul.blockList ul.blockList li.blockList h3 { - font-style:normal; -} - -div.block { - font-size:14px; - font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; -} - -td.colLast div { - padding-top:0px; -} - - -td.colLast a { - padding-bottom:3px; -} -/* -Formatting effect styles -*/ -.sourceLineNo { - color:green; - padding:0 30px 0 0; -} -h1.hidden { - visibility:hidden; - overflow:hidden; - font-size:10px; -} -.block { - display:block; - margin:3px 10px 2px 0px; - color:#474747; -} -.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink, -.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel, -.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink { - font-weight:bold; -} -.deprecationComment, .emphasizedPhrase, .interfaceName { - font-style:italic; -} - -div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase, -div.block div.block span.interfaceName { - font-style:normal; -} - -div.contentContainer ul.blockList li.blockList h2{ - padding-bottom:0px; -} diff --git a/examples/indexing/Create an Index and Add Documents.md b/examples/indexing/Create an Index and Add Documents.md index 6ca9e889e..6e4cabba1 100644 --- a/examples/indexing/Create an Index and Add Documents.md +++ b/examples/indexing/Create an Index and Add Documents.md @@ -8,7 +8,11 @@ import com.textkernel.tx.models.resume.ParsedResume; public class ParsingExample { public static void main(String[] args) { - TxClient client = new TxClient("12345678", "abcdefghijklmnopqrstuvwxyz", DataCenter.US); + TxClientSettings settings = new TxClientSettings(); + settings.AccountId = "12345678"; + settings.ServiceKey = "abcdefghijklmnopqrstuvwxyz"; + settings.DataCenter = DataCenter.US; + TxClient client = new TxClient(settings); ParsedResume parsedResume1 = ...;//output from Resume Parser ParsedResume parsedResume2 = ...;//output from Resume Parser @@ -16,9 +20,9 @@ public class ParsingExample { String indexId = "myResumes"; try { - client.createIndex(IndexType.Resume, indexId); - client.indexDocument(parsedResume1, indexId, "resume-1", null); - client.indexDocument(parsedResume2, indexId, "resume-2", null); + client.searchMatchV1().createIndex(IndexType.Resume, indexId); + client.searchMatchV1().indexDocument(parsedResume1, indexId, "resume-1", null); + client.searchMatchV1().indexDocument(parsedResume2, indexId, "resume-2", null); //if we get here, it was 200-OK and all operations succeeded System.out.println("Success!"); diff --git a/examples/parsing/Basic Parsing.md b/examples/parsing/Basic Parsing.md index eb2ba22bb..7c5d63946 100644 --- a/examples/parsing/Basic Parsing.md +++ b/examples/parsing/Basic Parsing.md @@ -21,7 +21,11 @@ import java.time.format.DateTimeFormatter; public class ParsingExample { public static void main(String[] args) throws IOException { - TxClient client = new TxClient("12345678", "abcdefghijklmnopqrstuvwxyz", DataCenter.US); + TxClientSettings settings = new TxClientSettings(); + settings.AccountId = "12345678"; + settings.ServiceKey = "abcdefghijklmnopqrstuvwxyz"; + settings.DataCenter = DataCenter.US; + TxClient client = new TxClient(settings); //A Document is an unparsed File (PDF, Word Doc, etc) Document doc = new Document("resume.docx"); @@ -31,7 +35,7 @@ public class ParsingExample { ParseRequest request = new ParseRequest(doc, new ParseOptions()); try { - ParseResumeResponse response = client.parseResume(request); + ParseResumeResponse response = client.parser().parseResume(request); //if we get here, it was 200-OK and all operations succeeded //now we can use the response to output some of the data from the resume diff --git a/examples/parsing/Parsing With Geocoding and Indexing.md b/examples/parsing/Parsing With Geocoding and Indexing.md index 1c3d82d91..ab53dfd6f 100644 --- a/examples/parsing/Parsing With Geocoding and Indexing.md +++ b/examples/parsing/Parsing With Geocoding and Indexing.md @@ -7,7 +7,7 @@ import com.textkernel.tx.exceptions.TxUsableResumeException; import com.textkernel.tx.models.Document; import com.textkernel.tx.models.api.geocoding.GeocodeOptions; import com.textkernel.tx.models.api.geocoding.GeocodeProvider; -import com.textkernel.tx.models.api.indexes.IndexSingleDocumentInfo; +import com.textkernel.tx.models.api.indexes.IndexingOptionsGeneric; import com.textkernel.tx.models.api.parsing.ParseOptions; import com.textkernel.tx.models.api.parsing.ParseRequest; import com.textkernel.tx.models.api.parsing.ParseResumeResponse; @@ -15,7 +15,11 @@ import java.io.IOException; public class ParsingExample { public static void main(String[] args) throws IOException { - TxClient client = new TxClient("12345678", "abcdefghijklmnopqrstuvwxyz", DataCenter.US); + TxClientSettings settings = new TxClientSettings(); + settings.AccountId = "12345678"; + settings.ServiceKey = "abcdefghijklmnopqrstuvwxyz"; + settings.DataCenter = DataCenter.US; + TxClient client = new TxClient(settings); //A Document is an unparsed File (PDF, Word Doc, etc) Document doc = new Document("resume.docx"); @@ -24,15 +28,13 @@ public class ParsingExample { options.GeocodeOptions = new GeocodeOptions(); options.GeocodeOptions.IncludeGeocoding = true; - options.IndexingOptions = new IndexSingleDocumentInfo(); - options.IndexingOptions.IndexId = "myResumes"; - options.IndexingOptions.DocumentId = "abc-123"; + options.IndexingOptions = new IndexingOptionsGeneric("abc-123", "myResumes", null); //create a request to send ParseRequest request = new ParseRequest(doc, options); try { - ParseResumeResponse response = client.parseResume(request); + ParseResumeResponse response = client.parser().parseResume(request); //if we get here, it was 200-OK and all operations succeeded System.out.println("Success!"); diff --git a/pom.xml b/pom.xml index 33870be42..084791f3b 100644 --- a/pom.xml +++ b/pom.xml @@ -4,7 +4,7 @@ com.textkernel tx-java - 2.3.4 + 3.0.0 jar Textkernel Tx Java SDK diff --git a/src/main/java/com/textkernel/tx/ApiEndpoints.java b/src/main/java/com/textkernel/tx/ApiEndpoints.java deleted file mode 100644 index b4a75263f..000000000 --- a/src/main/java/com/textkernel/tx/ApiEndpoints.java +++ /dev/null @@ -1,115 +0,0 @@ -// Copyright © 2023 Textkernel BV. All rights reserved. -// This file is provided for use by, or on behalf of, Textkernel licensees -// within the terms of their license of Textkernel products or Textkernel customers -// within the Terms of Service pertaining to the Textkernel SaaS products. - -package com.textkernel.tx; - -import com.textkernel.tx.models.api.dataenrichment.TaxonomyFormat; - -class ApiEndpoints { - - private static String _matchUIPrefix = "/ui"; - private DataCenter _dataCenter; - - ApiEndpoints(DataCenter dataCenter) { - _dataCenter = dataCenter; - } - - private String prefix() { - return prefix(false); - } - - private String prefix(boolean isMatchUI) { - if (isMatchUI && !_dataCenter.IsSaaS) { - //throw new IllegalAccessException("Cannot call Matching UI on a self-hosted installation."); - //do not throw this for now, it will just be a 404 - } - - String versionSuffix = ""; - if (_dataCenter.Version != null && !_dataCenter.Version.trim().isEmpty()){ - versionSuffix = "/" + _dataCenter.Version; - } - - return _dataCenter.Root + (isMatchUI ? _matchUIPrefix : "") + versionSuffix; - } - - private String sanitize(String indexOrDocId) throws IllegalArgumentException { - if (indexOrDocId == null || indexOrDocId.length() == 0) { - throw new IllegalArgumentException("Index or document id is null or empty"); - } - - for (char c : indexOrDocId.toCharArray()) { - //if its not a letter, digit, dash, or underscore, invalid - if (!(Character.isLetterOrDigit(c) || c == '-' || c == '_')) { - String charName = Character.isWhitespace(c) ? "whitespace" : String.valueOf(c); - throw new IllegalArgumentException("Index or document id contains an invalid character: " + charName); - } - } - - return indexOrDocId; - } - - String account() { return prefix() + "/account"; } - String parseResume() { return prefix() + "/parser/resume"; } - String parseJob() { return prefix() + "/parser/joborder"; } - - String index(String id) { return prefix() + "/index/" + sanitize(id); } - String indexDocumentCount(String id) { return prefix() + "/index/" + sanitize(id) + "/count"; } - String allIndexes() { return prefix() + "/index"; } - - String resume(String indexId, String docId) { return prefix() + "/index/" + sanitize(indexId) + "/resume/" + sanitize(docId); } - String job(String indexId, String docId) { return prefix() + "/index/" + sanitize(indexId) + "/joborder/" + sanitize(docId); } - String multipleResumes(String indexId) { return prefix() + "/index/" + sanitize(indexId) + "/resumes"; } - String multipleJobs(String indexId) { return prefix() + "/index/" + sanitize(indexId) + "/joborders"; } - String document(String indexId, String docId) { return prefix() + "/index/" + sanitize(indexId) + "/documents/" + sanitize(docId); } - String multipleDocuments(String indexId) { return prefix() + "/index/" + sanitize(indexId) + "/documents"; } - - String matchResume(boolean isMatchUI) { return prefix(isMatchUI) + "/matcher/resume"; } - String matchJob(boolean isMatchUI) { return prefix(isMatchUI) + "/matcher/joborder"; } - String matchDocId(String indexId, String docId, boolean isMatchUI) { return prefix(isMatchUI) + "/matcher/indexes/" + sanitize(indexId) + "/documents/" + sanitize(docId); } - String search(boolean isMatchUI) { return prefix(isMatchUI) + "/searcher"; } - - String bimetricScoreResume(boolean isMatchUI) { return prefix(isMatchUI) + "/scorer/bimetric/resume"; } - String bimetricScoreJob(boolean isMatchUI) { return prefix(isMatchUI) + "/scorer/bimetric/joborder"; } - - String geocodeResume() { return prefix() + "/geocoder/resume"; } - String geocodeJob() { return prefix() + "/geocoder/joborder"; } - String geocodeAndIndexResume() { return prefix() + "/geocodeAndIndex/resume"; } - String geocodeAndIndexJob() { return prefix() + "/geocodeAndIndex/joborder"; } - - String desSkillsGetTaxonomy(TaxonomyFormat format) { return prefix(false) + "/skills/taxonomy?format="+ format; } - String desSkillsGetMetadata() { return prefix(false) + "/skills/metadata"; } - String desSkillsNormalize() { return prefix(false) + "/skills/normalize"; } - String desSkillsExtract() { return prefix(false) + "/skills/extract"; } - String desSkillsLookup() { return prefix(false) + "/skills/lookup"; } - String desSkillsAutoComplete() { return prefix(false) + "/skills/autoComplete"; } - String desSkillsGetTaxonomyV2(TaxonomyFormat format) { return prefix(false) + "/skills/v2/taxonomy?format="+ format; } - String desSkillsGetMetadataV2() { return prefix(false) + "/skills/v2/metadata"; } - String desSkillsNormalizeV2() { return prefix(false) + "/skills/v2/normalize"; } - String desSkillsExtractV2() { return prefix(false) + "/skills/v2/extract"; } - String desSkillsLookupV2() { return prefix(false) + "/skills/v2/lookup"; } - String desSkillsAutoCompleteV2() { return prefix(false) + "/skills/v2/autoComplete"; } - String desProfessionsGetTaxonomy(TaxonomyFormat format, String language) { return prefix(false) + "/professions/taxonomy?format="+ format +"&language="+ language; } - String desProfessionsGetMetadata() { return prefix(false) + "/professions/metadata"; } - String desProfessionsNormalize() { return prefix(false) + "/professions/normalize"; } - String desProfessionsLookup() { return prefix(false) + "/professions/lookup"; } - String desProfessionsAutoComplete() { return prefix(false) + "/professions/autoComplete"; } - String desOntologySuggestSkillsFromProfessions() { return prefix(false) + "/ontology/suggest-skills-from-professions"; } - String desOntologySuggestSkillsFromSkills() { return prefix(false) + "/ontology/suggest-skills-from-skills"; } - String desOntologyCompareProfessions() { return prefix(false) + "/ontology/compare-professions"; } - String desOntologySuggestProfessions() { return prefix(false) + "/ontology/suggest-professions"; } - String desOntologyCompareSkillsToProfession() { return prefix(false) + "/ontology/compare-skills-to-profession"; } - String desOntologySkillsSimilarityScore() { return prefix(false) + "/ontology/skills-similarity-score"; } - String desOntologySuggestSkillsFromProfessionsV2() { return prefix(false) + "/ontology/v2/suggest-skills-from-professions"; } - String desOntologySuggestSkillsFromSkillsV2() { return prefix(false) + "/ontology/v2/suggest-skills-from-skills"; } - String desOntologyCompareProfessionsV2() { return prefix(false) + "/ontology/v2/compare-professions"; } - String desOntologySuggestProfessionsV2() { return prefix(false) + "/ontology/v2/suggest-professions"; } - String desOntologyCompareSkillsToProfessionV2() { return prefix(false) + "/ontology/v2/compare-skills-to-profession"; } - String desOntologySkillsSimilarityScoreV2() { return prefix(false) + "/ontology/v2/skills-similarity-score"; } - - String jobDescriptionGenerate() { return prefix(false) + "/job-description/generate"; } - String jobDescriptionSuggestSkills() { return prefix(false) + "/job-description/suggest-skills"; } - - String formatResume() { return prefix() + "/formatter/resume/template"; } -} diff --git a/src/main/java/com/textkernel/tx/DataCenter.java b/src/main/java/com/textkernel/tx/DataCenter.java index 526305e94..e8042ab49 100644 --- a/src/main/java/com/textkernel/tx/DataCenter.java +++ b/src/main/java/com/textkernel/tx/DataCenter.java @@ -9,29 +9,24 @@ public class DataCenter { /** Represents the US datacenter. You can find out which datacenter your account is in at https://cloud.textkernel.com/tx/console*/ - public static DataCenter US = new DataCenter("https://api.us.textkernel.com/tx", "v10", true); + public static DataCenter US = new DataCenter("https://api.us.textkernel.com/tx/v10"); /** Represents the EU datacenter. You can find out which datacenter your account is in at https://cloud.textkernel.com/tx/console*/ - public static DataCenter EU = new DataCenter("https://api.eu.textkernel.com/tx", "v10", true); + public static DataCenter EU = new DataCenter("https://api.eu.textkernel.com/tx/v10"); /** Represents the AU datacenter. You can find out which datacenter your account is in at https://cloud.textkernel.com/tx/console*/ - public static DataCenter AU = new DataCenter("https://api.au.textkernel.com/tx", "v10", true); + public static DataCenter AU = new DataCenter("https://api.au.textkernel.com/tx/v10"); - String Root; - String Version; - boolean IsSaaS; - - protected DataCenter(String root, String version, boolean isSaaS) { - Root = root; - Version = version; - IsSaaS = isSaaS; - } + public String Url; /** * Create a DataCenter for a self-hosted instance - * @param endpoint The URL of your self-hosted instance + * @param url The URL of your self-hosted instance */ - public DataCenter(String endpoint) { - this(endpoint, null, false); + public DataCenter(String url) { + if (url == null || url == "") { + throw new IllegalArgumentException("Url cannot be null/empty"); + } + Url = url; } } diff --git a/src/main/java/com/textkernel/tx/EnvironmentSettings.java b/src/main/java/com/textkernel/tx/EnvironmentSettings.java new file mode 100644 index 000000000..6faab12ff --- /dev/null +++ b/src/main/java/com/textkernel/tx/EnvironmentSettings.java @@ -0,0 +1,27 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx; + +import com.textkernel.tx.models.api.matchV2.MatchV2Environment; + +/** Settings to configure things that would have an effect across many API endpoints */ +public class EnvironmentSettings { + /** + * Should certification skills be included when using the Skills Intelligence APIs + */ + public boolean SkillsIntelligenceIncludeCertifications = true; + + /** + * The environment to target for any SearchMatchV2 API calls + */ + public MatchV2Environment MatchV2Environment = com.textkernel.tx.models.api.matchV2.MatchV2Environment.ACC; + + /** + * The Data Center for your account. Either {@link DataCenter#US}, {@link DataCenter#EU}, or {@link DataCenter#AU}. + * Found at https://cloud.textkernel.com/tx/console + */ + public DataCenter DataCenter; +} diff --git a/src/main/java/com/textkernel/tx/TxClient.java b/src/main/java/com/textkernel/tx/TxClient.java index 74b5dc8d9..75fc3ac73 100644 --- a/src/main/java/com/textkernel/tx/TxClient.java +++ b/src/main/java/com/textkernel/tx/TxClient.java @@ -6,97 +6,72 @@ package com.textkernel.tx; import com.textkernel.tx.exceptions.*; -import com.textkernel.tx.http.HttpResponse; -import com.textkernel.tx.models.GeoCoordinates; -import com.textkernel.tx.models.api.ApiResponse; -import com.textkernel.tx.models.api.ApiResponseInfoLite; -import com.textkernel.tx.models.api.account.GetAccountInfoResponse; -import com.textkernel.tx.models.api.bimetricscoring.*; -import com.textkernel.tx.models.api.dataenrichment.AutocompleteRequest; -import com.textkernel.tx.models.api.dataenrichment.GetMetadataResponse; -import com.textkernel.tx.models.api.dataenrichment.TaxonomyFormat; -import com.textkernel.tx.models.api.dataenrichment.skills.response.GetSkillsTaxonomyResponseValue; -import com.textkernel.tx.models.api.dataenrichment.professions.response.GetProfessionsTaxonomyResponseValue; -import com.textkernel.tx.models.api.dataenrichment.ontology.request.CompareProfessionsRequest; -import com.textkernel.tx.models.api.dataenrichment.ontology.request.CompareSkillsToProfessionRequest; -import com.textkernel.tx.models.api.dataenrichment.ontology.request.SkillsSimilarityScoreRequest; -import com.textkernel.tx.models.api.dataenrichment.ontology.request.SuggestProfessionsRequest; -import com.textkernel.tx.models.api.dataenrichment.ontology.request.SuggestSkillsFromProfessionsRequest; -import com.textkernel.tx.models.api.dataenrichment.ontology.request.SuggestSkillsFromSkillsRequest; -import com.textkernel.tx.models.api.dataenrichment.ontology.response.CompareProfessionsResponse; -import com.textkernel.tx.models.api.dataenrichment.ontology.response.CompareSkillsToProfessionResponse; -import com.textkernel.tx.models.api.dataenrichment.ontology.response.SuggestProfessionsResponse; -import com.textkernel.tx.models.api.dataenrichment.ontology.response.SuggestSkillsResponse; -import com.textkernel.tx.models.api.dataenrichment.ontology.response.SkillScore; -import com.textkernel.tx.models.api.dataenrichment.ontology.response.SkillsSimilarityScoreResponse; -import com.textkernel.tx.models.api.dataenrichment.professions.request.LookupProfessionCodesRequest; -import com.textkernel.tx.models.api.dataenrichment.professions.request.NormalizeProfessionsRequest; -import com.textkernel.tx.models.api.dataenrichment.professions.response.GetProfessionsTaxonomyResponse; -import com.textkernel.tx.models.api.dataenrichment.professions.response.LookupProfessionCodesResponse; -import com.textkernel.tx.models.api.dataenrichment.professions.response.NormalizeProfessionsResponse; -import com.textkernel.tx.models.api.dataenrichment.professions.response.ProfessionsAutoCompleteResponse; -import com.textkernel.tx.models.api.dataenrichment.skills.request.ExtractSkillsRequest; -import com.textkernel.tx.models.api.dataenrichment.skills.request.LookupSkillsRequest; -import com.textkernel.tx.models.api.dataenrichment.skills.request.NormalizeSkillsRequest; -import com.textkernel.tx.models.api.dataenrichment.skills.request.SkillsAutoCompleteRequest; -import com.textkernel.tx.models.api.dataenrichment.skills.response.AutoCompleteSkillsResponse; -import com.textkernel.tx.models.api.dataenrichment.skills.response.ExtractSkillsResponse; -import com.textkernel.tx.models.api.dataenrichment.skills.response.GetSkillsTaxonomyResponse; -import com.textkernel.tx.models.api.dataenrichment.skills.response.LookupSkillCodesResponse; -import com.textkernel.tx.models.api.dataenrichment.skills.response.NormalizeSkillsResponse; -import com.textkernel.tx.models.api.formatter.FormatResumeRequest; -import com.textkernel.tx.models.api.formatter.FormatResumeResponse; -import com.textkernel.tx.models.api.geocoding.*; -import com.textkernel.tx.models.api.indexes.*; -import com.textkernel.tx.models.api.jobdescription.GenerateJobRequest; -import com.textkernel.tx.models.api.jobdescription.GenerateJobResponse; -import com.textkernel.tx.models.api.jobdescription.SuggestSkillsFromJobTitleRequest; -import com.textkernel.tx.models.api.jobdescription.SuggestSkillsFromJobTitleResponse; -import com.textkernel.tx.models.api.matching.*; -import com.textkernel.tx.models.api.matching.request.FilterCriteria; -import com.textkernel.tx.models.api.matching.request.MatchByDocumentIdOptions; -import com.textkernel.tx.models.api.matching.request.PaginationSettings; -import com.textkernel.tx.models.api.matching.request.SearchMatchSettings; -import com.textkernel.tx.models.api.matching.ui.GenerateUIResponse; -import com.textkernel.tx.models.api.matching.ui.request.*; -import com.textkernel.tx.models.api.matching.ui.UIOptions; -import com.textkernel.tx.models.job.ParsedJob; -import com.textkernel.tx.models.resume.ParsedResume; -import com.textkernel.tx.models.resume.employment.Position; -import com.textkernel.tx.models.resume.skills.ResumeNormalizedSkill; +import com.textkernel.tx.services.AccountService; +import com.textkernel.tx.services.FormatterService; +import com.textkernel.tx.services.GeocoderService; +import com.textkernel.tx.services.MatchV2Service; +import com.textkernel.tx.services.ParserService; +import com.textkernel.tx.services.SearchMatchService; +import com.textkernel.tx.services.SkillsIntelligenceService; import okhttp3.Interceptor; -import okhttp3.MediaType; import okhttp3.OkHttpClient; import okhttp3.Request; -import okhttp3.RequestBody; import okhttp3.Response; - -import com.textkernel.tx.models.api.parsing.ParseRequest; -import com.textkernel.tx.models.api.parsing.ParseResumeResponse; -import com.textkernel.tx.models.api.parsing.ParseJobResponse; -import com.textkernel.tx.models.matching.IndexType; -import com.textkernel.tx.utilities.TxJsonSerializer; - import java.io.IOException; -import java.time.Instant; -import java.util.ArrayList; -import java.util.Collections; -import java.util.Comparator; -import java.util.List; -import java.util.Optional; import java.util.concurrent.TimeUnit; -import java.util.stream.Collectors; + /** * The SDK client to perform Tx API calls. */ public class TxClient { - private ApiEndpoints _endpoints; - private OkHttpClient _client; - private static final MediaType JSON = MediaType.get("application/json; charset=utf-8"); + private static final String _sdkVersion; + + private AccountService _accountService; + private FormatterService _formatterService; + private GeocoderService _geocoderService; + private MatchV2Service _searchMatchV2Service; + private ParserService _parserService; + private SearchMatchService _searchMatchV1Service; + private SkillsIntelligenceService _skillsIntelligenceService; + + /** + * @return access all endpoints/methods for Accounts + */ + public AccountService account() { return _accountService; } + + /** + * @return access all endpoints/methods for the Resumer Formatter + */ + public FormatterService formatter() { return _formatterService; } + + /** + * @return access all endpoints/methods for the Geocoder + */ + public GeocoderService geocoder() { return _geocoderService; } + + /** + * @return access all endpoints/methods for Search & Match V2 + */ + public MatchV2Service searchMatchV2() { return _searchMatchV2Service; } + + /** + * @return access all endpoints/methods for the Resume & Job Parsers + */ + public ParserService parser() { return _parserService; } + + /** + * @return access all endpoints/methods for Skills Intelligence + */ + public SkillsIntelligenceService skillsIntelligence() { return _skillsIntelligenceService; } + + /** + * @return access all endpoints/methods for Search & Match V1 + */ + public SearchMatchService searchMatchV1() { return _searchMatchV1Service; } static { _sdkVersion = TxClient.class.getPackage().getImplementationVersion(); @@ -106,51 +81,38 @@ public class TxClient { * Set to {@code true} for debugging API errors. It will show the full JSON request body in {@link TxException#RequestBody} *
NOTE: do not set this to {@code true} in your production system, as it increases the memory footprint */ - public boolean ShowFullRequestBodyInExceptions = false; - - /** - * Create an SDK client to perform Tx API calls with the account information found at https://cloud.textkernel.com/tx/console - * @param accountId - The account id for your account - * @param serviceKey - The service key for your account - * @param dataCenter - The Data Center for your account. Either {@link DataCenter#US}, {@link DataCenter#EU}, or {@link DataCenter#AU} - * @throws IllegalArgumentException if the accountId, serviceKey, or dataCenter are null/empty - */ - public TxClient(String accountId, String serviceKey, DataCenter dataCenter) { - this(accountId, serviceKey, dataCenter, null); - } + public static boolean ShowFullRequestBodyInExceptions = false; /** - * Create an SDK client to perform Tx API calls with the account information found at https://cloud.textkernel.com/tx/console - * @param accountId - The account id for your account - * @param serviceKey - The service key for your account - * @param dataCenter - The Data Center for your account. Either {@link DataCenter#US}, {@link DataCenter#EU}, or {@link DataCenter#AU} - * @param trackingTags - Optional tags to use to track API usage for your account + * Create an SDK client to perform Tx API calls + * @param settings - The settings for this client * @throws IllegalArgumentException if the accountId, serviceKey, or dataCenter are null/empty */ - public TxClient(String accountId, String serviceKey, DataCenter dataCenter, List trackingTags) { - this(accountId, serviceKey, dataCenter, trackingTags, 30); + public TxClient(TxClientSettings settings) { + this(settings, 30); } /** - * Create an SDK client to perform Tx API calls with the account information found at https://cloud.textkernel.com/tx/console - * @param accountId - The account id for your account - * @param serviceKey - The service key for your account - * @param dataCenter - The Data Center for your account. Either {@link DataCenter#US}, {@link DataCenter#EU}, or {@link DataCenter#AU} - * @param trackingTags - Optional tags to use to track API usage for your account + * Create an SDK client to perform Tx API calls + * @param settings - The settings for this client * @param httpTimeoutSecs - Optional override for the OkHttp client read timeout (write and connect are 10 seconds, read is 30 seconds by default) * @throws IllegalArgumentException if the accountId, serviceKey, or dataCenter are null/empty */ - public TxClient(String accountId, String serviceKey, DataCenter dataCenter, List trackingTags, long httpTimeoutSecs) { + public TxClient(TxClientSettings settings, long httpTimeoutSecs) { - if (accountId == null || accountId.length() == 0) { + if (settings == null) { + throw new IllegalArgumentException("'settings' cannot be null"); + } + + if (settings.AccountId == null || settings.AccountId.length() == 0) { throw new IllegalArgumentException("'accountId' must have a valid value"); } - if (serviceKey == null || serviceKey.length() == 0) { + if (settings.ServiceKey == null || settings.ServiceKey.length() == 0) { throw new IllegalArgumentException("'serviceKey' must have a valid value"); } - if (dataCenter == null) { + if (settings.DataCenter == null) { throw new IllegalArgumentException("'dataCenter' must not be null"); } @@ -158,12 +120,10 @@ public TxClient(String accountId, String serviceKey, DataCenter dataCenter, List throw new IllegalArgumentException("'httpTimeoutSecs' must be greater than 0"); } - _endpoints = new ApiEndpoints(dataCenter); - final String trackingTagsHeaderValue;//must be final to be passed into the interceptor below - if (trackingTags != null && trackingTags.size() > 0) { - trackingTagsHeaderValue = String.join(", ", trackingTags); + if (settings.TrackingTags != null && settings.TrackingTags.size() > 0) { + trackingTagsHeaderValue = String.join(", ", settings.TrackingTags); if (trackingTagsHeaderValue.length() >= 75) {//API allows 100, but just to be safe, this should be way more than enough throw new IllegalArgumentException("'trackingTags' has too many values or the values are too long"); } @@ -173,7 +133,7 @@ public TxClient(String accountId, String serviceKey, DataCenter dataCenter, List } //do not validate credentials here, as this could lead to calling GetAccount for every parse call, an AUP violation - _client = new OkHttpClient.Builder() + OkHttpClient httpClient = new OkHttpClient.Builder() .addInterceptor(new Interceptor() { @Override public Response intercept(Interceptor.Chain chain) throws IOException { @@ -181,16 +141,10 @@ public Response intercept(Interceptor.Chain chain) throws IOException { //set all of these headers on every request okhttp3.Request.Builder builder = original.newBuilder(); - builder.header("Tx-AccountId", accountId); - builder.header("Tx-ServiceKey", serviceKey); + builder.header("Tx-AccountId", settings.AccountId); + builder.header("Tx-ServiceKey", settings.ServiceKey); builder.header("User-Agent", "tx-java-" + _sdkVersion); - if (!dataCenter.IsSaaS) { - //for backward compatibility in on-prem use cases - builder.header("Sovren-AccountId", accountId); - builder.header("Sovren-ServiceKey", serviceKey); - } - if (trackingTagsHeaderValue != null && !trackingTagsHeaderValue.isEmpty()){ builder.header("Tx-TrackingTag", trackingTagsHeaderValue); } @@ -203,2492 +157,13 @@ public Response intercept(Interceptor.Chain chain) throws IOException { .writeTimeout(10, TimeUnit.SECONDS) .readTimeout(httpTimeoutSecs, TimeUnit.SECONDS) .build(); - } - - @SuppressWarnings("deprecation") - private RequestBody createJsonBody(Object body) { - // Use OkHttp v3 signature to ensure binary compatibility between v3 and v4 - // https://github.com/textkernel/tx-java/issues/36 - return RequestBody.create(JSON, TxJsonSerializer.serialize(body)); - } - - private > HttpResponse executeRequest(Request apiRequest, Class classOfT, String requestBody) throws TxException { - - ApiResponseInfoLite errorInfo = new ApiResponseInfoLite(); - errorInfo.Code = "Error"; - errorInfo.Message = "Unknown API error."; - - HttpResponse apiResponse = null; - Response rawResponse = null; - - try { - rawResponse = _client.newCall(apiRequest).execute(); - apiResponse = new HttpResponse(rawResponse, classOfT); - - if (rawResponse != null && rawResponse.code() == 413) { - errorInfo.Message = "Request body was too large."; - throw new TxException(requestBody, rawResponse, errorInfo, null); - } - - if (rawResponse != null && apiResponse.getData() == null && rawResponse.code() != 200) { - //something went wrong, a non-200 status code - errorInfo.Message = rawResponse.code() + " - " + rawResponse.message(); - } - - if (apiResponse == null || apiResponse.getData() == null) throw new TxException(requestBody, rawResponse, errorInfo, null); - } - catch (IOException e) { - errorInfo.Message = e.getMessage(); - TxException newEx = new TxException(requestBody, rawResponse, errorInfo, null); - newEx.InnerException = e; - throw newEx; - } - - if (!rawResponse.isSuccessful()) throw new TxException(requestBody, rawResponse, apiResponse.getData().Info); - - return apiResponse; - } - - private GenerateUIResponse executeUIRequest(Request apiRequest, String requestBody) throws TxException { - - ApiResponseInfoLite errorInfo = new ApiResponseInfoLite(); - errorInfo.Code = "Error"; - errorInfo.Message = "Unknown API error."; - - GenerateUIResponse apiResponse = null; - Response rawResponse = null; - String transId = "matchui-" + Instant.now().toString(); - - try { - rawResponse = _client.newCall(apiRequest).execute(); - - if (!rawResponse.isSuccessful()) { - errorInfo.Message = rawResponse.body().string(); - throw new TxException(requestBody, rawResponse, errorInfo, transId); - } - - String responseBodyStr = rawResponse.body().string(); - apiResponse = TxJsonSerializer.deserialize(responseBodyStr, GenerateUIResponse.class); - - if (apiResponse == null) throw new TxException(requestBody, rawResponse, errorInfo, transId); - } - catch (IOException e) { - errorInfo.Message = e.getMessage(); - TxException newEx = new TxException(requestBody, rawResponse, errorInfo, transId); - newEx.InnerException = e; - throw newEx; - } - - return apiResponse; - } - - private String getBodyIfDebug(Request request) { - - if (ShowFullRequestBodyInExceptions) { - try { - final Request copy = request.newBuilder().build(); - final okio.Buffer buffer = new okio.Buffer(); - copy.body().writeTo(buffer); - return buffer.readUtf8(); - } - catch (IOException e) { - return null; - } - } - - return null; - } - - /** - * Get the account info (remaining credits, max concurrency, etc). - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public GetAccountInfoResponse getAccountInfo() throws TxException { - Request apiRequest = new Request.Builder() - .url(_endpoints.account()) - .build(); - - HttpResponse response = executeRequest(apiRequest, GetAccountInfoResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - /** - * Format a resume into a standardized template that you provide - * @param request The request body - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public FormatResumeResponse formatResume(FormatResumeRequest request) throws TxException { - RequestBody body = createJsonBody(request); - Request apiRequest = new Request.Builder() - .url(_endpoints.formatResume()) - .post(body) - .build(); - - HttpResponse response = executeRequest(apiRequest, FormatResumeResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - /** - * Parse a resume - * @param request The request body - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public ParseResumeResponse parseResume(ParseRequest request) throws TxException { - RequestBody body = createJsonBody(request); - Request apiRequest = new Request.Builder() - .url(_endpoints.parseResume()) - .post(body) - .build(); - - HttpResponse response = executeRequest(apiRequest, ParseResumeResponse.class, getBodyIfDebug(apiRequest)); - - if (response.getData().Value.ParsingResponse != null && !response.getData().Value.ParsingResponse.isSuccess()) { - throw new TxException(getBodyIfDebug(apiRequest), response.getResponse(), response.getData().Value.ParsingResponse, response.getData().Info.TransactionId); - } - - if (response.getData().Value.GeocodeResponse != null && !response.getData().Value.GeocodeResponse.isSuccess()) { - throw new TxGeocodeResumeException(response.getResponse(), response.getData().Value.GeocodeResponse, response.getData().Info.TransactionId, response.getData()); - } - - if (response.getData().Value.IndexingResponse != null && !response.getData().Value.IndexingResponse.isSuccess()) { - throw new TxIndexResumeException(response.getResponse(), response.getData().Value.IndexingResponse, response.getData().Info.TransactionId, response.getData()); - } - - return response.getData(); - } - - /** - * Parse a job - * @param request The request body - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public ParseJobResponse parseJob(ParseRequest request) throws TxException { - RequestBody body = createJsonBody(request); - Request apiRequest = new Request.Builder() - .url(_endpoints.parseJob()) - .post(body) - .build(); - - HttpResponse response = executeRequest(apiRequest, ParseJobResponse.class, getBodyIfDebug(apiRequest)); - - if (response.getData().Value.ParsingResponse != null && !response.getData().Value.ParsingResponse.isSuccess()) { - throw new TxException(getBodyIfDebug(apiRequest), response.getResponse(), response.getData().Value.ParsingResponse, response.getData().Info.TransactionId); - } - - if (response.getData().Value.GeocodeResponse != null && !response.getData().Value.GeocodeResponse.isSuccess()) { - throw new TxGeocodeJobException(response.getResponse(), response.getData().Value.GeocodeResponse, response.getData().Info.TransactionId, response.getData()); - } - - if (response.getData().Value.IndexingResponse != null && !response.getData().Value.IndexingResponse.isSuccess()) { - throw new TxIndexJobException(response.getResponse(), response.getData().Value.IndexingResponse, response.getData().Info.TransactionId, response.getData()); - } - - return response.getData(); - } - - /** - * Create a new index - * @param type The type of documents stored in this index. Either 'Resume' or 'Job' - * @param indexId - * The ID to assign to the new index. This is restricted to alphanumeric with dashes - * and underscores. All values will be converted to lower-case. - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public CreateIndexResponse createIndex(IndexType type, String indexId) throws TxException { - CreateIndexRequest request = new CreateIndexRequest(); - request.IndexType = type; - - RequestBody body = createJsonBody(request); - Request apiRequest = new Request.Builder() - .url(_endpoints.index(indexId)) - .post(body) - .build(); - - HttpResponse response = executeRequest(apiRequest, CreateIndexResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - /** - * Get all existing indexes - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public GetAllIndexesResponse getAllIndexes() throws TxException { - Request apiRequest = new Request.Builder() - .url(_endpoints.allIndexes()) - .build(); - - HttpResponse response = executeRequest(apiRequest, GetAllIndexesResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - /** - * Delete an existing index. Note that this is a destructive action and cannot be undone. - * All the documents in this index will be deleted. - * @param indexId The index to delete (case-insensitive). - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public DeleteIndexResponse deleteIndex(String indexId) throws TxException { - Request apiRequest = new Request.Builder() - .url(_endpoints.index(indexId)) - .delete() - .build(); - - HttpResponse response = executeRequest(apiRequest, DeleteIndexResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - /** - * Add a resume to an existing index - * @param resume A resume generated by the Resume Parser - * @param indexId The index the document should be added into (case-insensitive). - * @param documentId - * The ID to assign to the new document. This is restricted to alphanumeric - * with dashes and underscores. All values will be converted to lower-case. - * @param userDefinedTags The user-defined tags that the resume should have, or {@code null} - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public IndexDocumentResponse indexDocument( - ParsedResume resume, - String indexId, - String documentId, - List userDefinedTags) throws TxException { - IndexResumeRequest request = new IndexResumeRequest(); - request.ResumeData = resume; - request.UserDefinedTags = userDefinedTags; - - RequestBody body = createJsonBody(request); - Request apiRequest = new Request.Builder() - .url(_endpoints.resume(indexId, documentId)) - .post(body) - .build(); - - HttpResponse response = executeRequest(apiRequest, IndexDocumentResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - /** - * Add a job to an existing index - * @param job A job generated by the Job Parser - * @param indexId The index the document should be added into (case-insensitive). - * @param documentId - * The ID to assign to the new document. This is restricted to alphanumeric - * with dashes and underscores. All values will be converted to lower-case. - * @param userDefinedTags The user-defined tags that the resume should have, or {@code null} - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public IndexDocumentResponse indexDocument( - ParsedJob job, - String indexId, - String documentId, - List userDefinedTags) throws TxException { - IndexJobRequest request = new IndexJobRequest(); - request.JobData = job; - request.UserDefinedTags = userDefinedTags; - - RequestBody body = createJsonBody(request); - Request apiRequest = new Request.Builder() - .url(_endpoints.job(indexId, documentId)) - .post(body) - .build(); - - HttpResponse response = executeRequest(apiRequest, IndexDocumentResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - /** - * Add several resumes to an existing index - * @param resumes The resumes generated by the Resume Parser paired with their DocumentIds - * @param indexId The index the documents should be added into (case-insensitive). - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public IndexMultipleDocumentsResponse indexMultipleResumes(List resumes, String indexId) throws TxException { - IndexMultipleResumesRequest request = new IndexMultipleResumesRequest(); - request.Resumes = resumes; - - RequestBody body = createJsonBody(request); - Request apiRequest = new Request.Builder() - .url(_endpoints.multipleResumes(indexId)) - .post(body) - .build(); - - HttpResponse response = executeRequest(apiRequest, IndexMultipleDocumentsResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - /** - * Add several jobs to an existing index - * @param jobs The jobs generated by the Job Parser paired with their DocumentIds - * @param indexId The index the documents should be added into (case-insensitive). - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public IndexMultipleDocumentsResponse indexMultipleJobs(List jobs, String indexId) throws TxException { - IndexMultipleJobsRequest request = new IndexMultipleJobsRequest(); - request.Jobs = jobs; - - RequestBody body = createJsonBody(request); - Request apiRequest = new Request.Builder() - .url(_endpoints.multipleJobs(indexId)) - .post(body) - .build(); - - HttpResponse response = executeRequest(apiRequest, IndexMultipleDocumentsResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - /** - * Delete an existing document from an index - * @param indexId The index containing the document - * @param documentId The ID of the document to delete - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public DeleteDocumentResponse deleteDocument(String indexId, String documentId) throws TxException { - Request apiRequest = new Request.Builder() - .url(_endpoints.document(indexId, documentId)) - .delete() - .build(); - - HttpResponse response = executeRequest(apiRequest, DeleteDocumentResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - /** - * Delete a group of existing documents from an index - * @param indexId The index containing the documents - * @param documentIds The IDs of the documents to delete - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public DeleteMultipleDocumentsResponse deleteMultipleDocuments(String indexId, List documentIds) throws TxException { - DeleteMultipleDocumentsRequest request = new DeleteMultipleDocumentsRequest(); - request.DocumentIds = documentIds; - RequestBody requestBody = createJsonBody(request); - Request apiRequest = new Request.Builder() - .url(_endpoints.multipleDocuments(indexId)) - .delete(requestBody) - .build(); - - HttpResponse response = executeRequest(apiRequest, DeleteMultipleDocumentsResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - /** - * Retrieve an existing resume from an index - * @param indexId The index containing the resume - * @param documentId The ID of the resume to retrieve - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public GetResumeResponse getResume(String indexId, String documentId) throws TxException { - Request apiRequest = new Request.Builder() - .url(_endpoints.resume(indexId, documentId)) - .build(); - - HttpResponse response = executeRequest(apiRequest, GetResumeResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - /** - * Retrieve an existing job from an index - * @param indexId The index containing the job - * @param documentId The ID of the job to retrieve - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public GetJobResponse getJob(String indexId, String documentId) throws TxException { - Request apiRequest = new Request.Builder() - .url(_endpoints.job(indexId, documentId)) - .build(); - - HttpResponse response = executeRequest(apiRequest, GetJobResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - /** - * Updates the user-defined tags for a resume - * @param indexId The index containing the resume - * @param documentId The ID of the resume to update - * @param userDefinedTags The user-defined tags to add/delete/etc - * @param method Which method to use for the specified user-defined tags - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public UpdateUserDefinedTagsResponse updateResumeUserDefinedTags( - String indexId, - String documentId, - List userDefinedTags, - UserDefinedTagsMethod method) throws TxException { - UpdateUserDefinedTagsRequest request = new UpdateUserDefinedTagsRequest(); - request.UserDefinedTags = userDefinedTags; - request.Method = method; - - RequestBody body = createJsonBody(request); - Request apiRequest = new Request.Builder() - .url(_endpoints.resume(indexId, documentId)) - .patch(body) - .build(); - - HttpResponse response = executeRequest(apiRequest, UpdateUserDefinedTagsResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - /** - * Updates the user-defined tags for a job - * @param indexId The index containing the job - * @param documentId The ID of the job to update - * @param userDefinedTags The user-defined tags to add/delete/etc - * @param method Which method to use for the specified user-defined tags - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public UpdateUserDefinedTagsResponse updateJobUserDefinedTags( - String indexId, - String documentId, - List userDefinedTags, - UserDefinedTagsMethod method) throws TxException { - UpdateUserDefinedTagsRequest request = new UpdateUserDefinedTagsRequest(); - request.UserDefinedTags = userDefinedTags; - request.Method = method; - - RequestBody body = createJsonBody(request); - Request apiRequest = new Request.Builder() - .url(_endpoints.job(indexId, documentId)) - .patch(body) - .build(); - - HttpResponse response = executeRequest(apiRequest, UpdateUserDefinedTagsResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - /** - * Find matches for a non-indexed resume. - * @param resume The resume (generated by the Resume Parser) to use as the source for a match query - * @param indexesToQuery The indexes to find results in. These must all be of the same type (resumes or jobs) - * @param preferredWeights - * The preferred category weights for scoring the results. If {@code null}, - * The best values will be determined based on the source resume - * @param filters Any filters to apply prior to the match (a result must satisfy all the filters), or {@code null} - * @param settings The settings for this match request. Use {@code null} for defaults. - * @param numResults The number of results to show. Use {@code 0} for the default. - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public MatchResponse match( - ParsedResume resume, - List indexesToQuery, - CategoryWeights preferredWeights, - FilterCriteria filters, - SearchMatchSettings settings, - int numResults) throws TxException { - - MatchResumeRequest request = createRequest(resume, indexesToQuery, preferredWeights, filters, settings, numResults); - RequestBody body = createJsonBody(request); - Request apiRequest = new Request.Builder() - .url(_endpoints.matchResume(false)) - .post(body) - .build(); - - HttpResponse response = executeRequest(apiRequest, MatchResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - MatchResumeRequest createRequest( - ParsedResume resume, - List indexesToQuery, - CategoryWeights preferredWeights, - FilterCriteria filters, - SearchMatchSettings settings, - int numResults) { - MatchResumeRequest request = new MatchResumeRequest(); - request.ResumeData = resume; - request.IndexIdsToSearchInto = indexesToQuery; - request.PreferredCategoryWeights = preferredWeights; - request.FilterCriteria = filters; - request.Settings = settings; - request.Take = numResults; - return request; - } - - /** - * Find matches for a non-indexed job. - * @param job The job (generated by the Job Parser) to use as the source for a match query - * @param indexesToQuery The indexes to find results in. These must all be of the same type (resumes or jobs) - * @param preferredWeights - * The preferred category weights for scoring the results. If {@code null}, - * The best values will be determined based on the source job - * @param filters Any filters to apply prior to the match (a result must satisfy all the filters), or {@code null} - * @param settings The settings for this match request. Use {@code null} for defaults. - * @param numResults The number of results to show. Use {@code 0} for the default. - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public MatchResponse match( - ParsedJob job, - List indexesToQuery, - CategoryWeights preferredWeights, - FilterCriteria filters, - SearchMatchSettings settings, - int numResults) throws TxException { - - MatchJobRequest request = createRequest(job, indexesToQuery, preferredWeights, filters, settings, numResults); - RequestBody body = createJsonBody(request); - Request apiRequest = new Request.Builder() - .url(_endpoints.matchJob(false)) - .post(body) - .build(); - - HttpResponse response = executeRequest(apiRequest, MatchResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - MatchJobRequest createRequest( - ParsedJob job, - List indexesToQuery, - CategoryWeights preferredWeights, - FilterCriteria filters, - SearchMatchSettings settings, - int numResults) { - MatchJobRequest request = new MatchJobRequest(); - request.JobData = job; - request.IndexIdsToSearchInto = indexesToQuery; - request.PreferredCategoryWeights = preferredWeights; - request.FilterCriteria = filters; - request.Settings = settings; - request.Take = numResults; - return request; - } - - /** - * Find matches for a resume or job that is already indexed - * @param indexId The index containing the document you want to match - * @param documentId The ID of the document to match - * @param indexesToQuery The indexes to find results in. These must all be of the same type (resumes or jobs) - * @param preferredWeights - * The preferred category weights for scoring the results. If {@code null}, - * The best values will be determined based on the source resume/job - * @param filters Any filters to apply prior to the match (a result must satisfy all the filters), or {@code null} - * @param settings The settings for this match request. Use {@code null} for defaults. - * @param numResults The number of results to show. Use {@code 0} for the default. - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public MatchResponse match( - String indexId, - String documentId, - List indexesToQuery, - CategoryWeights preferredWeights, - FilterCriteria filters, - SearchMatchSettings settings, - int numResults) throws TxException { - - MatchByDocumentIdOptions request = createRequest(indexesToQuery, preferredWeights, filters, settings, numResults); - RequestBody body = createJsonBody(request); - Request apiRequest = new Request.Builder() - .url(_endpoints.matchDocId(indexId, documentId, false)) - .post(body) - .build(); - - HttpResponse response = executeRequest(apiRequest, MatchResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - MatchByDocumentIdOptions createRequest( - List indexesToQuery, - CategoryWeights preferredWeights, - FilterCriteria filters, - SearchMatchSettings settings, - int numResults) { - MatchByDocumentIdOptions request = new MatchByDocumentIdOptions(); - request.IndexIdsToSearchInto = indexesToQuery; - request.PreferredCategoryWeights = preferredWeights; - request.FilterCriteria = filters; - request.Settings = settings; - request.Take = numResults; - return request; - } - - GenerateUIResponse uiMatch(String indexId, String documentId, UIMatchByDocumentIdOptions options) throws TxException { - RequestBody body = createJsonBody(options); - Request apiRequest = new Request.Builder() - .url(_endpoints.matchDocId(indexId, documentId, true)) - .post(body) - .build(); - - GenerateUIResponse response = executeUIRequest(apiRequest, getBodyIfDebug(apiRequest)); - return response; - } - - GenerateUIResponse uiMatch(UIMatchResumeRequest request) throws TxException { - RequestBody body = createJsonBody(request); - Request apiRequest = new Request.Builder() - .url(_endpoints.matchResume(true)) - .post(body) - .build(); - - GenerateUIResponse response = executeUIRequest(apiRequest, getBodyIfDebug(apiRequest)); - return response; - } - - GenerateUIResponse uiMatch(UIMatchJobRequest request) throws TxException { - RequestBody body = createJsonBody(request); - Request apiRequest = new Request.Builder() - .url(_endpoints.matchJob(true)) - .post(body) - .build(); - - GenerateUIResponse response = executeUIRequest(apiRequest, getBodyIfDebug(apiRequest)); - return response; - } - - - /** - * Search for resumes or jobs that meet specific criteria - * @param indexesToQuery The indexes to find results in. These must all be of the same type (resumes or jobs) - * @param query The search query. A result must satisfy all of these criteria - * @param settings The settings for this search request. Use {@code null} for defaults. - * @param pagination Pagination settings. Use {@code null} for defaults. - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public SearchResponse search( - List indexesToQuery, - FilterCriteria query, - SearchMatchSettings settings, - PaginationSettings pagination) throws TxException { - SearchRequest request = createRequest(indexesToQuery, query, settings, pagination); - RequestBody body = createJsonBody(request); - Request apiRequest = new Request.Builder() - .url(_endpoints.search(false)) - .post(body) - .build(); - - HttpResponse response = executeRequest(apiRequest, SearchResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - SearchRequest createRequest(List indexesToQuery, FilterCriteria query, SearchMatchSettings settings, PaginationSettings pagination) { - SearchRequest request = new SearchRequest(); - request.IndexIdsToSearchInto = indexesToQuery; - request.FilterCriteria = query; - request.Settings = settings; - request.PaginationSettings = pagination; - return request; - } - - GenerateUIResponse uiSearch(UISearchRequest request) throws TxException { - RequestBody body = createJsonBody(request); - Request apiRequest = new Request.Builder() - .url(_endpoints.search(true)) - .post(body) - .build(); - - GenerateUIResponse response = executeUIRequest(apiRequest, getBodyIfDebug(apiRequest)); - return response; - } - - - /** - * Score one or more target documents against a source resume - * @param Either {@link ParsedResumeWithId} or {@link ParsedJobWithId} - * @param sourceResume The source resume - * @param targetDocuments The target resumes/jobs - * @param preferredWeights - * The preferred category weights for scoring the results. If {@code null}, - * The best values will be determined based on the source resume. - * @param settings The settings for this search request. Use {@code null} for defaults. - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public BimetricScoreResponse bimetricScore( - ParsedResumeWithId sourceResume, - List targetDocuments, - CategoryWeights preferredWeights, - SearchMatchSettings settings) throws TxException { - BimetricScoreResumeRequest request = createRequest(sourceResume, targetDocuments, preferredWeights, settings); - RequestBody body = createJsonBody(request); - Request apiRequest = new Request.Builder() - .url(_endpoints.bimetricScoreResume(false)) - .post(body) - .build(); - - HttpResponse response = executeRequest(apiRequest, BimetricScoreResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - @SuppressWarnings("unchecked") //these actually are checked, compiler just can't tell - BimetricScoreResumeRequest createRequest( - ParsedResumeWithId sourceResume, - List targetDocuments, - CategoryWeights preferredWeights, - SearchMatchSettings settings) { - BimetricScoreResumeRequest request = new BimetricScoreResumeRequest(); - request.PreferredCategoryWeights = preferredWeights; - request.Settings = settings; - request.SourceResume = sourceResume; - - if (targetDocuments.size() > 0) { - //we must only cast/set either TargetResumes or TargetJobs here since - // Java has type erasure and both casts would succeed and we'd send both params to the API - if (targetDocuments.get(0) instanceof ParsedResumeWithId) { - request.TargetResumes = (List)targetDocuments; - } - else { - request.TargetJobs = (List)targetDocuments; - } - } - - return request; - } - - /** - * Score one or more target documents against a source job - * @param Either {@link ParsedResumeWithId} or {@link ParsedJobWithId} - * @param sourceJob The source job - * @param targetDocuments The target resumes/jobs - * @param preferredWeights - * The preferred category weights for scoring the results. If {@code null}, - * The best values will be determined based on the source job. - * @param settings The settings for this search request. Use {@code null} for defaults. - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public BimetricScoreResponse bimetricScore( - ParsedJobWithId sourceJob, - List targetDocuments, - CategoryWeights preferredWeights, - SearchMatchSettings settings) throws TxException { - BimetricScoreJobRequest request = createRequest(sourceJob, targetDocuments, preferredWeights, settings); - RequestBody body = createJsonBody(request); - Request apiRequest = new Request.Builder() - .url(_endpoints.bimetricScoreJob(false)) - .post(body) - .build(); - - HttpResponse response = executeRequest(apiRequest, BimetricScoreResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - @SuppressWarnings("unchecked") //these actually are checked, compiler just can't tell - BimetricScoreJobRequest createRequest( - ParsedJobWithId sourceJob, - List targetDocuments, - CategoryWeights preferredWeights, - SearchMatchSettings settings) { - BimetricScoreJobRequest request = new BimetricScoreJobRequest(); - request.PreferredCategoryWeights = preferredWeights; - request.Settings = settings; - request.SourceJob = sourceJob; - - if (targetDocuments.size() > 0) { - //we must only cast/set either TargetResumes or TargetJobs here since - // Java has type erasure and both casts would succeed and we'd send both params to the API - if (targetDocuments.get(0) instanceof ParsedResumeWithId) { - request.TargetResumes = (List)targetDocuments; - } - else { - request.TargetJobs = (List)targetDocuments; - } - } - - return request; - } - - GenerateUIResponse uiBimetricScore(UIBimetricScoreResumeRequest request) throws TxException { - RequestBody body = createJsonBody(request); - Request apiRequest = new Request.Builder() - .url(_endpoints.bimetricScoreResume(true)) - .post(body) - .build(); - - GenerateUIResponse response = executeUIRequest(apiRequest, getBodyIfDebug(apiRequest)); - return response; - } - - GenerateUIResponse uiBimetricScore(UIBimetricScoreJobRequest request) throws TxException { - RequestBody body = createJsonBody(request); - Request apiRequest = new Request.Builder() - .url(_endpoints.bimetricScoreJob(true)) - .post(body) - .build(); - GenerateUIResponse response = executeUIRequest(apiRequest, getBodyIfDebug(apiRequest)); - return response; - } - - private GeocodeResumeResponse internalGeocode(ParsedResume resume, GeocodeCredentials geocodeCredentials, Address address) throws TxException { - GeocodeResumeRequest request = new GeocodeResumeRequest(); - request.ResumeData = resume; - request.Provider = geocodeCredentials != null ? geocodeCredentials.Provider : GeocodeProvider.Google; - request.ProviderKey = geocodeCredentials != null ? geocodeCredentials.ProviderKey : null; - request.PostalAddress = address; - - RequestBody body = createJsonBody(request); - Request apiRequest = new Request.Builder() - .url(_endpoints.geocodeResume()) - .post(body) - .build(); - - HttpResponse response = executeRequest(apiRequest, GeocodeResumeResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - private GeocodeJobResponse internalGeocode(ParsedJob job, GeocodeCredentials geocodeCredentials, Address address) throws TxException { - GeocodeJobRequest request = new GeocodeJobRequest(); - request.JobData = job; - request.Provider = geocodeCredentials != null ? geocodeCredentials.Provider : GeocodeProvider.Google; - request.ProviderKey = geocodeCredentials != null ? geocodeCredentials.ProviderKey : null; - request.PostalAddress = address; - - RequestBody body = createJsonBody(request); - Request apiRequest = new Request.Builder() - .url(_endpoints.geocodeJob()) - .post(body) - .build(); - - HttpResponse response = executeRequest(apiRequest, GeocodeJobResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - /** - * Uses the address in the resume (if present) to look up geocoordinates and add them into the ParsedResume object. - * These coordinates are used by the AI Searching/Matching engine. - * @param resume The resume to insert the geocoordinates (from the address) into - * @param geocodeCredentials - The credentials you want to use for geocoding (use {@code null} for built-in credentials) - * @return The API response body - * @throws TxException Thrown when an API error occurred - */ - public GeocodeResumeResponse geocode(ParsedResume resume, GeocodeCredentials geocodeCredentials) throws TxException { - return internalGeocode(resume, geocodeCredentials, null); - } - - /** - * Use this if you would like to provide an address for geocoding instead of using the one in the parsed - * resume. The address included in the parsed resume (if present) will not be modified. - * @param resume The resume to insert the geocoordinates (from the address) into - * @param address The address to use to retrieve geocoordinates - * @param geocodeCredentials - The credentials you want to use for geocoding (use {@code null} for built-in credentials) - * @return The API response body - * @throws TxException Thrown when an API error occurred - */ - public GeocodeResumeResponse geocode(ParsedResume resume, Address address, GeocodeCredentials geocodeCredentials) throws TxException { - return internalGeocode(resume, geocodeCredentials, address); - } - - /** - * Uses the address in the job (if present) to look up geocoordinates and add them into the ParsedJob object. - * These coordinates are used by the AI Searching/Matching engine. - * @param job The job to insert the geocoordinates (from the address) into - * @param geocodeCredentials - The credentials you want to use for geocoding (use {@code null} for built-in credentials) - * @return The API response body - * @throws TxException Thrown when an API error occurred - */ - public GeocodeJobResponse geocode(ParsedJob job, GeocodeCredentials geocodeCredentials) throws TxException { - return internalGeocode(job, geocodeCredentials, null); - } - - /** - * Use this if you would like to provide an address for geocoding instead of using the one in the parsed - * job. The address included in the parsed job (if present) will not be modified. - * @param job The job to insert the geocoordinates (from the address) into - * @param address The address to use to retrieve geocoordinates - * @param geocodeCredentials - The credentials you want to use for geocoding (use {@code null} for built-in credentials) - * @return The API response body - * @throws TxException Thrown when an API error occurred - */ - public GeocodeJobResponse geocode(ParsedJob job, Address address, GeocodeCredentials geocodeCredentials) throws TxException { - return internalGeocode(job, geocodeCredentials, address); - } - - private GeocodeAndIndexResumeResponse internalGeocodeAndIndex( - ParsedResume resume, - GeocodeCredentials geocodeCredentials, - IndexSingleDocumentInfo indexingOptions, - boolean indexIfGeocodeFails, - Address address, - GeoCoordinates coordinates) throws TxException { - GeocodeOptionsBase options = new GeocodeOptionsBase(); - options.Provider = geocodeCredentials != null ? geocodeCredentials.Provider : GeocodeProvider.Google; - options.ProviderKey = geocodeCredentials != null ? geocodeCredentials.ProviderKey : null; - options.PostalAddress = address; - options.GeoCoordinates = coordinates; - - GeocodeAndIndexResumeRequest request = new GeocodeAndIndexResumeRequest(); - request.ResumeData = resume; - request.GeocodeOptions = options; - request.IndexingOptions = indexingOptions; - request.IndexIfGeocodeFails = indexIfGeocodeFails; - - RequestBody body = createJsonBody(request); - Request apiRequest = new Request.Builder() - .url(_endpoints.geocodeAndIndexResume()) - .post(body) - .build(); - - HttpResponse response = executeRequest(apiRequest, GeocodeAndIndexResumeResponse.class, getBodyIfDebug(apiRequest)); - GeocodeAndIndexResumeResponseValue responseVal = response.getData().Value; - - if (!indexIfGeocodeFails && responseVal.GeocodeResponse != null && !responseVal.GeocodeResponse.isSuccess()) { - throw new TxException(getBodyIfDebug(apiRequest), response.getResponse(), responseVal.GeocodeResponse, response.getData().getInfo().TransactionId); - } - - if (responseVal.IndexingResponse != null && !responseVal.IndexingResponse.isSuccess()) { - throw new TxException(getBodyIfDebug(apiRequest), response.getResponse(), responseVal.IndexingResponse, response.getData().getInfo().TransactionId); - } - - return response.getData(); - } - - private GeocodeAndIndexJobResponse internalGeocodeAndIndex( - ParsedJob job, - GeocodeCredentials geocodeCredentials, - IndexSingleDocumentInfo indexingOptions, - boolean indexIfGeocodeFails, - Address address, - GeoCoordinates coordinates) throws TxException { - GeocodeOptionsBase options = new GeocodeOptionsBase(); - options.Provider = geocodeCredentials != null ? geocodeCredentials.Provider : GeocodeProvider.Google; - options.ProviderKey = geocodeCredentials != null ? geocodeCredentials.ProviderKey : null; - options.PostalAddress = address; - options.GeoCoordinates = coordinates; - - GeocodeAndIndexJobRequest request = new GeocodeAndIndexJobRequest(); - request.JobData = job; - request.GeocodeOptions = options; - request.IndexingOptions = indexingOptions; - request.IndexIfGeocodeFails = indexIfGeocodeFails; - - RequestBody body = createJsonBody(request); - Request apiRequest = new Request.Builder() - .url(_endpoints.geocodeAndIndexJob()) - .post(body) - .build(); - - HttpResponse response = executeRequest(apiRequest, GeocodeAndIndexJobResponse.class, getBodyIfDebug(apiRequest)); - GeocodeAndIndexJobResponseValue responseVal = response.getData().Value; - - if (!indexIfGeocodeFails && responseVal.GeocodeResponse != null && !responseVal.GeocodeResponse.isSuccess()) { - throw new TxException(getBodyIfDebug(apiRequest), response.getResponse(), responseVal.GeocodeResponse, response.getData().getInfo().TransactionId); - } - - if (responseVal.IndexingResponse != null && !responseVal.IndexingResponse.isSuccess()) { - throw new TxException(getBodyIfDebug(apiRequest), response.getResponse(), responseVal.IndexingResponse, response.getData().getInfo().TransactionId); - } - - return response.getData(); - } - - /** - * Uses the address in the resume (if present) to look up geocoordinates and add them into the ParsedResume object. - * These coordinates are used by the AI Searching/Matching engine. - * @param resume The resume to geocode - * @param indexingOptions What index/document id to use to index the document after geocoding - * @param indexIfGeocodeFails Indicates whether or not the document should still be added to the index if the geocode request fails. - * @param geocodeCredentials - The credentials you want to use for geocoding (use {@code null} for built-in credentials) - * @return The API response body - * @throws TxException Thrown when an API error occurred - */ - public GeocodeAndIndexResumeResponse geocodeAndIndex( - ParsedResume resume, - IndexSingleDocumentInfo indexingOptions, - boolean indexIfGeocodeFails, - GeocodeCredentials geocodeCredentials) throws TxException { - return internalGeocodeAndIndex(resume, geocodeCredentials, indexingOptions, indexIfGeocodeFails, null, null); - } - - /** - * Use this if you would like to provide an address for geocoding instead of using the one in the parsed - * resume. The address included in the parsed resume (if present) will not be modified. - * @param resume The resume to insert the geocoordinates (from the address) into - * @param indexingOptions What index/document id to use to index the document after geocoding - * @param address The address to use to retrieve geocoordinates - * @param indexIfGeocodeFails Indicates whether or not the document should still be added to the index if the geocode request fails. - * @param geocodeCredentials - The credentials you want to use for geocoding (use {@code null} for built-in credentials) - * @return The API response body - * @throws TxException Thrown when an API error occurred - */ - public GeocodeAndIndexResumeResponse geocodeAndIndex( - ParsedResume resume, - IndexSingleDocumentInfo indexingOptions, - Address address, - boolean indexIfGeocodeFails, - GeocodeCredentials geocodeCredentials) throws TxException { - return internalGeocodeAndIndex(resume, geocodeCredentials, indexingOptions, indexIfGeocodeFails, address, null); - } - - /** - * Use this if you already have latitude/longitude coordinates and simply wish to add them to your parsed resume. - * The coordinates will be inserted into your parsed resume, and the address included in the - * parsed resume (if present) will not be modified. - * @param resume The resume to insert the geocoordinates into - * @param indexingOptions What index/document id to use to index the document after geocoding - * @param coordinates The geocoordinates to use - * @param indexIfGeocodeFails Indicates whether or not the document should still be added to the index if the geocode request fails. - * @param geocodeCredentials - The credentials you want to use for geocoding (use {@code null} for built-in credentials) - * @return The API response body - * @throws TxException Thrown when an API error occurred - */ - public GeocodeAndIndexResumeResponse geocodeAndIndex( - ParsedResume resume, - IndexSingleDocumentInfo indexingOptions, - GeoCoordinates coordinates, - boolean indexIfGeocodeFails, - GeocodeCredentials geocodeCredentials) throws TxException { - return internalGeocodeAndIndex(resume, geocodeCredentials, indexingOptions, indexIfGeocodeFails, null, coordinates); - } - - /** - * Uses the address in the job (if present) to look up geocoordinates and add them into the ParsedJob object. - * These coordinates are used by the AI Searching/Matching engine. - * @param job The job to geocode - * @param indexingOptions What index/document id to use to index the document after geocoding - * @param indexIfGeocodeFails Indicates whether or not the document should still be added to the index if the geocode request fails. - * @param geocodeCredentials - The credentials you want to use for geocoding (use {@code null} for built-in credentials) - * @return The API response body - * @throws TxException Thrown when an API error occurred - */ - public GeocodeAndIndexJobResponse geocodeAndIndex( - ParsedJob job, - IndexSingleDocumentInfo indexingOptions, - boolean indexIfGeocodeFails, - GeocodeCredentials geocodeCredentials) throws TxException { - return internalGeocodeAndIndex(job, geocodeCredentials, indexingOptions, indexIfGeocodeFails, null, null); - } - - /** - * Use this if you would like to provide an address for geocoding instead of using the one in the parsed - * rjobesume. The address included in the parsed job (if present) will not be modified. - * @param job The job to insert the geocoordinates (from the address) into - * @param indexingOptions What index/document id to use to index the document after geocoding - * @param address The address to use to retrieve geocoordinates - * @param indexIfGeocodeFails Indicates whether or not the document should still be added to the index if the geocode request fails. - * @param geocodeCredentials - The credentials you want to use for geocoding (use {@code null} for built-in credentials) - * @return The API response body - * @throws TxException Thrown when an API error occurred - */ - public GeocodeAndIndexJobResponse geocodeAndIndex( - ParsedJob job, - IndexSingleDocumentInfo indexingOptions, - Address address, - boolean indexIfGeocodeFails, - GeocodeCredentials geocodeCredentials) throws TxException { - return internalGeocodeAndIndex(job, geocodeCredentials, indexingOptions, indexIfGeocodeFails, address, null); - } - - /** - * Use this if you already have latitude/longitude coordinates and simply wish to add them to your parsed job. - * The coordinates will be inserted into your parsed job, and the address included in the - * parsed job (if present) will not be modified. - * @param job The job to insert the geocoordinates into - * @param indexingOptions What index/document id to use to index the document after geocoding - * @param coordinates The geocoordinates to use - * @param indexIfGeocodeFails Indicates whether or not the document should still be added to the index if the geocode request fails. - * @param geocodeCredentials - The credentials you want to use for geocoding (use {@code null} for built-in credentials) - * @return The API response body - * @throws TxException Thrown when an API error occurred - */ - public GeocodeAndIndexJobResponse geocodeAndIndex( - ParsedJob job, - IndexSingleDocumentInfo indexingOptions, - GeoCoordinates coordinates, - boolean indexIfGeocodeFails, - GeocodeCredentials geocodeCredentials) throws TxException { - return internalGeocodeAndIndex(job, geocodeCredentials, indexingOptions, indexIfGeocodeFails, null, coordinates); - } - - /** - * Access methods for generating Matching UI sessions. For example: {@code txClient.UI(options).search(...)} - * @param uiOptions - * Options/settings for the Matching UI. - *
NOTE: if you do not provide a {@link UIOptions#Username} (in {@link MatchUISettings#UIOptions}), - * the user will be prompted to login as soon as the Matching UI session is loaded - * @return The client for making Matching UI API calls - */ - public TxUIClient ui(MatchUISettings uiOptions) { - return new TxUIClient(uiOptions, this); - } - - /** - * Get all skills in the taxonomy with associated IDs and descriptions in all supported languages. - * @param format The format of the returned taxonomy.
NOTE: if you set this to {@link TaxonomyFormat#csv}, only the {@link GetSkillsTaxonomyResponseValue#CsvOutput} will be populated. - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public GetSkillsTaxonomyResponse getSkillsTaxonomy(TaxonomyFormat format) throws TxException { - Request apiRequest = new Request.Builder() - .url(_endpoints.desSkillsGetTaxonomy(format)) - .build(); - - HttpResponse response = executeRequest(apiRequest, GetSkillsTaxonomyResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - /** - * Get all skills in the taxonomy with associated IDs and descriptions in all supported languages. - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public GetSkillsTaxonomyResponse getSkillsTaxonomy() throws TxException { - return getSkillsTaxonomy(TaxonomyFormat.json); - } - - /** - * Get metadata about the skills taxonomy/service. - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public GetMetadataResponse getSkillsTaxonomyMetadata() throws TxException { - Request apiRequest = new Request.Builder() - .url(_endpoints.desSkillsGetMetadata()) - .build(); - - HttpResponse response = executeRequest(apiRequest, GetMetadataResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - /** - * Returns normalized skills that begin with a given prefix, based on the chosen language(s). Each skill is associated with multiple descriptions. If any of the descriptions are a good completion of the given prefix, the skill is included in the results. - * @param prefix The skill prefix to be completed. Must contain at least 1 character. - * @param languages The language(s) used to search for matching skills (the language of the provided Prefix). A maximum of 5 languages can be provided. Must be one of the supported ISO codes.
Default is 'en' only. - * @param outputLanguage The language to ouput the found skill descriptions in (default is 'en'). Must be one of the supported ISO codes. - * @param types If specified, only these types of skills will be returned. The following values are acceptable: Professional, IT, Language, Soft, All. - * @param limit The maximum number of returned skills. The default is 10 and the maximum is 100. - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public AutoCompleteSkillsResponse autocompleteSkill(String prefix, List languages, String outputLanguage, List types, int limit) throws TxException { - SkillsAutoCompleteRequest request = new SkillsAutoCompleteRequest(); - request.Prefix = prefix; - request.Limit = limit; - request.Types = types; - request.Languages = languages; - request.OutputLanguage = outputLanguage; - - RequestBody body = createJsonBody(request); - Request apiRequest = new Request.Builder() - .url(_endpoints.desSkillsAutoComplete()) - .post(body) - .build(); - - HttpResponse response = executeRequest(apiRequest, AutoCompleteSkillsResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - /** - * Returns normalized skills that begin with a given prefix, based on the chosen language(s). Each skill is associated with multiple descriptions. If any of the descriptions are a good completion of the given prefix, the skill is included in the results. - * @param prefix The skill prefix to be completed. Must contain at least 1 character. - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public AutoCompleteSkillsResponse autocompleteSkill(String prefix) throws TxException { - return autocompleteSkill(prefix,null,null,null,10); - } - - /** - * Get the details associated with given skills in the taxonomy. - * @param skillIds The IDs of the skills to get details about. A maximum of 100 IDs can be requested. - * @param outputLanguage The language to use for the output skill descriptions. If not provided, defaults to en. If specified, must be one of the supported ISO codes.
Default is 'en'. - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public LookupSkillCodesResponse lookupSkills(List skillIds, String outputLanguage) throws TxException { - LookupSkillsRequest request = new LookupSkillsRequest(); - request.SkillIds = skillIds; - request.OutputLanguage = outputLanguage; - - RequestBody body = createJsonBody(request); - Request apiRequest = new Request.Builder() - .url(_endpoints.desSkillsLookup()) - .post(body) - .build(); - - HttpResponse response = executeRequest(apiRequest, LookupSkillCodesResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - /** - * Get the details associated with given skills in the taxonomy. - * @param skillIds The IDs of the skills to get details about. A maximum of 100 IDs can be requested. - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public LookupSkillCodesResponse lookupSkills(List skillIds) throws TxException { - return lookupSkills(skillIds,null); - } - - /** - * Normalize the given skills to the most closely-related skills in the taxonomy. - * @param skills The list of skills to normalize (up to 50 skills, each skill may not exceed 100 characters). - * @param language The language of the given skills. Must be one of the supported ISO codes.
Default is 'en'. - * @param outputLanguage The language to use for the output skill descriptions. Must be one of the supported ISO codes.
Defaults to whatever is used for the 'language' parameter. - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public NormalizeSkillsResponse normalizeSkills(List skills, String language, String outputLanguage) throws TxException { - NormalizeSkillsRequest request = new NormalizeSkillsRequest(); - request.Skills = skills; - request.Language = language; - request.OutputLanguage = outputLanguage; - - RequestBody body = createJsonBody(request); - Request apiRequest = new Request.Builder() - .url(_endpoints.desSkillsNormalize()) - .post(body) - .build(); - - HttpResponse response = executeRequest(apiRequest, NormalizeSkillsResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - /** - * Normalize the given skills to the most closely-related skills in the taxonomy. - * @param skills The list of skills to normalize (up to 50 skills, each skill may not exceed 100 characters). - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public NormalizeSkillsResponse normalizeSkills(List skills) throws TxException { - return normalizeSkills(skills,null,null); - } - - /** - * Extracts known skills from the given text. - * @param text The text to extract skills from. There is a 24,000 character limit. - * @param language The language of the input text. Must be one of the supported ISO codes.
Default is 'en'. - * @param outputLanguage The language to use for the output skill descriptions. If not provided, defaults to the input language. Must be one of the supported ISO codes. - * @param threshold A value from [0 - 1] for the minimum confidence threshold for extracted skills. Lower values will return more skills, but also increase the likelihood of ambiguity-related errors. The recommended and default value is 0.5. - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public ExtractSkillsResponse extractSkills(String text, String language, String outputLanguage, float threshold) throws TxException { - ExtractSkillsRequest request = new ExtractSkillsRequest(); - request.Text = text; - request.Language = language; - request.OutputLanguage = outputLanguage; - request.Threshold = threshold; - - RequestBody body = createJsonBody(request); - Request apiRequest = new Request.Builder() - .url(_endpoints.desSkillsExtract()) - .post(body) - .build(); - - HttpResponse response = executeRequest(apiRequest, ExtractSkillsResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - /** - * Extracts known skills from the given text. - * @param text The text to extract skills from. There is a 24,000 character limit. - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public ExtractSkillsResponse extractSkills(String text) throws TxException { - return extractSkills(text,null,null,0.5f); - } - - /** - * Get all skills in the taxonomy with associated IDs and descriptions in all supported languages. - * @param format The format of the returned taxonomy.
NOTE: if you set this to {@link TaxonomyFormat#csv}, only the {@link GetSkillsTaxonomyResponseValue#CsvOutput} will be populated. - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public GetSkillsTaxonomyResponse getSkillsTaxonomyV2(TaxonomyFormat format) throws TxException { - Request apiRequest = new Request.Builder() - .url(_endpoints.desSkillsGetTaxonomyV2(format)) - .build(); - - HttpResponse response = executeRequest(apiRequest, GetSkillsTaxonomyResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - /** - * Get all skills in the taxonomy with associated IDs and descriptions in all supported languages. - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public GetSkillsTaxonomyResponse getSkillsTaxonomyV2() throws TxException { - return getSkillsTaxonomyV2(TaxonomyFormat.json); - } - - /** - * Get metadata about the skills taxonomy/service. - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public GetMetadataResponse getSkillsTaxonomyMetadataV2() throws TxException { - Request apiRequest = new Request.Builder() - .url(_endpoints.desSkillsGetMetadataV2()) - .build(); - - HttpResponse response = executeRequest(apiRequest, GetMetadataResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - /** - * Returns normalized skills that begin with a given prefix, based on the chosen language(s). Each skill is associated with multiple descriptions. If any of the descriptions are a good completion of the given prefix, the skill is included in the results. - * @param prefix The skill prefix to be completed. Must contain at least 1 character. - * @param languages The language(s) used to search for matching skills (the language of the provided Prefix). A maximum of 5 languages can be provided. Must be one of the supported ISO codes.
Default is 'en' only. - * @param outputLanguage The language to ouput the found skill descriptions in (default is 'en'). Must be one of the supported ISO codes. - * @param types If specified, only these types of skills will be returned. The following values are acceptable: Professional, IT, Language, Soft, Certification, All. - * @param limit The maximum number of returned skills. The default is 10 and the maximum is 100. - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public AutoCompleteSkillsResponse autocompleteSkillV2(String prefix, List languages, String outputLanguage, List types, int limit) throws TxException { - SkillsAutoCompleteRequest request = new SkillsAutoCompleteRequest(); - request.Prefix = prefix; - request.Limit = limit; - request.Types = types; - request.Languages = languages; - request.OutputLanguage = outputLanguage; - - RequestBody body = createJsonBody(request); - Request apiRequest = new Request.Builder() - .url(_endpoints.desSkillsAutoCompleteV2()) - .post(body) - .build(); - - HttpResponse response = executeRequest(apiRequest, AutoCompleteSkillsResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - /** - * Returns normalized skills that begin with a given prefix, based on the chosen language(s). Each skill is associated with multiple descriptions. If any of the descriptions are a good completion of the given prefix, the skill is included in the results. - * @param prefix The skill prefix to be completed. Must contain at least 1 character. - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public AutoCompleteSkillsResponse autocompleteSkillV2(String prefix) throws TxException { - return autocompleteSkillV2(prefix,null,null,null,10); - } - - /** - * Get the details associated with given skills in the taxonomy. - * @param skillIds The IDs of the skills to get details about. A maximum of 100 IDs can be requested. - * @param outputLanguage The language to use for the output skill descriptions. If not provided, defaults to en. If specified, must be one of the supported ISO codes.
Default is 'en'. - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public LookupSkillCodesResponse lookupSkillsV2(List skillIds, String outputLanguage) throws TxException { - LookupSkillsRequest request = new LookupSkillsRequest(); - request.SkillIds = skillIds; - request.OutputLanguage = outputLanguage; - - RequestBody body = createJsonBody(request); - Request apiRequest = new Request.Builder() - .url(_endpoints.desSkillsLookupV2()) - .post(body) - .build(); - - HttpResponse response = executeRequest(apiRequest, LookupSkillCodesResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - /** - * Get the details associated with given skills in the taxonomy. - * @param skillIds The IDs of the skills to get details about. A maximum of 100 IDs can be requested. - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public LookupSkillCodesResponse lookupSkillsV2(List skillIds) throws TxException { - return lookupSkillsV2(skillIds,null); - } - - /** - * Normalize the given skills to the most closely-related skills in the taxonomy. - * @param skills The list of skills to normalize (up to 50 skills, each skill may not exceed 100 characters). - * @param language The language of the given skills. Must be one of the supported ISO codes.
Default is 'en'. - * @param outputLanguage The language to use for the output skill descriptions. Must be one of the supported ISO codes.
Defaults to whatever is used for the 'language' parameter. - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public NormalizeSkillsResponse normalizeSkillsV2(List skills, String language, String outputLanguage) throws TxException { - NormalizeSkillsRequest request = new NormalizeSkillsRequest(); - request.Skills = skills; - request.Language = language; - request.OutputLanguage = outputLanguage; - - RequestBody body = createJsonBody(request); - Request apiRequest = new Request.Builder() - .url(_endpoints.desSkillsNormalizeV2()) - .post(body) - .build(); - - HttpResponse response = executeRequest(apiRequest, NormalizeSkillsResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - /** - * Normalize the given skills to the most closely-related skills in the taxonomy. - * @param skills The list of skills to normalize (up to 50 skills, each skill may not exceed 100 characters). - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public NormalizeSkillsResponse normalizeSkillsV2(List skills) throws TxException { - return normalizeSkillsV2(skills,null,null); - } - - /** - * Extracts known skills from the given text. - * @param text The text to extract skills from. There is a 24,000 character limit. - * @param language The language of the input text. Must be one of the supported ISO codes.
Default is 'en'. - * @param outputLanguage The language to use for the output skill descriptions. If not provided, defaults to the input language. Must be one of the supported ISO codes. - * @param threshold A value from [0 - 1] for the minimum confidence threshold for extracted skills. Lower values will return more skills, but also increase the likelihood of ambiguity-related errors. The recommended and default value is 0.5. - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public ExtractSkillsResponse extractSkillsV2(String text, String language, String outputLanguage, float threshold) throws TxException { - ExtractSkillsRequest request = new ExtractSkillsRequest(); - request.Text = text; - request.Language = language; - request.OutputLanguage = outputLanguage; - request.Threshold = threshold; - - RequestBody body = createJsonBody(request); - Request apiRequest = new Request.Builder() - .url(_endpoints.desSkillsExtractV2()) - .post(body) - .build(); - - HttpResponse response = executeRequest(apiRequest, ExtractSkillsResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - /** - * Extracts known skills from the given text. - * @param text The text to extract skills from. There is a 24,000 character limit. - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public ExtractSkillsResponse extractSkillsV2(String text) throws TxException { - return extractSkillsV2(text,null,null,0.5f); - } - - /** - * Get all professions in the taxonomy with associated IDs and descriptions in all supported languages. - * @param language The language parameter returns the taxonomy with descriptions only in that specified language. If not specified, descriptions in all languages are returned. Must be specified as one of the supported ISO codes. - * @param format The format of the returned taxonomy.
NOTE: if you set this to {@link TaxonomyFormat#csv}, only the {@link GetProfessionsTaxonomyResponseValue#CsvOutput} will be populated. - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public GetProfessionsTaxonomyResponse getProfessionsTaxonomy(String language, TaxonomyFormat format) throws TxException { - Request apiRequest = new Request.Builder() - .url(_endpoints.desProfessionsGetTaxonomy(format,language)) - .build(); - - HttpResponse response = executeRequest(apiRequest, GetProfessionsTaxonomyResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - /** - * Get all professions in the taxonomy with associated IDs and descriptions in all supported languages. - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public GetProfessionsTaxonomyResponse getProfessionsTaxonomy() throws TxException { - return getProfessionsTaxonomy(null,TaxonomyFormat.json); - } - - /** - * Get metadata about the professions taxonomy/service. - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public GetMetadataResponse getProfessionsTaxonomyMetadata() throws TxException { - Request apiRequest = new Request.Builder() - .url(_endpoints.desProfessionsGetMetadata()) - .build(); - - HttpResponse response = executeRequest(apiRequest, GetMetadataResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - /** - * Returns normalized professions that begin with a given prefix, based on the chosen language(s). Each profession is associated with multiple descriptions. If any of the descriptions are a good completion of the given prefix, the profession is included in the results. - * @param prefix The job title prefix to be completed. Must contain at least 1 character. - * @param languages The language(s) used to search for matching professions (the language of the provided Prefix). A maximum of 5 languages can be provided. Must be one of the supported ISO codes. Default is 'en' only. - * @param outputLanguage The language to ouput the found professions in (default is 'en'). Must be one of the supported ISO codes. - * @param limit The maximum number of returned professions. The default is 10 and the maximum is 100. - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public ProfessionsAutoCompleteResponse autocompleteProfession(String prefix, List languages, String outputLanguage, int limit) throws TxException { - AutocompleteRequest request = new AutocompleteRequest(); - request.Prefix = prefix; - request.Limit = limit; - request.Languages = languages; - request.OutputLanguage = outputLanguage; - - RequestBody body = createJsonBody(request); - Request apiRequest = new Request.Builder() - .url(_endpoints.desProfessionsAutoComplete()) - .post(body) - .build(); - - HttpResponse response = executeRequest(apiRequest, ProfessionsAutoCompleteResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - /** - * Returns normalized professions that begin with a given prefix, based on the default language of english. Each profession is associated with multiple descriptions. If any of the descriptions are a good completion of the given prefix, the profession is included in the results. - * @param prefix The job title prefix to be completed. Must contain at least 1 character. - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public ProfessionsAutoCompleteResponse autocompleteProfession(String prefix) throws TxException { - List languages = new ArrayList<>(); - languages.add("en"); - return autocompleteProfession(prefix,languages,"en",10); - } - - /** - * Normalize the given job titles to the most closely-related professions in the taxonomy. - * @param jobTitles The list of job titles to normalize (up to 10 job titles, each job title may not exceed 400 characters). - * @param language The language of the input job titles. Must be one of the supported ISO codes.
Default is 'en'. - * @param outputLanguage The language to use for descriptions of the returned normalized professions. Must be one of the supported ISO codes.
Defaults to whatever is used for the 'language' parameter. - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public NormalizeProfessionsResponse normalizeProfessions(List jobTitles, String language, String outputLanguage) throws TxException { - NormalizeProfessionsRequest request = new NormalizeProfessionsRequest(); - request.JobTitles = jobTitles; - request.Language = language; - request.OutputLanguage = outputLanguage; - - RequestBody body = createJsonBody(request); - Request apiRequest = new Request.Builder() - .url(_endpoints.desProfessionsNormalize()) - .post(body) - .build(); - - HttpResponse response = executeRequest(apiRequest, NormalizeProfessionsResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - /** - * Normalize the given job titles to the most closely-related professions in the taxonomy. - * @param jobTitles The list of job titles to normalize (up to 10 job titles, each job title may not exceed 400 characters). - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public NormalizeProfessionsResponse normalizeProfessions(List jobTitles) throws TxException { - return normalizeProfessions(jobTitles,null,null); - } - - /** - * Get details for the given professions in the taxonomy. - * @param codeIds The profession code IDs to get details about from the Professions Taxonomy. - * @param outputLanguage The language to use for professions descriptions (default is en). Must be an allowed ISO code.
Default is 'en'. - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public LookupProfessionCodesResponse lookupProfessions(List codeIds, String outputLanguage) throws TxException { - LookupProfessionCodesRequest request = new LookupProfessionCodesRequest(); - request.CodeIds = codeIds; - request.OutputLanguage = outputLanguage; - - RequestBody body = createJsonBody(request); - Request apiRequest = new Request.Builder() - .url(_endpoints.desProfessionsLookup()) - .post(body) - .build(); - - HttpResponse response = executeRequest(apiRequest, LookupProfessionCodesResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - /** - * Get details for the given professions in the taxonomy. - * @param codeIds The profession code IDs to get details about from the Professions Taxonomy. - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public LookupProfessionCodesResponse lookupProfessions(List codeIds) throws TxException { - return lookupProfessions(codeIds,null); - } - - /** - * Compare two professions based on the skills associated with each. - * @param profession1 A profession code ID from the Professions Taxonomy to compare. - * @param profession2 A profession code ID from the Professions Taxonomy to compare. - * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public CompareProfessionsResponse compareProfessions(int profession1, int profession2, String outputLanguage) throws TxException { - CompareProfessionsRequest request = new CompareProfessionsRequest(); - request.ProfessionACodeId = profession1; - request.ProfessionBCodeId = profession2; - request.OutputLanguage = outputLanguage; - - RequestBody body = createJsonBody(request); - Request apiRequest = new Request.Builder() - .url(_endpoints.desOntologyCompareProfessions()) - .post(body) - .build(); - - HttpResponse response = executeRequest(apiRequest, CompareProfessionsResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - /** - * Compare a given set of skills to the skills related to a given profession. - * @param professionCodeId The profession code ID from the Professions Taxonomy to compare the skill set to. - * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code - * @param skills The skills which should be compared against the given profession. The list can contain up to 50 skills. - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public CompareSkillsToProfessionResponse compareSkillsToProfessions(int professionCodeId, String outputLanguage, List skills) throws TxException { - CompareSkillsToProfessionRequest request = new CompareSkillsToProfessionRequest(); - request.Skills = new ArrayList(); - int amountOfSkills = skills.size() > 50 ? 50 : skills.size(); - - for(int i = 0; i < amountOfSkills; i++) { - request.Skills.add(skills.get(i)); - }; - request.ProfessionCodeId = professionCodeId; - request.OutputLanguage = outputLanguage; - - RequestBody body = createJsonBody(request); - Request apiRequest = new Request.Builder() - .url(_endpoints.desOntologyCompareSkillsToProfession()) - .post(body) - .build(); - - HttpResponse response = executeRequest(apiRequest, CompareSkillsToProfessionResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - /** - * Compare the skills of a candidate to the skills related to a job using the Ontology API. - * @param resume The resume containing the skills of the candidate - * @param professionCodeId The profession code ID from the Professions Taxonomy to compare the skill set to. - * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code - * @param weightSkillsByExperience Whether or not to give a higher weight to skills that the candidate has more experience with. - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public CompareSkillsToProfessionResponse compareSkillsToProfessions( - ParsedResume resume, - int professionCodeId, - String outputLanguage, - boolean weightSkillsByExperience) throws TxException { - if(resume != null && resume.Skills != null && resume.Skills.Normalized != null && resume.Skills.Normalized.size() > 0){ - return compareSkillsToProfessions(professionCodeId, outputLanguage, getNormalizedSkillsFromResume(resume, weightSkillsByExperience)); - } - throw new IllegalArgumentException("The resume must be parsed with V2 skills selected, and with skills normalization enabled"); - } - - /** - * Suggests skills related to given professions. The service returns salient skills that are strongly associated with the professions. - * @param professionCodeIds The code IDs of the professions to suggest skills for. - * @param limit The maximum amount of suggested skills returned. If not sure what value should be, provide 10 as default limit. - * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public SuggestSkillsResponse suggestSkillsFromProfessions(List professionCodeIds, int limit, String outputLanguage) throws TxException { - SuggestSkillsFromProfessionsRequest request = new SuggestSkillsFromProfessionsRequest(); - request.ProfessionCodeIds = professionCodeIds; - request.Limit = limit; - request.OutputLanguage = outputLanguage; - - RequestBody body = createJsonBody(request); - Request apiRequest = new Request.Builder() - .url(_endpoints.desOntologySuggestSkillsFromProfessions()) - .post(body) - .build(); - - HttpResponse response = executeRequest(apiRequest, SuggestSkillsResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - /** - * Suggests skills related to given professions. The service returns salient skills that are strongly associated with the professions. - * @param professionCodeIds The code IDs of the professions to suggest skills for. - * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public SuggestSkillsResponse suggestSkillsFromProfessions(List professionCodeIds, String outputLanguage) throws TxException { - return suggestSkillsFromProfessions(professionCodeIds, 10, outputLanguage); - } - - /** - * Suggests skills related to a resume based on the recent professions in the resume. - * @param resume The resume to suggest skills for (based on the professions in the resume). - * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public SuggestSkillsResponse suggestSkillsFromProfessions(ParsedResume resume, String outputLanguage) throws TxException { - if(resume != null && resume.EmploymentHistory != null && resume.EmploymentHistory.Positions != null){ - List normalizedProfs = new ArrayList(); - for(Position position: resume.EmploymentHistory.Positions){ - if (position != null && position.NormalizedProfession != null && position.NormalizedProfession.Profession != null && position.NormalizedProfession.Profession.CodeId != null){ - normalizedProfs.add(position.NormalizedProfession.Profession.CodeId); - } - } - - if (normalizedProfs.size() > 0){ - return suggestSkillsFromProfessions(normalizedProfs, outputLanguage); - } - } - throw new IllegalArgumentException("No professions were found in the resume, or the resume was parsed without professions normalization enabled"); - } - - /** - * Suggests skills related to a resume based on the recent professions in the resume. - * @param resume The resume to suggest skills for (based on the professions in the resume). - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public SuggestSkillsResponse suggestSkillsFromProfessions(ParsedResume resume) throws TxException { - return suggestSkillsFromProfessions(resume, null); - } - - /** - * Suggests skills related to a job based on the profession title in the job. - * @param job The resume to suggest skills for (based on the professions in the resume). - * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public SuggestSkillsResponse suggestSkillsFromProfessions(ParsedJob job, String outputLanguage) throws TxException { - if(job != null && job.JobTitles != null && job.JobTitles.NormalizedProfession != null && job.JobTitles.NormalizedProfession.Profession != null && job.JobTitles.NormalizedProfession.Profession.CodeId != null){ - List ids = new ArrayList(); - ids.add(job.JobTitles.NormalizedProfession.Profession.CodeId); - - return suggestSkillsFromProfessions(ids, outputLanguage); - } - throw new IllegalArgumentException("No professions were found in the job, or the job was parsed without professions normalization enabled"); - } - - /** - * Suggests skills related to a job based on the profession title in the job. - * @param job The resume to suggest skills for (based on the professions in the resume). - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public SuggestSkillsResponse suggestSkillsFromProfessions(ParsedJob job) throws TxException { - return suggestSkillsFromProfessions(job, null); - } - - private List getNormalizedSkillsFromResume(ParsedResume resume, boolean weightSkillsByExperience) { - if(resume != null && resume.Skills != null && resume.Skills.Normalized != null && resume.Skills.Normalized.size() > 0){ - List skills = new ArrayList(); - - ResumeNormalizedSkill maxExperienceSkill = Collections.max(resume.Skills.Normalized, Comparator.comparing(s -> s.MonthsExperience != null ? s.MonthsExperience.Value : 0)); - Integer maxExperience = Optional.ofNullable(maxExperienceSkill).map(s -> s.MonthsExperience).map(e -> e.Value).orElse(0); - - for(int i = 0; i < resume.Skills.Normalized.size(); i++) { - ResumeNormalizedSkill curSkill = resume.Skills.Normalized.get(i); - SkillScore newSkill = new SkillScore(curSkill.Id); - int curMonthsExperience = Optional.ofNullable(curSkill.MonthsExperience).map(e -> e.Value).orElse(0); - newSkill.Score = (weightSkillsByExperience && maxExperience > 0) ? curMonthsExperience / (float)maxExperience : 1; - - skills.add(newSkill); - } - - return skills; - } - throw new IllegalArgumentException("The resume must be parsed with V2 skills selected, and with skills normalization enabled."); - } - - /** - * Suggest professions based on the skills within a given resume. - * @param resume The professions are suggested based on the skills within this resume. - * @param limit The maximum amount of professions returned. If not sure what value should be, provide 10 as default limit. - * @param returnMissingSkills Flag to enable returning a list of missing skills per suggested profession. - * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code - * @param weightSkillsByExperience Whether or not to give a higher weight to skills that the candidate has more experience with. - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public SuggestProfessionsResponse suggestProfessionsFromSkills( - ParsedResume resume, - int limit, - boolean returnMissingSkills, - String outputLanguage, - boolean weightSkillsByExperience) throws TxException { - if(resume != null && resume.Skills != null && resume.Skills.Normalized != null && resume.Skills.Normalized.size() > 0){ - return suggestProfessionsFromSkills(getNormalizedSkillsFromResume(resume, weightSkillsByExperience), limit, returnMissingSkills, outputLanguage); - } - throw new IllegalArgumentException("The resume must be parsed with V2 skills selected, and with skills normalization enabled."); - } - - /** - * Suggest professions based on the skills within a given resume. - * @param resume The professions are suggested based on the skills within this resume. Defaults limit returned to 10 and does not return missing skills. Use another overload to specify these parameters. - * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public SuggestProfessionsResponse suggestProfessionsFromSkills(ParsedResume resume, String outputLanguage) throws TxException { - return suggestProfessionsFromSkills(resume, 10, false, outputLanguage, true); - } - - /** - * Suggest professions based on the skills within a given resume. - * @param resume The professions are suggested based on the skills within this resume. Defaults limit returned to 10 and does not return missing skills. Use another overload to specify these parameters. - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public SuggestProfessionsResponse suggestProfessionsFromSkills(ParsedResume resume) throws TxException { - return suggestProfessionsFromSkills(resume, null); - } - - /** - * Suggest professions based on the skills within a given job. - * @param job The professions are suggested based on the skills within this job. - * @param limit The maximum amount of professions returned. If not sure what value should be, provide 10 as default limit. - * @param returnMissingSkills Flag to enable returning a list of missing skills per suggested profession. - * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public SuggestProfessionsResponse suggestProfessionsFromSkills(ParsedJob job, int limit, boolean returnMissingSkills, String outputLanguage) throws TxException { - if(job != null && job.Skills != null && job.Skills.Normalized != null && job.Skills.Normalized.size() > 0){ - List skills = new ArrayList(); - int amountOfSkills = job.Skills.Normalized.size() > 50 ? 50 : job.Skills.Normalized.size(); - for(int i = 0; i < amountOfSkills; i++) { - skills.add(new SkillScore(job.Skills.Normalized.get(i).Id)); - } - - return suggestProfessionsFromSkills(skills, limit, returnMissingSkills, outputLanguage); - } - throw new IllegalArgumentException("The job must be parsed with V2 skills selected, and with skills normalization enabled"); - } - - /** - * Suggest professions based on the skills within a given job. - * @param job The professions are suggested based on the skills within this job. Defaults limit returned to 10 and does not return missing skills. Use another overload to specify these parameters. - * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public SuggestProfessionsResponse suggestProfessionsFromSkills(ParsedJob job, String outputLanguage) throws TxException { - return suggestProfessionsFromSkills(job, 10, false, outputLanguage); - } - - /** - * Suggest professions based on the skills within a given job. - * @param job The professions are suggested based on the skills within this job. Defaults limit returned to 10 and does not return missing skills. Use another overload to specify these parameters. - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public SuggestProfessionsResponse suggestProfessionsFromSkills(ParsedJob job) throws TxException { - return suggestProfessionsFromSkills(job, null); - } - - /** - * Suggest professions based on a given set of skills. - * @param skills The skills used to return the most relevant professions. The list can contain up to 50 skills. - * @param limit The maximum amount of professions returned. If not sure what value should be, provide 10 as default limit. - * @param returnMissingSkills Flag to enable returning a list of missing skills per suggested profession. - * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public SuggestProfessionsResponse suggestProfessionsFromSkills( - List skills, - int limit, - boolean returnMissingSkills, - String outputLanguage) throws TxException { - SuggestProfessionsRequest request = new SuggestProfessionsRequest(); - request.Skills = skills; - request.Limit = limit; - request.ReturnMissingSkills = returnMissingSkills; - request.OutputLanguage = outputLanguage; - - RequestBody body = createJsonBody(request); - Request apiRequest = new Request.Builder() - .url(_endpoints.desOntologySuggestProfessions()) - .post(body) - .build(); - - HttpResponse response = executeRequest(apiRequest, SuggestProfessionsResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - /** - * Suggest professions based on a given set of skill IDs. - * @param skillIds The skill IDs used to return the most relevant professions. The list can contain up to 50 skill IDs. Defaults limit returned to 10 and does not return missing skills. Use another overload to specify these parameters. - * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public SuggestProfessionsResponse suggestProfessionsFromSkills(List skillIds, String outputLanguage) throws TxException { - List skills = skillIds.stream() - .map(s -> new SkillScore(s)) - .collect(Collectors.toList()); - return suggestProfessionsFromSkills(skills, 10, false, outputLanguage); - } - - /** - * Returns skills related to a given skill or set of skills. The service returns closely related skills in a sense that - * knowing the provided skills either implies knowledge about the returned related skills, or should make it considerably - * easier to acquire knowledge about them. - * @param skills The skills (and optionally, scores) for which the service should return related skills. The list can contain up to 50 skills. - * @param limit The maximum amount of suggested skills returned. The maximum is 25. - * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public SuggestSkillsResponse suggestSkillsFromSkills( - List skills, - int limit, - String outputLanguage) throws TxException { - SuggestSkillsFromSkillsRequest request = new SuggestSkillsFromSkillsRequest(); - request.Skills = skills; - request.Limit = limit; - request.OutputLanguage = outputLanguage; - - RequestBody body = createJsonBody(request); - Request apiRequest = new Request.Builder() - .url(_endpoints.desOntologySuggestSkillsFromSkills()) - .post(body) - .build(); - - HttpResponse response = executeRequest(apiRequest, SuggestSkillsResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - /** - * Returns skills related to a given skill or set of skills. The service returns closely related skills in a sense that - * knowing the provided skills either implies knowledge about the returned related skills, or should make it considerably - * easier to acquire knowledge about them. - * @param skillIds The skill IDs for which the service should return related skills. The list can contain up to 50 skills. - * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public SuggestSkillsResponse suggestSkillsFromSkills(List skillIds, String outputLanguage) throws TxException { - return suggestSkillsFromSkills(skillIds.stream().map(s -> new SkillScore(s)).collect(Collectors.toList()), 25, outputLanguage); - } - - /** - * Suggests skills related to a job (but not in the job) based on the skills in the job. The service returns closely related skills in a sense that - * knowing the provided skills either implies knowledge about the returned related skills, or should make it considerably - * easier to acquire knowledge about them. - * @param job The job to suggest skills for (based on the skills in the job). - * @param limit The maximum amount of suggested skills returned. The maximum is 25. - * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public SuggestSkillsResponse suggestSkillsFromSkills( - ParsedJob job, - int limit, - String outputLanguage) throws TxException { - if(job != null && job.Skills != null && job.Skills.Normalized != null && job.Skills.Normalized.size() > 0){ - List skills = new ArrayList(); - int amountOfSkills = job.Skills.Normalized.size() > 50 ? 50 : job.Skills.Normalized.size(); - for(int i = 0; i < amountOfSkills; i++) { - skills.add(new SkillScore(job.Skills.Normalized.get(i).Id)); - } - - return suggestSkillsFromSkills(skills, limit, outputLanguage); - } - throw new IllegalArgumentException("The job must be parsed with V2 skills selected, and with skills normalization enabled"); - } - - /** - * Suggests skills related to a job (but not in the job) based on the skills in the job. The service returns closely related skills in a sense that - * knowing the provided skills either implies knowledge about the returned related skills, or should make it considerably - * easier to acquire knowledge about them. - * @param job The job to suggest skills for (based on the skills in the job). - * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public SuggestSkillsResponse suggestSkillsFromSkills(ParsedJob job, String outputLanguage) throws TxException { - return suggestSkillsFromSkills(job, 25, outputLanguage); - } - - /** - * Suggests skills related to a resume (but not in the resume) based on the skills in the resume. The service returns closely related skills in a sense that - * knowing the provided skills either implies knowledge about the returned related skills, or should make it considerably - * easier to acquire knowledge about them. - * @param resume The resume to suggest skills for (based on the skills in the resume). - * @param limit The maximum amount of suggested skills returned. The maximum is 25. - * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code - * @param weightSkillsByExperience Whether or not to give a higher weight to skills that the candidate has more experience with. - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public SuggestSkillsResponse suggestSkillsFromSkills( - ParsedResume resume, - int limit, - String outputLanguage, - boolean weightSkillsByExperience) throws TxException { - return suggestSkillsFromSkills(getNormalizedSkillsFromResume(resume, weightSkillsByExperience), limit, outputLanguage); - } - - /** - * Suggests skills related to a resume (but not in the resume) based on the skills in the resume. The service returns closely related skills in a sense that - * knowing the provided skills either implies knowledge about the returned related skills, or should make it considerably - * easier to acquire knowledge about them. - * @param resume The resume to suggest skills for (based on the skills in the resume). - * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public SuggestSkillsResponse suggestSkillsFromSkills(ParsedResume resume, String outputLanguage) throws TxException { - return suggestSkillsFromSkills(resume, 25, outputLanguage, true); - } - - /** - * Determines how closely related one set of skills is to another. The service defines closely related skills - * such that knowing a skill either implies knowledge about another skill, or should make it considerably - * easier to acquire knowledge about that skill. - * @param skillSetA A set of skills (and optionally, scores) to score against the other set of skills. The list can contain up to 50 skills. - * @param skillSetB A set of skills (and optionally, scores) to score against the other set of skills. The list can contain up to 50 skills. - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public SkillsSimilarityScoreResponse skillsSimilarityScore(List skillSetA, List skillSetB) throws TxException { - SkillsSimilarityScoreRequest request = new SkillsSimilarityScoreRequest(); - request.SkillsA = skillSetA; - request.SkillsB = skillSetB; - - RequestBody body = createJsonBody(request); - Request apiRequest = new Request.Builder() - .url(_endpoints.desOntologySkillsSimilarityScore()) - .post(body) - .build(); - - HttpResponse response = executeRequest(apiRequest, SkillsSimilarityScoreResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - /** - * Suggests skills related to given professions. The service returns salient skills that are strongly associated with the professions. - * @param professionCodeIds The code IDs of the professions to suggest skills for. - * @param limit The maximum amount of suggested skills returned. If not sure what value should be, provide 10 as default limit. - * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code - * @param types If specified, only these types of skills will be returned. The following values are acceptable: Professional, IT, Language, Soft, Certfication, All. - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public SuggestSkillsResponse suggestSkillsFromProfessionsV2(List professionCodeIds, int limit, String outputLanguage, List types) throws TxException { - SuggestSkillsFromProfessionsRequest request = new SuggestSkillsFromProfessionsRequest(); - request.ProfessionCodeIds = professionCodeIds; - request.Limit = limit; - request.OutputLanguage = outputLanguage; - request.Types = types; - - RequestBody body = createJsonBody(request); - Request apiRequest = new Request.Builder() - .url(_endpoints.desOntologySuggestSkillsFromProfessionsV2()) - .post(body) - .build(); - - HttpResponse response = executeRequest(apiRequest, SuggestSkillsResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - /** - * Suggests skills related to given professions. The service returns salient skills that are strongly associated with the professions. - * @param professionCodeIds The code IDs of the professions to suggest skills for. - * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public SuggestSkillsResponse suggestSkillsFromProfessionsV2(List professionCodeIds, String outputLanguage) throws TxException { - return suggestSkillsFromProfessionsV2(professionCodeIds, 10, outputLanguage, null); - } - - /** - * Suggests skills related to a resume based on the recent professions in the resume. - * @param resume The resume to suggest skills for (based on the professions in the resume). - * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public SuggestSkillsResponse suggestSkillsFromProfessionsV2(ParsedResume resume, String outputLanguage) throws TxException { - if(resume != null && resume.EmploymentHistory != null && resume.EmploymentHistory.Positions != null){ - List normalizedProfs = new ArrayList(); - for(Position position: resume.EmploymentHistory.Positions){ - if (position != null && position.NormalizedProfession != null && position.NormalizedProfession.Profession != null && position.NormalizedProfession.Profession.CodeId != null){ - normalizedProfs.add(position.NormalizedProfession.Profession.CodeId); - } - } - - if (normalizedProfs.size() > 0){ - return suggestSkillsFromProfessionsV2(normalizedProfs, outputLanguage); - } - } - throw new IllegalArgumentException("No professions were found in the resume, or the resume was parsed without professions normalization enabled"); - } - - /** - * Suggests skills related to a resume based on the recent professions in the resume. - * @param resume The resume to suggest skills for (based on the professions in the resume). - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public SuggestSkillsResponse suggestSkillsFromProfessionsV2(ParsedResume resume) throws TxException { - return suggestSkillsFromProfessionsV2(resume, null); - } - - /** - * Suggests skills related to a job based on the profession title in the job. - * @param job The resume to suggest skills for (based on the professions in the resume). - * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public SuggestSkillsResponse suggestSkillsFromProfessionsV2(ParsedJob job, String outputLanguage) throws TxException { - if(job != null && job.JobTitles != null && job.JobTitles.NormalizedProfession != null && job.JobTitles.NormalizedProfession.Profession != null && job.JobTitles.NormalizedProfession.Profession.CodeId != null){ - List ids = new ArrayList(); - ids.add(job.JobTitles.NormalizedProfession.Profession.CodeId); - - return suggestSkillsFromProfessionsV2(ids, outputLanguage); - } - throw new IllegalArgumentException("No professions were found in the job, or the job was parsed without professions normalization enabled"); - } - - /** - * Suggests skills related to a job based on the profession title in the job. - * @param job The resume to suggest skills for (based on the professions in the resume). - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public SuggestSkillsResponse suggestSkillsFromProfessionsV2(ParsedJob job) throws TxException { - return suggestSkillsFromProfessionsV2(job, null); - } - - /** - * Suggest professions based on the skills within a given resume. - * @param resume The professions are suggested based on the skills within this resume. - * @param limit The maximum amount of professions returned. If not sure what value should be, provide 10 as default limit. - * @param returnMissingSkills Flag to enable returning a list of missing skills per suggested profession. - * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code - * @param weightSkillsByExperience Whether or not to give a higher weight to skills that the candidate has more experience with. - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public SuggestProfessionsResponse suggestProfessionsFromSkillsV2( - ParsedResume resume, - int limit, - boolean returnMissingSkills, - String outputLanguage, - boolean weightSkillsByExperience) throws TxException { - if(resume != null && resume.Skills != null && resume.Skills.Normalized != null && resume.Skills.Normalized.size() > 0){ - return suggestProfessionsFromSkillsV2(getNormalizedSkillsFromResume(resume, weightSkillsByExperience), limit, returnMissingSkills, outputLanguage); - } - throw new IllegalArgumentException("The resume must be parsed with V2 skills selected, and with skills normalization enabled."); - } - - /** - * Suggest professions based on the skills within a given resume. - * @param resume The professions are suggested based on the skills within this resume. Defaults limit returned to 10 and does not return missing skills. Use another overload to specify these parameters. - * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public SuggestProfessionsResponse suggestProfessionsFromSkillsV2(ParsedResume resume, String outputLanguage) throws TxException { - return suggestProfessionsFromSkillsV2(resume, 10, false, outputLanguage, true); - } - - /** - * Suggest professions based on the skills within a given resume. - * @param resume The professions are suggested based on the skills within this resume. Defaults limit returned to 10 and does not return missing skills. Use another overload to specify these parameters. - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public SuggestProfessionsResponse suggestProfessionsFromSkillsV2(ParsedResume resume) throws TxException { - return suggestProfessionsFromSkillsV2(resume, null); - } - - /** - * Suggest professions based on the skills within a given job. - * @param job The professions are suggested based on the skills within this job. - * @param limit The maximum amount of professions returned. If not sure what value should be, provide 10 as default limit. - * @param returnMissingSkills Flag to enable returning a list of missing skills per suggested profession. - * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public SuggestProfessionsResponse suggestProfessionsFromSkillsV2(ParsedJob job, int limit, boolean returnMissingSkills, String outputLanguage) throws TxException { - if(job != null && job.Skills != null && job.Skills.Normalized != null && job.Skills.Normalized.size() > 0){ - List skills = new ArrayList(); - int amountOfSkills = job.Skills.Normalized.size() > 50 ? 50 : job.Skills.Normalized.size(); - for(int i = 0; i < amountOfSkills; i++) { - skills.add(new SkillScore(job.Skills.Normalized.get(i).Id)); - } - - return suggestProfessionsFromSkillsV2(skills, limit, returnMissingSkills, outputLanguage); - } - throw new IllegalArgumentException("The job must be parsed with V2 skills selected, and with skills normalization enabled"); - } - - /** - * Suggest professions based on the skills within a given job. - * @param job The professions are suggested based on the skills within this job. Defaults limit returned to 10 and does not return missing skills. Use another overload to specify these parameters. - * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public SuggestProfessionsResponse suggestProfessionsFromSkillsV2(ParsedJob job, String outputLanguage) throws TxException { - return suggestProfessionsFromSkillsV2(job, 10, false, outputLanguage); - } - - /** - * Suggest professions based on the skills within a given job. - * @param job The professions are suggested based on the skills within this job. Defaults limit returned to 10 and does not return missing skills. Use another overload to specify these parameters. - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public SuggestProfessionsResponse suggestProfessionsFromSkillsV2(ParsedJob job) throws TxException { - return suggestProfessionsFromSkillsV2(job, null); - } - - /** - * Suggest professions based on a given set of skills. - * @param skills The skills used to return the most relevant professions. The list can contain up to 50 skills. - * @param limit The maximum amount of professions returned. If not sure what value should be, provide 10 as default limit. - * @param returnMissingSkills Flag to enable returning a list of missing skills per suggested profession. - * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public SuggestProfessionsResponse suggestProfessionsFromSkillsV2( - List skills, - int limit, - boolean returnMissingSkills, - String outputLanguage) throws TxException { - SuggestProfessionsRequest request = new SuggestProfessionsRequest(); - request.Skills = skills; - request.Limit = limit; - request.ReturnMissingSkills = returnMissingSkills; - request.OutputLanguage = outputLanguage; - - RequestBody body = createJsonBody(request); - Request apiRequest = new Request.Builder() - .url(_endpoints.desOntologySuggestProfessionsV2()) - .post(body) - .build(); - - HttpResponse response = executeRequest(apiRequest, SuggestProfessionsResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - /** - * Suggest professions based on a given set of skill IDs. - * @param skillIds The skill IDs used to return the most relevant professions. The list can contain up to 50 skill IDs. Defaults limit returned to 10 and does not return missing skills. Use another overload to specify these parameters. - * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public SuggestProfessionsResponse suggestProfessionsFromSkillsV2(List skillIds, String outputLanguage) throws TxException { - List skills = skillIds.stream() - .map(s -> new SkillScore(s)) - .collect(Collectors.toList()); - return suggestProfessionsFromSkillsV2(skills, 10, false, outputLanguage); - } - - /** - * Returns skills related to a given skill or set of skills. The service returns closely related skills in a sense that - * knowing the provided skills either implies knowledge about the returned related skills, or should make it considerably - * easier to acquire knowledge about them. - * @param skills The skills (and optionally, scores) for which the service should return related skills. The list can contain up to 50 skills. - * @param limit The maximum amount of suggested skills returned. The maximum is 25. - * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code - * @param types If specified, only these types of skills will be returned. The following values are acceptable: Professional, IT, Language, Soft, Certfication, All. - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public SuggestSkillsResponse suggestSkillsFromSkillsV2( - List skills, - int limit, - String outputLanguage, - List types) throws TxException { - SuggestSkillsFromSkillsRequest request = new SuggestSkillsFromSkillsRequest(); - request.Skills = skills; - request.Limit = limit; - request.OutputLanguage = outputLanguage; - request.Types = types; - - RequestBody body = createJsonBody(request); - Request apiRequest = new Request.Builder() - .url(_endpoints.desOntologySuggestSkillsFromSkillsV2()) - .post(body) - .build(); - - HttpResponse response = executeRequest(apiRequest, SuggestSkillsResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - /** - * Returns skills related to a given skill or set of skills. The service returns closely related skills in a sense that - * knowing the provided skills either implies knowledge about the returned related skills, or should make it considerably - * easier to acquire knowledge about them. - * @param skillIds The skill IDs for which the service should return related skills. The list can contain up to 50 skills. - * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public SuggestSkillsResponse suggestSkillsFromSkillsV2(List skillIds, String outputLanguage) throws TxException { - return suggestSkillsFromSkillsV2(skillIds.stream().map(s -> new SkillScore(s)).collect(Collectors.toList()), 25, outputLanguage, null); - } - - /** - * Suggests skills related to a job (but not in the job) based on the skills in the job. The service returns closely related skills in a sense that - * knowing the provided skills either implies knowledge about the returned related skills, or should make it considerably - * easier to acquire knowledge about them. - * @param job The job to suggest skills for (based on the skills in the job). - * @param limit The maximum amount of suggested skills returned. The maximum is 25. - * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public SuggestSkillsResponse suggestSkillsFromSkillsV2( - ParsedJob job, - int limit, - String outputLanguage) throws TxException { - if(job != null && job.Skills != null && job.Skills.Normalized != null && job.Skills.Normalized.size() > 0){ - List skills = new ArrayList(); - int amountOfSkills = job.Skills.Normalized.size() > 50 ? 50 : job.Skills.Normalized.size(); - for(int i = 0; i < amountOfSkills; i++) { - skills.add(new SkillScore(job.Skills.Normalized.get(i).Id)); - } - - return suggestSkillsFromSkillsV2(skills, limit, outputLanguage, null); - } - throw new IllegalArgumentException("The job must be parsed with V2 skills selected, and with skills normalization enabled"); - } - - /** - * Suggests skills related to a job (but not in the job) based on the skills in the job. The service returns closely related skills in a sense that - * knowing the provided skills either implies knowledge about the returned related skills, or should make it considerably - * easier to acquire knowledge about them. - * @param job The job to suggest skills for (based on the skills in the job). - * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public SuggestSkillsResponse suggestSkillsFromSkillsV2(ParsedJob job, String outputLanguage) throws TxException { - return suggestSkillsFromSkillsV2(job, 25, outputLanguage); - } - - /** - * Suggests skills related to a resume (but not in the resume) based on the skills in the resume. The service returns closely related skills in a sense that - * knowing the provided skills either implies knowledge about the returned related skills, or should make it considerably - * easier to acquire knowledge about them. - * @param resume The resume to suggest skills for (based on the skills in the resume). - * @param limit The maximum amount of suggested skills returned. The maximum is 25. - * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code - * @param weightSkillsByExperience Whether or not to give a higher weight to skills that the candidate has more experience with. - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public SuggestSkillsResponse suggestSkillsFromSkillsV2( - ParsedResume resume, - int limit, - String outputLanguage, - boolean weightSkillsByExperience) throws TxException { - return suggestSkillsFromSkillsV2(getNormalizedSkillsFromResume(resume, weightSkillsByExperience), limit, outputLanguage, null); - } - - /** - * Suggests skills related to a resume (but not in the resume) based on the skills in the resume. The service returns closely related skills in a sense that - * knowing the provided skills either implies knowledge about the returned related skills, or should make it considerably - * easier to acquire knowledge about them. - * @param resume The resume to suggest skills for (based on the skills in the resume). - * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public SuggestSkillsResponse suggestSkillsFromSkillsV2(ParsedResume resume, String outputLanguage) throws TxException { - return suggestSkillsFromSkillsV2(resume, 25, outputLanguage, true); - } - - /** - * Determines how closely related one set of skills is to another. The service defines closely related skills - * such that knowing a skill either implies knowledge about another skill, or should make it considerably - * easier to acquire knowledge about that skill. - * @param skillSetA A set of skills (and optionally, scores) to score against the other set of skills. The list can contain up to 50 skills. - * @param skillSetB A set of skills (and optionally, scores) to score against the other set of skills. The list can contain up to 50 skills. - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public SkillsSimilarityScoreResponse skillsSimilarityScoreV2(List skillSetA, List skillSetB) throws TxException { - SkillsSimilarityScoreRequest request = new SkillsSimilarityScoreRequest(); - request.SkillsA = skillSetA; - request.SkillsB = skillSetB; - - RequestBody body = createJsonBody(request); - Request apiRequest = new Request.Builder() - .url(_endpoints.desOntologySkillsSimilarityScoreV2()) - .post(body) - .build(); - - HttpResponse response = executeRequest(apiRequest, SkillsSimilarityScoreResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - - /** - * Generates a job description based on specified parameters. - * @param request The request body - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public GenerateJobResponse generateJobDescription(GenerateJobRequest request) throws TxException { - RequestBody body = createJsonBody(request); - Request apiRequest = new Request.Builder() - .url(_endpoints.jobDescriptionGenerate()) - .post(body) - .build(); - - HttpResponse response = executeRequest(apiRequest, GenerateJobResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - /** - * Takes a job title and suggests relevant skills. - * @param jobTitle The title of the job for which skills are being suggested. - * @param language Language of the suggested skills in ISO 639-1 code format. - * @param limit Maximum number of skills to suggest. If not specified this parameter defaults to 10. This value cannot exceed 50. - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public SuggestSkillsFromJobTitleResponse suggestSkillsFromJobTitle(String jobTitle, String language, Integer limit) throws TxException { - SuggestSkillsFromJobTitleRequest request = new SuggestSkillsFromJobTitleRequest(); - request.JobTitle = jobTitle; - request.Language = language; - request.Limit = limit; - - RequestBody body = createJsonBody(request); - Request apiRequest = new Request.Builder() - .url(_endpoints.jobDescriptionSuggestSkills()) - .post(body) - .build(); - - HttpResponse response = executeRequest(apiRequest, SuggestSkillsFromJobTitleResponse.class, getBodyIfDebug(apiRequest)); - return response.getData(); - } - - /** - * Takes a job title and suggests relevant skills. - * @param jobTitle The title of the job for which skills are being suggested. - * @return The API response body - * @throws TxException Thrown when an API error occurs - */ - public SuggestSkillsFromJobTitleResponse suggestSkillsFromJobTitle(String jobTitle) throws TxException { - return suggestSkillsFromJobTitle(jobTitle, "en", null); + _accountService = new AccountService(httpClient, settings); + _formatterService = new FormatterService(httpClient, settings); + _geocoderService = new GeocoderService(httpClient, settings); + _parserService = new ParserService(httpClient, settings); + _searchMatchV1Service = new SearchMatchService(httpClient, settings); + _searchMatchV2Service = new MatchV2Service(httpClient, settings); + _skillsIntelligenceService = new SkillsIntelligenceService(httpClient, settings); } } \ No newline at end of file diff --git a/src/main/java/com/textkernel/tx/TxClientSettings.java b/src/main/java/com/textkernel/tx/TxClientSettings.java new file mode 100644 index 000000000..fd8f66c33 --- /dev/null +++ b/src/main/java/com/textkernel/tx/TxClientSettings.java @@ -0,0 +1,26 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx; + +import java.util.List; + +/** The SDK client to perform Tx API calls. */ +public class TxClientSettings extends EnvironmentSettings { + /** + * The Account ID for your account. Found at https://cloud.textkernel.com/tx/console + */ + public String AccountId; + + /** + * The Service Key for your account. Found at https://cloud.textkernel.com/tx/console + */ + public String ServiceKey; + + /** + * Optional tags to use to track API usage for your account + */ + public List TrackingTags; +} diff --git a/src/main/java/com/textkernel/tx/TxUIClient.java b/src/main/java/com/textkernel/tx/TxUIClient.java deleted file mode 100644 index c580f420a..000000000 --- a/src/main/java/com/textkernel/tx/TxUIClient.java +++ /dev/null @@ -1,176 +0,0 @@ -// Copyright © 2023 Textkernel BV. All rights reserved. -// This file is provided for use by, or on behalf of, Textkernel licensees -// within the terms of their license of Textkernel products or Textkernel customers -// within the Terms of Service pertaining to the Textkernel SaaS products. - -package com.textkernel.tx; - -import com.textkernel.tx.exceptions.TxException; -import com.textkernel.tx.models.api.bimetricscoring.*; -import com.textkernel.tx.models.api.matching.*; -import com.textkernel.tx.models.api.matching.request.FilterCriteria; -import com.textkernel.tx.models.api.matching.request.MatchByDocumentIdOptions; -import com.textkernel.tx.models.api.matching.request.PaginationSettings; -import com.textkernel.tx.models.api.matching.request.SearchMatchSettings; -import com.textkernel.tx.models.api.matching.ui.GenerateUIResponse; -import com.textkernel.tx.models.api.matching.ui.request.*; -import com.textkernel.tx.models.job.ParsedJob; -import com.textkernel.tx.models.resume.ParsedResume; - -import java.util.List; - -/** Extension methods to generate the Matching UI. Access with {@link TxClient#ui(MatchUISettings)}*/ -public class TxUIClient { - - private final MatchUISettings _uiSessionOptions; - private final TxClient _client; - - TxUIClient(MatchUISettings uiOptions, TxClient client) { - _uiSessionOptions = uiOptions; - _client = client; - } - - /** - * Create a Matching UI session to find matches for a non-indexed resume. - * @param resume The resume (generated by the Resume Parser) to use as the source for a match query - * @param indexesToQuery The indexes to find results in. These must all be of the same type (resumes or jobs) - * @param preferredWeights - * The preferred category weights for scoring the results. If {@code null}, - * The best values will be determined based on the source resume - * @param filters Any filters to apply prior to the match (a result must satisfy all the filters), or {@code null} - * @param settings The settings for this match request. Use {@code null} for defaults. - * @param numResults The number of results to show. Use {@code 0} for the default. - * @return The response containing a URL for the Matching UI session - * @throws TxException Thrown when an API error occurs - */ - public GenerateUIResponse match( - ParsedResume resume, - List indexesToQuery, - CategoryWeights preferredWeights, - FilterCriteria filters, - SearchMatchSettings settings, - int numResults) throws TxException { - - MatchResumeRequest request = _client.createRequest(resume, indexesToQuery, preferredWeights, filters, settings, numResults); - UIMatchResumeRequest uiRequest = new UIMatchResumeRequest(request, _uiSessionOptions); - return _client.uiMatch(uiRequest); - } - - /** - * Create a Matching UI session to find matches for a non-indexed job. - * @param job The job (generated by the Job Parser) to use as the source for a match query - * @param indexesToQuery The indexes to find results in. These must all be of the same type (resumes or jobs) - * @param preferredWeights - * The preferred category weights for scoring the results. If {@code null}, - * The best values will be determined based on the source job - * @param filters Any filters to apply prior to the match (a result must satisfy all the filters), or {@code null} - * @param settings The settings for this match request. Use {@code null} for defaults. - * @param numResults The number of results to show. Use {@code 0} for the default. - * @return The response containing a URL for the Matching UI session - * @throws TxException Thrown when an API error occurs - */ - public GenerateUIResponse match( - ParsedJob job, - List indexesToQuery, - CategoryWeights preferredWeights, - FilterCriteria filters, - SearchMatchSettings settings, - int numResults) throws TxException { - - MatchJobRequest request = _client.createRequest(job, indexesToQuery, preferredWeights, filters, settings, numResults); - UIMatchJobRequest uiRequest = new UIMatchJobRequest(request, _uiSessionOptions); - return _client.uiMatch(uiRequest); - } - - /** - * Create a Matching UI session to find matches for a resume or job that is already indexed - * @param indexId The index containing the document you want to match - * @param documentId The ID of the document to match - * @param indexesToQuery The indexes to find results in. These must all be of the same type (resumes or jobs) - * @param preferredWeights - * The preferred category weights for scoring the results. If {@code null}, - * The best values will be determined based on the source resume/job - * @param filters Any filters to apply prior to the match (a result must satisfy all the filters), or {@code null} - * @param settings The settings for this match request. Use {@code null} for defaults. - * @param numResults The number of results to show. Use {@code 0} for the default. - * @return The response containing a URL for the Matching UI session - * @throws TxException Thrown when an API error occurs - */ - public GenerateUIResponse match( - String indexId, - String documentId, - List indexesToQuery, - CategoryWeights preferredWeights, - FilterCriteria filters, - SearchMatchSettings settings, - int numResults) throws TxException { - - MatchByDocumentIdOptions request = _client.createRequest(indexesToQuery, preferredWeights, filters, settings, numResults); - UIMatchByDocumentIdOptions uiRequest = new UIMatchByDocumentIdOptions(request, _uiSessionOptions); - return _client.uiMatch(indexId, documentId, uiRequest); - } - - /** - * Create a Matching UI session to search for resumes or jobs that meet specific criteria - * @param indexesToQuery The indexes to find results in. These must all be of the same type (resumes or jobs) - * @param query The search query. A result must satisfy all of these criteria - * @param settings The settings for this search request. Use {@code null} for defaults. - * @param pagination Pagination settings. Use {@code null} for defaults. - * @return The response containing a URL for the Matching UI session - * @throws TxException Thrown when an API error occurs - */ - public GenerateUIResponse search( - List indexesToQuery, - FilterCriteria query, - SearchMatchSettings settings, - PaginationSettings pagination) throws TxException { - - SearchRequest request = _client.createRequest(indexesToQuery, query, settings, pagination); - UISearchRequest uiRequest = new UISearchRequest(request, _uiSessionOptions); - return _client.uiSearch(uiRequest); - } - - /** - * Create a Matching UI session to score one or more target documents against a source resume - * @param Either {@link ParsedResumeWithId} or {@link ParsedJobWithId} - * @param sourceResume The source resume - * @param targetDocuments The target resumes/jobs - * @param preferredWeights - * The preferred category weights for scoring the results. If {@code null}, - * The best values will be determined based on the source resume. - * @param settings The settings for this search request. Use {@code null} for defaults. - * @return The response containing a URL for the Matching UI session - * @throws TxException Thrown when an API error occurs - */ - public GenerateUIResponse bimetricScore( - ParsedResumeWithId sourceResume, - List targetDocuments, - CategoryWeights preferredWeights, - SearchMatchSettings settings) throws TxException { - BimetricScoreResumeRequest request = _client.createRequest(sourceResume, targetDocuments, preferredWeights, settings); - UIBimetricScoreResumeRequest uiRequest = new UIBimetricScoreResumeRequest(request, _uiSessionOptions); - return _client.uiBimetricScore(uiRequest); - } - - /** - * Create a Matching UI session to score one or more target documents against a source job - * @param Either {@link ParsedResumeWithId} or {@link ParsedJobWithId} - * @param sourceJob The source job - * @param targetDocuments The target resumes/jobs - * @param preferredWeights - * The preferred category weights for scoring the results. If {@code null}, - * The best values will be determined based on the source job. - * @param settings The settings for this search request. Use {@code null} for defaults. - * @return The response containing a URL for the Matching UI session - * @throws TxException Thrown when an API error occurs - */ - public GenerateUIResponse bimetricScore( - ParsedJobWithId sourceJob, - List targetDocuments, - CategoryWeights preferredWeights, - SearchMatchSettings settings) throws TxException { - BimetricScoreJobRequest request = _client.createRequest(sourceJob, targetDocuments, preferredWeights, settings); - UIBimetricScoreJobRequest uiRequest = new UIBimetricScoreJobRequest(request, _uiSessionOptions); - return _client.uiBimetricScore(uiRequest); - } -} diff --git a/src/main/java/com/textkernel/tx/models/api/geocoding/GeocodeAndIndexRequest.java b/src/main/java/com/textkernel/tx/models/api/geocoding/GeocodeAndIndexRequest.java index 1a9a0d4ff..32830664b 100644 --- a/src/main/java/com/textkernel/tx/models/api/geocoding/GeocodeAndIndexRequest.java +++ b/src/main/java/com/textkernel/tx/models/api/geocoding/GeocodeAndIndexRequest.java @@ -5,7 +5,7 @@ package com.textkernel.tx.models.api.geocoding; -import com.textkernel.tx.models.api.indexes.IndexSingleDocumentInfo; +import com.textkernel.tx.models.api.indexes.IndexingOptionsGeneric; /** Request body for geocoding a document and then adding into an index */ public class GeocodeAndIndexRequest { @@ -17,5 +17,5 @@ public class GeocodeAndIndexRequest { public GeocodeOptionsBase GeocodeOptions; /** Where to index the resume */ - public IndexSingleDocumentInfo IndexingOptions; + public IndexingOptionsGeneric IndexingOptions; } diff --git a/src/main/java/com/textkernel/tx/models/api/indexes/IndexJobInfo.java b/src/main/java/com/textkernel/tx/models/api/indexes/IndexJobInfo.java index 440cf856b..ed191149b 100644 --- a/src/main/java/com/textkernel/tx/models/api/indexes/IndexJobInfo.java +++ b/src/main/java/com/textkernel/tx/models/api/indexes/IndexJobInfo.java @@ -10,7 +10,7 @@ /** * Information for adding a single job to an index as part of a 'batch upload' */ -public class IndexJobInfo extends IndexMultipleDocumentInfo { +public class IndexJobInfo extends IndexingOptionsGeneric { /** A job to index */ public ParsedJob JobData; diff --git a/src/main/java/com/textkernel/tx/models/api/indexes/IndexMultipleDocumentInfo.java b/src/main/java/com/textkernel/tx/models/api/indexes/IndexMultipleDocumentInfo.java deleted file mode 100644 index a3f1503be..000000000 --- a/src/main/java/com/textkernel/tx/models/api/indexes/IndexMultipleDocumentInfo.java +++ /dev/null @@ -1,23 +0,0 @@ -// Copyright © 2023 Textkernel BV. All rights reserved. -// This file is provided for use by, or on behalf of, Textkernel licensees -// within the terms of their license of Textkernel products or Textkernel customers -// within the Terms of Service pertaining to the Textkernel SaaS products. - -package com.textkernel.tx.models.api.indexes; - -import java.util.List; - -/** - * Information for adding a single document to an index as part of a 'batch upload' - */ -public class IndexMultipleDocumentInfo { - - /** - * The id to assign to the new document. This is restricted to alphanumeric with dashes and underscores. - * All values will be converted to lower-case. - */ - public String DocumentId; - - /** The user-defined tags the document should have */ - public List UserDefinedTags; -} diff --git a/src/main/java/com/textkernel/tx/models/api/indexes/IndexResumeInfo.java b/src/main/java/com/textkernel/tx/models/api/indexes/IndexResumeInfo.java index 8c63fc9f1..caa847cd5 100644 --- a/src/main/java/com/textkernel/tx/models/api/indexes/IndexResumeInfo.java +++ b/src/main/java/com/textkernel/tx/models/api/indexes/IndexResumeInfo.java @@ -10,7 +10,7 @@ /** * Information for adding a single resume to an index as part of a 'batch upload' */ -public class IndexResumeInfo extends IndexMultipleDocumentInfo { +public class IndexResumeInfo extends IndexingOptionsGeneric { /** A resume to index */ public ParsedResume ResumeData; diff --git a/src/main/java/com/textkernel/tx/models/api/indexes/IndexingOptionsGeneric.java b/src/main/java/com/textkernel/tx/models/api/indexes/IndexingOptionsGeneric.java new file mode 100644 index 000000000..d4f2bd724 --- /dev/null +++ b/src/main/java/com/textkernel/tx/models/api/indexes/IndexingOptionsGeneric.java @@ -0,0 +1,103 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx.models.api.indexes; + +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +import com.textkernel.tx.models.api.matchV2.MatchV2Environment; + +/** + * Generic options that have properties for both V1 and V2. + */ +public class IndexingOptionsGeneric { + + /** + * The Search & Match Version to use for indexing. + */ + public SearchAndMatchVersion SearchAndMatchVersion; + + /** + * The id to assign to the new document. This is restricted to alphanumeric with dashes and underscores. + * All values will be converted to lower-case. + */ + public String DocumentId; + + /** + * The id for the index where the document should be added (case-insensitive). + *

+ * Only use when {@link #SearchAndMatchVersion} = {@link SearchAndMatchVersion#V1} + *

+ */ + public String IndexId; + + /** The user-defined tags the document should have + *

+ * Only use when {@link #SearchAndMatchVersion} = {@link SearchAndMatchVersion#V1} + *

+ */ + public List UserDefinedTags; + + /** + * The target environment where the document will be uploaded + *

+ * Only use when {@link #SearchAndMatchVersion} = {@link SearchAndMatchVersion#V2} + *

+ */ + public MatchV2Environment SearchAndMatchEnvironment; + + /** + * The list of roles that are allowed to retrieve the document. If not set, ["all"] will be used. + *

+ * Only use when {@link #SearchAndMatchVersion} = {@link SearchAndMatchVersion#V2} + *

+ */ + public List Roles; + + /** + * A key-value collection of custom fields. + *

+ * Only use when {@link #SearchAndMatchVersion} = {@link SearchAndMatchVersion#V2} + *

+ */ + public Map CustomFields; + + /** Be sure to set all the correct properties depending if you are using Match V1 or V2 if you use this constructor */ + IndexingOptionsGeneric() { } + + /** + * Create options to index a document with Match V1 + * @param documentId The id to assign to the new document. This is restricted to alphanumeric with dashes and underscores. All values will be converted to lower-case. + * @param indexId The id for the index where the document should be added (case-insensitive). + * @param userDefinedTags (optional) The user-defined tags the document should have + */ + public IndexingOptionsGeneric(String documentId, String indexId, List userDefinedTags) { + SearchAndMatchVersion = com.textkernel.tx.models.api.indexes.SearchAndMatchVersion.V1; + UserDefinedTags = userDefinedTags != null ? userDefinedTags : new ArrayList<>(); + IndexId = indexId; + DocumentId = documentId; + } + + /** + * Create options to upload a document with Match V2 + * @param env The target environment where the document will be uploaded + * @param documentId The id to assign to the new document. This is restricted to alphanumeric with dashes and underscores. + * @param roles (optional) The list of roles that are allowed to retrieve the document. If not set, ["all"] will be used. + * @param customFields (optional) A key-value collection of custom fields. + */ + public IndexingOptionsGeneric( + MatchV2Environment env, + String documentId, + List roles, + Map customFields) { + SearchAndMatchVersion = com.textkernel.tx.models.api.indexes.SearchAndMatchVersion.V2; + Roles = roles; + CustomFields = customFields; + DocumentId = documentId; + SearchAndMatchEnvironment = env; + } +} diff --git a/src/main/java/com/textkernel/tx/models/api/indexes/IndexSingleDocumentInfo.java b/src/main/java/com/textkernel/tx/models/api/indexes/SearchAndMatchVersion.java similarity index 57% rename from src/main/java/com/textkernel/tx/models/api/indexes/IndexSingleDocumentInfo.java rename to src/main/java/com/textkernel/tx/models/api/indexes/SearchAndMatchVersion.java index becb45043..4450fed04 100644 --- a/src/main/java/com/textkernel/tx/models/api/indexes/IndexSingleDocumentInfo.java +++ b/src/main/java/com/textkernel/tx/models/api/indexes/SearchAndMatchVersion.java @@ -5,11 +5,12 @@ package com.textkernel.tx.models.api.indexes; -/** -* Information for adding a document to an index -*/ -public class IndexSingleDocumentInfo extends IndexMultipleDocumentInfo { - - /** The id for the index where the document should be added (case-insensitive).*/ - public String IndexId; +import com.textkernel.tx.TxClient; + +/** The Search & Match Version to use for indexing. */ +public enum SearchAndMatchVersion { + /** V1, see {@link TxClient#searchMatchV1()} */ + V1, + /** V2, see {@link TxClient#searchMatchV2()} */ + V2 } diff --git a/src/main/java/com/textkernel/tx/models/api/matchV2/MatchV2Environment.java b/src/main/java/com/textkernel/tx/models/api/matchV2/MatchV2Environment.java new file mode 100644 index 000000000..659e0848b --- /dev/null +++ b/src/main/java/com/textkernel/tx/models/api/matchV2/MatchV2Environment.java @@ -0,0 +1,14 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx.models.api.matchV2; + +/** The target environment for Search & Match V2 */ +public enum MatchV2Environment { + /** Acceptance */ + ACC, + /** Production */ + PROD +} diff --git a/src/main/java/com/textkernel/tx/models/api/matchV2/autocomplete/AutocompleteCandidatesField.java b/src/main/java/com/textkernel/tx/models/api/matchV2/autocomplete/AutocompleteCandidatesField.java new file mode 100644 index 000000000..cd88517b3 --- /dev/null +++ b/src/main/java/com/textkernel/tx/models/api/matchV2/autocomplete/AutocompleteCandidatesField.java @@ -0,0 +1,68 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx.models.api.matchV2.autocomplete; + +import com.google.gson.annotations.SerializedName; + +/** Which field should be used to generate completions for an autocomplete request */ +public enum AutocompleteCandidatesField { + /** + * Generate completions from multiple dictionaries + */ + @SerializedName("FULLTEXT") + FullText, + /** + * Generate completions from IT skills in the index + */ + @SerializedName("compskills") + ITSkills, + /** + * Generate completions from professional skills in the index + */ + @SerializedName("profskills") + ProfessionalSkills, + /** + * Generate completions from language skills in the index + */ + @SerializedName("langskills.name") + LanguageSkills, + /** + * Generate completions from recent job titles in the index + */ + @SerializedName("recent_job_titles") + RecentJobTitles, + /** + * Generate completions from all job titles in the index + */ + @SerializedName("job_titles") + AllJobTitles, + /** + * Generate completions from last job titles in the index + */ + @SerializedName("last_job_title") + LastJobTitle, + /** + * Generate completions from degree names in the index + */ + @SerializedName("degrees.name") + DegreeNames, + /** + * Generate completions from candidate locations (addresses) in the index + */ + @SerializedName("location") + Location, + /** + * Generate completions from profession groups in the index + */ + @SerializedName("work_field.profession_group") + ProfessionGroup, + /** + * Generate completions from normalized international education levels in the + * index + */ + @SerializedName("education_level_international") + EducationLevel +} diff --git a/src/main/java/com/textkernel/tx/models/api/matchV2/autocomplete/AutocompleteJobsField.java b/src/main/java/com/textkernel/tx/models/api/matchV2/autocomplete/AutocompleteJobsField.java new file mode 100644 index 000000000..d6fbf6129 --- /dev/null +++ b/src/main/java/com/textkernel/tx/models/api/matchV2/autocomplete/AutocompleteJobsField.java @@ -0,0 +1,48 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx.models.api.matchV2.autocomplete; + +import com.google.gson.annotations.SerializedName; + +/** Which field should be used to generate completions for an autocomplete request */ +public enum AutocompleteJobsField { + /** + * Generate completions from multiple dictionaries + */ + @SerializedName("FULLTEXT") + FullText, + /** + * Generate completions from IT skills in the index + */ + @SerializedName("compskills") + ITSkills, + /** + * Generate completions from language skills in the index + */ + @SerializedName("langskills") + LanguageSkills, + /** + * Generate completions from all job titles in the index + */ + @SerializedName("job_title") + JobTitle, + /** + * Generate completions from vacancy locations (addresses) in the index + */ + @SerializedName("location") + Location, + /** + * Generate completions from profession groups in the index + */ + @SerializedName("work_field.profession_group") + ProfessionGroup, + /** + * Generate completions from normalized international education levels in the + * index + */ + @SerializedName("education_level_international") + EducationLevel +} diff --git a/src/main/java/com/textkernel/tx/models/api/matchV2/autocomplete/AutocompleteRequest.java b/src/main/java/com/textkernel/tx/models/api/matchV2/autocomplete/AutocompleteRequest.java new file mode 100644 index 000000000..95ea13c71 --- /dev/null +++ b/src/main/java/com/textkernel/tx/models/api/matchV2/autocomplete/AutocompleteRequest.java @@ -0,0 +1,23 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx.models.api.matchV2.autocomplete; + +import com.textkernel.tx.models.api.matchV2.MatchV2Environment; + +/** The request body for an Autocomplete request */ +public class AutocompleteRequest { + /** The field to retrieve completions for */ + public T Field; + + /** The user-typed input string. */ + public String Input; + + /** Which environment to target */ + public MatchV2Environment SearchAndMatchEnvironment; + + /** Optional comma-separated 2-letter ISO-639-1 language codes from the supported languages. The first language is used for field label translations. */ + public String Language; +} diff --git a/src/main/java/com/textkernel/tx/models/api/matchV2/autocomplete/AutocompleteResponse.java b/src/main/java/com/textkernel/tx/models/api/matchV2/autocomplete/AutocompleteResponse.java new file mode 100644 index 000000000..da2ebf767 --- /dev/null +++ b/src/main/java/com/textkernel/tx/models/api/matchV2/autocomplete/AutocompleteResponse.java @@ -0,0 +1,13 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx.models.api.matchV2.autocomplete; + +import com.textkernel.tx.models.api.ApiResponse; + +/** The response body for an Autocomplete request */ +public class AutocompleteResponse extends ApiResponse { + +} diff --git a/src/main/java/com/textkernel/tx/models/api/matchV2/autocomplete/AutocompleteResponseValue.java b/src/main/java/com/textkernel/tx/models/api/matchV2/autocomplete/AutocompleteResponseValue.java new file mode 100644 index 000000000..5c0dfe894 --- /dev/null +++ b/src/main/java/com/textkernel/tx/models/api/matchV2/autocomplete/AutocompleteResponseValue.java @@ -0,0 +1,16 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx.models.api.matchV2.autocomplete; + +import java.util.List; + +import com.textkernel.tx.models.api.ApiResponse; + +/** The {@link ApiResponse#Value} for an Autocomplete response */ +public class AutocompleteResponseValue { + /** A list of suggested completions */ + public List Return; +} diff --git a/src/main/java/com/textkernel/tx/models/api/matchV2/autocomplete/Completion.java b/src/main/java/com/textkernel/tx/models/api/matchV2/autocomplete/Completion.java new file mode 100644 index 000000000..34d25e4ad --- /dev/null +++ b/src/main/java/com/textkernel/tx/models/api/matchV2/autocomplete/Completion.java @@ -0,0 +1,22 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx.models.api.matchV2.autocomplete; + +/** + * This object describes a single auto-completion result. The auto-completion service returns a + * list of these completions. Besides the actual suggested completion item, it contains the field + * name and field label of search field this suggestion should be targeted to. +*/ +public class Completion { + /** The field name. */ + public String Field; + /** The display label of the field. */ + public String FieldLabel; + /** The completion suggestion. */ + public String Item; + /** Same as the item, but with highlighting tags showing the matching parts of the suggestion. */ + public String ItemHighlighted; +} diff --git a/src/main/java/com/textkernel/tx/models/api/matchV2/documents/AddCandidateRequest.java b/src/main/java/com/textkernel/tx/models/api/matchV2/documents/AddCandidateRequest.java new file mode 100644 index 000000000..5be672690 --- /dev/null +++ b/src/main/java/com/textkernel/tx/models/api/matchV2/documents/AddCandidateRequest.java @@ -0,0 +1,22 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx.models.api.matchV2.documents; + +import java.util.Map; + +import com.textkernel.tx.models.resume.ParsedResume; + +/** Request body for AddCandidate request */ +public class AddCandidateRequest extends AddDocumentRequest { + /** A boolean flag to strip PII data out of the requests before sending to Search & Match V2 */ + public boolean Anonymize; + + /** Parsed output from the CV/Resume Parser. */ + public ParsedResume ResumeData; + + /** A collection of custom fields represented as key-value pairs. */ + public Map CustomFields; +} diff --git a/src/main/java/com/textkernel/tx/models/api/matchV2/documents/AddCandidateResponse.java b/src/main/java/com/textkernel/tx/models/api/matchV2/documents/AddCandidateResponse.java new file mode 100644 index 000000000..48f7dd50f --- /dev/null +++ b/src/main/java/com/textkernel/tx/models/api/matchV2/documents/AddCandidateResponse.java @@ -0,0 +1,13 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx.models.api.matchV2.documents; + +import com.textkernel.tx.models.api.ApiResponse; + +/** The response body from a AddCandidate API call*/ +public class AddCandidateResponse extends ApiResponse { + +} diff --git a/src/main/java/com/textkernel/tx/models/api/matchV2/documents/AddDocumentRequest.java b/src/main/java/com/textkernel/tx/models/api/matchV2/documents/AddDocumentRequest.java new file mode 100644 index 000000000..2b2314fed --- /dev/null +++ b/src/main/java/com/textkernel/tx/models/api/matchV2/documents/AddDocumentRequest.java @@ -0,0 +1,19 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx.models.api.matchV2.documents; + +import java.util.List; + +import com.textkernel.tx.models.api.matchV2.MatchV2Environment; + +/** Most SearchMatchV2 requests have Roles */ +public class AddDocumentRequest { + /** The roles associated with the request. Defaults to ["All"] if none are provided. */ + public List Roles; + + /** The target environment */ + public MatchV2Environment SearchAndMatchEnvironment; +} diff --git a/src/main/java/com/textkernel/tx/models/api/matchV2/documents/AddJobRequest.java b/src/main/java/com/textkernel/tx/models/api/matchV2/documents/AddJobRequest.java new file mode 100644 index 000000000..dc027546c --- /dev/null +++ b/src/main/java/com/textkernel/tx/models/api/matchV2/documents/AddJobRequest.java @@ -0,0 +1,19 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx.models.api.matchV2.documents; + +import java.util.Map; + +import com.textkernel.tx.models.job.ParsedJob; + +/** Request body for AddJob request */ +public class AddJobRequest extends AddDocumentRequest { + /** Parsed output from the Job Parser. */ + public ParsedJob JobData; + + /** A collection of custom fields represented as key-value pairs. */ + public Map CustomFields; +} diff --git a/src/main/java/com/textkernel/tx/models/api/matchV2/documents/AddJobResponse.java b/src/main/java/com/textkernel/tx/models/api/matchV2/documents/AddJobResponse.java new file mode 100644 index 000000000..32cb26057 --- /dev/null +++ b/src/main/java/com/textkernel/tx/models/api/matchV2/documents/AddJobResponse.java @@ -0,0 +1,13 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx.models.api.matchV2.documents; + +import com.textkernel.tx.models.api.ApiResponse; + +/** The response body from a AddJob API call*/ +public class AddJobResponse extends ApiResponse { + +} diff --git a/src/main/java/com/textkernel/tx/models/api/matchV2/documents/DeleteDocumentsResponse.java b/src/main/java/com/textkernel/tx/models/api/matchV2/documents/DeleteDocumentsResponse.java new file mode 100644 index 000000000..95d18c458 --- /dev/null +++ b/src/main/java/com/textkernel/tx/models/api/matchV2/documents/DeleteDocumentsResponse.java @@ -0,0 +1,13 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx.models.api.matchV2.documents; + +import com.textkernel.tx.models.api.ApiResponse; + +/** The response body from a DeleteCandidates or DeleteJobs API call*/ +public class DeleteDocumentsResponse extends ApiResponse { + +} diff --git a/src/main/java/com/textkernel/tx/models/api/matchV2/documents/DeleteDocumentsResponseValue.java b/src/main/java/com/textkernel/tx/models/api/matchV2/documents/DeleteDocumentsResponseValue.java new file mode 100644 index 000000000..93ac151c3 --- /dev/null +++ b/src/main/java/com/textkernel/tx/models/api/matchV2/documents/DeleteDocumentsResponseValue.java @@ -0,0 +1,16 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx.models.api.matchV2.documents; + +import java.util.List; + +import com.textkernel.tx.models.api.ApiResponse; + +/** The {@link ApiResponse#Value} from a DeleteCandidates or DeleteJobs API call*/ +public class DeleteDocumentsResponseValue { + /** List of documents successfully deleted. */ + public List DeletedDocumentIds; +} diff --git a/src/main/java/com/textkernel/tx/models/api/matchV2/documents/DocumentSource.java b/src/main/java/com/textkernel/tx/models/api/matchV2/documents/DocumentSource.java new file mode 100644 index 000000000..ddd71c522 --- /dev/null +++ b/src/main/java/com/textkernel/tx/models/api/matchV2/documents/DocumentSource.java @@ -0,0 +1,15 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx.models.api.matchV2.documents; + +/** Defines a document that can be used to generate a match query. */ +public class DocumentSource { + /** Specify what type of document is being passed to the match engine. */ + public DocumentType Type; + + /** Id of the document in the index to generate the query from. */ + public String Id; +} diff --git a/src/main/java/com/textkernel/tx/models/api/matchV2/documents/DocumentType.java b/src/main/java/com/textkernel/tx/models/api/matchV2/documents/DocumentType.java new file mode 100644 index 000000000..30e833c8d --- /dev/null +++ b/src/main/java/com/textkernel/tx/models/api/matchV2/documents/DocumentType.java @@ -0,0 +1,14 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx.models.api.matchV2.documents; + +/** Document type for Search & Match V2 */ +public enum DocumentType { + /** candidate documents (CVs/resumes) */ + candidate, + /** job documents (jobs) */ + vacancy +} diff --git a/src/main/java/com/textkernel/tx/models/api/matchV2/querying/MatchRequest.java b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/MatchRequest.java new file mode 100644 index 000000000..9b8efec6c --- /dev/null +++ b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/MatchRequest.java @@ -0,0 +1,24 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx.models.api.matchV2.querying; + +import com.textkernel.tx.models.api.matchV2.MatchV2Environment; +import com.textkernel.tx.models.api.matchV2.documents.DocumentSource; + +/** Request body for a Match request */ +public class MatchRequest { + /** The target environment */ + public MatchV2Environment SearchAndMatchEnvironment; + + /** The options for the Match request */ + public Options Options; + + /** The query object that will be combined with the match query to drive the search. */ + public SearchQuery Query; + + /** The document to generate the search query from. */ + public DocumentSource SourceDocument; +} diff --git a/src/main/java/com/textkernel/tx/models/api/matchV2/querying/Options.java b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/Options.java new file mode 100644 index 000000000..a0c6b992a --- /dev/null +++ b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/Options.java @@ -0,0 +1,99 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx.models.api.matchV2.querying; + +import java.util.List; + +/** Options for a Search or Match request */ +public class Options { + /** + * The roles associated with the request. Defaults to "All" if none are provided. + */ + public List Roles; + + /** + * If true then no result list is returned. Used for example when only the cloud is needed. + */ + public Boolean SupressResultList; + /** + * If true then spelling correction on the input query is skipped. + */ + public Boolean SupressCorrection; + + /** + * Optional. If true search responses will be highlighted. Note: If a snippet was requested from the searcher as part of the + * result fields, the snippet can still contain highlighting even when false/null. + */ + public Boolean Highlight; + + /** + * Optional parameter to specify the number of result items (max 1500). + * Only use a high number in case you need a list of results for use in follow-up actions. + * Do not use a high number when presenting results in a user interface. + * Therefore, the max is 100 when used in combination with pagination parameters ({@link #SearchAfter} or + * {@link #ResultOffset}). When this is larger than 100, facet counts and search term highlighting + * are not provided ({@link #FacetCounts} and {@link #Highlight} are implicitly set to false). + * If not provided, the pre-configured page size of the searcher will be used. + * This value is ignored for external searchers. + */ + public Integer PageSize; + + /** + * Used for pagination within Elastic Search Searcher (ignored for external searchers). + * Represents the sort values of the last item from the previous page. Must contain exactly the + * {@link SearchResult#SearchAfter} returned from the previous page query. + */ + public String[] SearchAfter; + + /** + * the result item offset used for pagination. For example, a value of 20 will skip the top 20 results and return the subsequent + * results starting with result 21. This is ignored if {@link #SearchAfter} is set. {@link #ResultOffset} + {@link #PageSize} + * cannot be more than 10000. + */ + public Integer ResultOffset; + + /** + * Optional List of language codes preferred by the user to filter synonyms by languages. + */ + public String[] SynonymLanguages; + + /** + * Optional. If true the content of a query part item of type TEXT or LONG_TEXT (its term plus synonyms) + * that overlaps more than 75% with a previous query part of the same field and condition + * will be moved into the synonyms of that previous one. + */ + public Boolean MergeOverLappingSynonyms; + + /** + * Optional setting for synonym expansion mode. + */ + public SynonymExpansionMode SynonymExpansionMode; + + /** + * Optional customization of the fields to be included in the results. If it consists of a single wildcard + * field marked by "*" (star) then all available fields will be returned. If empty then the default result + * field set will be returned. Remark: Reducing the returned fields this way, will not in general improve + * performance, since Search is optimized to return the standard configured field set. It is not possible to + * request system fields such as 'roles' or nested sub-fields. + */ + public String[] ResultFields; + + /** + * Optional. If true the search responses will contain facet count. May result in slower response times. + */ + public Boolean FacetCounts; + + /** + * Optional sorting definition. + */ + public Sorting[] Sorting; + + /** + * Optional flag indicating that the backend needs to use the Natural Language + * Query Service (NLQS) to interpret the query String. + */ + public Boolean UseNLQS; +} diff --git a/src/main/java/com/textkernel/tx/models/api/matchV2/querying/SearchQuery.java b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/SearchQuery.java new file mode 100644 index 000000000..d3ec0b5ea --- /dev/null +++ b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/SearchQuery.java @@ -0,0 +1,22 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx.models.api.matchV2.querying; + +import java.util.List; + +import com.textkernel.tx.models.api.matchV2.querying.results.QueryPart; + +/** A search query */ +public class SearchQuery { + /** + * User typed keyword query (see query language description). It may be joined + * with the {@link #QueryParts} if it is a single OR-combination part that can be joined. + */ + public String QueryString; + + /** Generated by a previous query. See {@link SearchResult#QueryParts} */ + public List QueryParts; +} diff --git a/src/main/java/com/textkernel/tx/models/api/matchV2/querying/SearchResponse.java b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/SearchResponse.java new file mode 100644 index 000000000..ca5e3f34b --- /dev/null +++ b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/SearchResponse.java @@ -0,0 +1,14 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx.models.api.matchV2.querying; + +import com.textkernel.tx.models.api.ApiResponse; +import com.textkernel.tx.models.api.matchV2.querying.results.SearchResult; + +/** The API response body for a Search or Match request */ +public class SearchResponse extends ApiResponse { + +} diff --git a/src/main/java/com/textkernel/tx/models/api/matchV2/querying/SortOrder.java b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/SortOrder.java new file mode 100644 index 000000000..2e977822a --- /dev/null +++ b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/SortOrder.java @@ -0,0 +1,14 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx.models.api.matchV2.querying; + +/** The sort order for results */ +public enum SortOrder { + /** Ascending sort order */ + ASCENDING, + /** Descending sort order */ + DESCENDING +} diff --git a/src/main/java/com/textkernel/tx/models/api/matchV2/querying/Sorting.java b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/Sorting.java new file mode 100644 index 000000000..50cecddff --- /dev/null +++ b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/Sorting.java @@ -0,0 +1,29 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx.models.api.matchV2.querying; + +/** Options to control sort order */ +public class Sorting { + /** + * The field name. Two special "fields" exist: _reranker and _score. _score means sorting by the engine score, + * _reranker means sorting by reranker score. For sorting with type _reranker a reranker needs to be configured. + * A sorting on field _reranker cannot have subsortings on other fields and cannot have a custom order. + */ + public String Field; + + /** + * Optional order of the sorting. The default behavior depends on the data type of the field: {@link SortOrder#DESCENDING} + * for numeric and date types, {@link SortOrder#ASCENDING} for other types. For fields with location data type, + * results will be sorted according to the distance to the {@link #ReferenceLocation} and only {@link SortOrder#ASCENDING} is supported. + */ + public SortOrder Order; + + /** + * Optional (required for fields with location data type specified) String representation of a location point in + * the form of LATITUDE LONGITUDE (e.g. 53.3478 -6.2597). This is used for distance sorting on a location field. + */ + public String ReferenceLocation; +} diff --git a/src/main/java/com/textkernel/tx/models/api/matchV2/querying/SynonymExpansionMode.java b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/SynonymExpansionMode.java new file mode 100644 index 000000000..8f5a3e109 --- /dev/null +++ b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/SynonymExpansionMode.java @@ -0,0 +1,16 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx.models.api.matchV2.querying; + +/** Options for synonym expansion in queries */ +public enum SynonymExpansionMode { + /** build the synonym map from the query only, expand the query. This is the default option. */ + QUERY, + /** build synonym map from both query and query parts, expand the query, prune and expand the query parts. */ + QUERY_AND_QUERYPARTS, + /** build synonym map from both query and query parts, expand the query, only prune the query parts. */ + QUERY_AND_SYNONYMMAP +} diff --git a/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/Cloudtype.java b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/Cloudtype.java new file mode 100644 index 000000000..74bde008f --- /dev/null +++ b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/Cloudtype.java @@ -0,0 +1,15 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx.models.api.matchV2.querying.results; + +public enum Cloudtype { + SPHERE, + SPREAD, + LIST, + COLUMNS1, + COLUMNS2, + COLUMNS3 +} \ No newline at end of file diff --git a/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/Combinationtype.java b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/Combinationtype.java new file mode 100644 index 000000000..c3a5bc821 --- /dev/null +++ b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/Combinationtype.java @@ -0,0 +1,12 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx.models.api.matchV2.querying.results; + +public enum Combinationtype { + AND, + OR, + SINGLE +} diff --git a/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/Condition.java b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/Condition.java new file mode 100644 index 000000000..1390f58fd --- /dev/null +++ b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/Condition.java @@ -0,0 +1,13 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx.models.api.matchV2.querying.results; + +public enum Condition { + FAVORED, + STRONGLY_FAVORED, + REQUIRED, + BANNED +} diff --git a/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/Datatype.java b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/Datatype.java new file mode 100644 index 000000000..57899fab1 --- /dev/null +++ b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/Datatype.java @@ -0,0 +1,18 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx.models.api.matchV2.querying.results; + +public enum Datatype { + TEXT, + LONG_TEXT, + UNANALYZED_TEXT, + CODE, + NUMERIC, + DATE, + LOCATION, + OBJECT, + TEXT_FINGERPRINT +} diff --git a/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/Facet.java b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/Facet.java new file mode 100644 index 000000000..74f1c1831 --- /dev/null +++ b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/Facet.java @@ -0,0 +1,50 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx.models.api.matchV2.querying.results; + +public class Facet { + public String Field; + public String FieldLabel; + public Datatype DataType; + public boolean DataTypeSpecified; + public Combinationtype CombinationType; + public boolean CombinationTypeSpecified; + public Guitype GuiType; + public boolean GuiTypeSpecified; + public Cloudtype CloudType; + public boolean CloudTypeSpecified; + public boolean Collapsed; + public boolean CollapsedSpecified; + public boolean HideFacetIfAllZero; + public boolean HideFacetIfAllZeroSpecified; + public boolean HideZeroCountItems; + public boolean HideZeroCountItemsSpecified; + public Condition DefaultCondition; + public boolean DefaultConditionSpecified; + public boolean HideConditionWidget; + public boolean HideConditionWidgetSpecified; + public boolean ReverseItemOrder; + public boolean ReverseItemOrderSpecified; + public FacetItem[] Items; + public String[] Distances; + public String DefaultDistance; + public boolean TextInputOnFacet; + public boolean TextInputOnFacetSpecified; + public String Format; + public String[] NestedFields; + public boolean ShowOnFacet; + public boolean ShowOnFacetSpecified; + public boolean ShowOnWidget; + public boolean ShowOnWidgetSpecified; + public String GroupFieldName; + public String GroupName; + public Facet[] ChildFacets; + public Facet[] SubFacets; + public String SearchEngine; + public int DropdownSwitcherThreshold; + public boolean DropdownSwitcherThresholdSpecified; + public QueryPartItemCountsMapEntry[] QueryPartItemCounts; +} diff --git a/src/main/java/com/textkernel/tx/models/api/matching/ui/UserDefinedTagOption.java b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/FacetItem.java similarity index 54% rename from src/main/java/com/textkernel/tx/models/api/matching/ui/UserDefinedTagOption.java rename to src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/FacetItem.java index 0cecc5c3d..ef3a12b78 100644 --- a/src/main/java/com/textkernel/tx/models/api/matching/ui/UserDefinedTagOption.java +++ b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/FacetItem.java @@ -3,14 +3,11 @@ // within the terms of their license of Textkernel products or Textkernel customers // within the Terms of Service pertaining to the Textkernel SaaS products. -package com.textkernel.tx.models.api.matching.ui; +package com.textkernel.tx.models.api.matchV2.querying.results; -/** A label/value pair for user-defined tags in the UI*/ -public class UserDefinedTagOption { - - /** The value of the tag.*/ +public class FacetItem { public String Value; - - /** The text that will be shown to the user for the tag.*/ - public String Text; -} + public String Label; + public long Count; + public boolean CountSpecified; +} \ No newline at end of file diff --git a/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/FieldValue.java b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/FieldValue.java new file mode 100644 index 000000000..edc2f309a --- /dev/null +++ b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/FieldValue.java @@ -0,0 +1,11 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx.models.api.matchV2.querying.results; + +public class FieldValue { + public String Value; + public FieldValueEntry[] SubValues; +} \ No newline at end of file diff --git a/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/FieldValueEntry.java b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/FieldValueEntry.java new file mode 100644 index 000000000..6700dc57e --- /dev/null +++ b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/FieldValueEntry.java @@ -0,0 +1,11 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx.models.api.matchV2.querying.results; + +public class FieldValueEntry { + public String Key; + public String[] Value; +} \ No newline at end of file diff --git a/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/Guitype.java b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/Guitype.java new file mode 100644 index 000000000..fbf05df87 --- /dev/null +++ b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/Guitype.java @@ -0,0 +1,19 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx.models.api.matchV2.querying.results; + +public enum Guitype { + FIXED, + DYNAMIC, + CLOUD, + TEXTFIELD, + LOCATION, + PROJECT, + GROUP, + OBJECT, + DATERANGE, + NUMERICRANGE +} diff --git a/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/QueryContext.java b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/QueryContext.java new file mode 100644 index 000000000..7642983de --- /dev/null +++ b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/QueryContext.java @@ -0,0 +1,13 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx.models.api.matchV2.querying.results; + +public class QueryContext { + public String[] QueryTags; + public String MatchSource; + public String QueryID; + public String QuerySessionID; +} \ No newline at end of file diff --git a/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/QueryPart.java b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/QueryPart.java new file mode 100644 index 000000000..a6a23393e --- /dev/null +++ b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/QueryPart.java @@ -0,0 +1,17 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx.models.api.matchV2.querying.results; + +public class QueryPart { + public String Field; + public Condition Condition; + public boolean ConditionSpecified; + public float Weight; + public boolean WeightSpecified; + public QueryPartItem[] Items; + public String FieldLabel; + public String SearchEngine; +} \ No newline at end of file diff --git a/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/QueryPartItem.java b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/QueryPartItem.java new file mode 100644 index 000000000..f29fdf123 --- /dev/null +++ b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/QueryPartItem.java @@ -0,0 +1,13 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx.models.api.matchV2.querying.results; + +public class QueryPartItem { + public String Value; + public String[] Synonyms; + public QueryPart[] SubParts; + public String Label; +} \ No newline at end of file diff --git a/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/QueryPartItemCountsMapEntry.java b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/QueryPartItemCountsMapEntry.java new file mode 100644 index 000000000..a7b4973d7 --- /dev/null +++ b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/QueryPartItemCountsMapEntry.java @@ -0,0 +1,11 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx.models.api.matchV2.querying.results; + +public class QueryPartItemCountsMapEntry { + public String Key; + public FacetItem[] Value; +} \ No newline at end of file diff --git a/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/ResultItem.java b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/ResultItem.java new file mode 100644 index 000000000..97b7653aa --- /dev/null +++ b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/ResultItem.java @@ -0,0 +1,13 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx.models.api.matchV2.querying.results; + +public class ResultItem { + public String DocID; + public ResultItemEntry[] FieldValues; + public float Score; + public Integer[] QueryPartScores; +} \ No newline at end of file diff --git a/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/ResultItemEntry.java b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/ResultItemEntry.java new file mode 100644 index 000000000..dfab82871 --- /dev/null +++ b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/ResultItemEntry.java @@ -0,0 +1,11 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx.models.api.matchV2.querying.results; + +public class ResultItemEntry { + public String Key; + public FieldValue[] Value; +} \ No newline at end of file diff --git a/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/SearchResult.java b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/SearchResult.java new file mode 100644 index 000000000..7ec85b65b --- /dev/null +++ b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/SearchResult.java @@ -0,0 +1,24 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx.models.api.matchV2.querying.results; + +public class SearchResult { + public long MatchSize; + public boolean HasMoreResults; + public ResultItem[] ResultItems; + public QueryPart[] QueryParts; + public QueryPart[] NewQueryParts; + public boolean IsOrCombined; + public String TransformedQuery; + public Facet[] FacetCounts; + public String SearchEngine; + public SearchResultEntry[] Synonyms; + public QueryContext QueryContext; + public String[] SearchAfter; + public long EsTimeMs; + public boolean EsTimeMsSpecified; + public String[] Warning; +} \ No newline at end of file diff --git a/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/SearchResultEntry.java b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/SearchResultEntry.java new file mode 100644 index 000000000..9a9f9b324 --- /dev/null +++ b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/SearchResultEntry.java @@ -0,0 +1,11 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx.models.api.matchV2.querying.results; + +public class SearchResultEntry { + public String Key; + public SynonymSection[] Value; +} \ No newline at end of file diff --git a/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/SynonymItem.java b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/SynonymItem.java new file mode 100644 index 000000000..fb4f227df --- /dev/null +++ b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/SynonymItem.java @@ -0,0 +1,12 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx.models.api.matchV2.querying.results; + +public class SynonymItem { + public String Lang; + public boolean AutoExpansion; + public String[] Values; +} \ No newline at end of file diff --git a/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/SynonymSection.java b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/SynonymSection.java new file mode 100644 index 000000000..04c03c7a6 --- /dev/null +++ b/src/main/java/com/textkernel/tx/models/api/matchV2/querying/results/SynonymSection.java @@ -0,0 +1,12 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx.models.api.matchV2.querying.results; + +public class SynonymSection { + public String Name; + public boolean Collapsed; + public SynonymItem[] Items; +} \ No newline at end of file diff --git a/src/main/java/com/textkernel/tx/models/api/matching/ui/FilterToShow.java b/src/main/java/com/textkernel/tx/models/api/matching/ui/FilterToShow.java deleted file mode 100644 index 5a298c374..000000000 --- a/src/main/java/com/textkernel/tx/models/api/matching/ui/FilterToShow.java +++ /dev/null @@ -1,51 +0,0 @@ -// Copyright © 2023 Textkernel BV. All rights reserved. -// This file is provided for use by, or on behalf of, Textkernel licensees -// within the terms of their license of Textkernel products or Textkernel customers -// within the Terms of Service pertaining to the Textkernel SaaS products. - -package com.textkernel.tx.models.api.matching.ui; - -/** Used to change the order or titles of the filters in the Matching UI*/ -public class FilterToShow { - /** - * One of: - *
    - *
  • JOB_TITLES
    • - *
  • EXPERIENCE
    • - *
  • SKILLS
    • - *
  • INDUSTRIES
    • - *
  • BOOLEAN
    • - *
  • LANGUAGES
    • - *
  • CERTIFICATIONS
    • - *
  • EXECUTIVE_TYPES
    • - *
  • LOCATION
    • - *
  • EDUCATION
    • - *
  • EMPLOYERS
    • - *
  • TAGS
    • - *
  • METADATA
    • - *
  • UNCOMMON
    • - *
- */ - public String FilterId; - - /** - * An optional value to override the title that is shown for a specific filter. If not specified, the defaults are as below: - *
    - *
  • Job Titles
    • - *
  • Experience
    • - *
  • Skills
    • - *
  • Industries
    • - *
  • Boolean or Semantic Search
    • - *
  • Spoken Languages
    • - *
  • Certifications
    • - *
  • Executive Types
    • - *
  • Location
    • - *
  • Education
    • - *
  • Employers
    • - *
  • User-Defined Tags
    • - *
  • Document Metadata
    • - *
  • Uncommon Filters
    • - *
- */ - public String Title; -} diff --git a/src/main/java/com/textkernel/tx/models/api/matching/ui/GenerateUIResponse.java b/src/main/java/com/textkernel/tx/models/api/matching/ui/GenerateUIResponse.java deleted file mode 100644 index 6076aa413..000000000 --- a/src/main/java/com/textkernel/tx/models/api/matching/ui/GenerateUIResponse.java +++ /dev/null @@ -1,26 +0,0 @@ -// Copyright © 2023 Textkernel BV. All rights reserved. -// This file is provided for use by, or on behalf of, Textkernel licensees -// within the terms of their license of Textkernel products or Textkernel customers -// within the Terms of Service pertaining to the Textkernel SaaS products. - -package com.textkernel.tx.models.api.matching.ui; - -/** The response body from a request to generate the Matching UI*/ -public class GenerateUIResponse { - - /** - * The URL to navigate to (or set as the src for an iFrame) that will - * display the Matching UI. This URL will be valid for at least 24 hours. - *
NOTE: for security purposes, you should redirect a user to the session - * immediately after generating the session for that user - *
For more info, see https://developer.textkernel.com/tx-platform/v10/matching-ui/overview/#authentication - * */ - public String url; - - /** - * The number of seconds until the URL auto-authentication expires. If you try - * to use this URL after that period of time, the user will be asked to - * login (if not already authenticated) - * */ - public int expires_in; -} diff --git a/src/main/java/com/textkernel/tx/models/api/matching/ui/Style.java b/src/main/java/com/textkernel/tx/models/api/matching/ui/Style.java deleted file mode 100644 index 5c2e8cefa..000000000 --- a/src/main/java/com/textkernel/tx/models/api/matching/ui/Style.java +++ /dev/null @@ -1,36 +0,0 @@ -// Copyright © 2023 Textkernel BV. All rights reserved. -// This file is provided for use by, or on behalf of, Textkernel licensees -// within the terms of their license of Textkernel products or Textkernel customers -// within the Terms of Service pertaining to the Textkernel SaaS products. - -package com.textkernel.tx.models.api.matching.ui; - -/** Options for styling the Matching UI*/ -public class Style { - /** - * An HTML color used to generate several related colors for various UI elements. For example: {@code #077799}. - */ - public String PrimaryColor; - - /** - * An HTML color used for the background of the section/accordian headers. For example: {@code #077799}. - */ - public String HeaderColor; - - /** - * {@code true} to use square corners for UI elements. Default is {@code false} for rounded corners. - */ - public boolean SquareCorners; - - /** - * A CSS font-family to use for all UI elements. For example: {@code Arial}. - */ - public String FontFamily; - - /** - * If you'd like to use a non-standard font, specify the URL where that font can be downloaded here. For example: - * {@code https://fonts.googleapis.com/css2?family=Montserrat:wght@400;500;600;700&display=swap}. Note that you also - * need to define the {@link #FontFamily} if you use this option. - */ - public String FontUrl; -} diff --git a/src/main/java/com/textkernel/tx/models/api/matching/ui/UIOptions.java b/src/main/java/com/textkernel/tx/models/api/matching/ui/UIOptions.java deleted file mode 100644 index 0ef8d413b..000000000 --- a/src/main/java/com/textkernel/tx/models/api/matching/ui/UIOptions.java +++ /dev/null @@ -1,95 +0,0 @@ -// Copyright © 2023 Textkernel BV. All rights reserved. -// This file is provided for use by, or on behalf of, Textkernel licensees -// within the terms of their license of Textkernel products or Textkernel customers -// within the Terms of Service pertaining to the Textkernel SaaS products. - -package com.textkernel.tx.models.api.matching.ui; - -import com.textkernel.tx.models.api.matching.ui.hooks.UserActionHookCollection; - -import java.util.List; - -/** Options for creating the Matching UI*/ -public class UIOptions { - - /** - * The username of the user for which you are generating a Matching UI session. - *
If you do not provide this, the user will be required to login when they view the page - * */ - public String Username; - - /** - * Specifies custom style options for the Matching UI session. - */ - public Style Style; - - /** - * {@code true} to allow the user to see/modify the filter criteria (default = {@code true}). - */ - public boolean ShowFilterCriteria = true; - - /** - * If specified, only allows the user to see/modify certain filter categories. - * Also, the order specified here is the order in which the filters will appear in the UI. - */ - public List FiltersToShow; - - /** - * {@code true} to execute the query as soon as the page loads (default = {@code false}). This is only applicable for Searching. - * All matches/bimetric scoring are executed immediately even if this is {@code false}. - */ - public boolean ExecuteImmediately; - - /** - * {@code true} to show the banner containing your account logo inside the matching UI (default = {@code true}). - */ - public boolean ShowBanner = true; - - /** - * {@code true} to allow the user to see/modify the category weights (default = {@code true}). - */ - public boolean ShowWeights = true; - - /** - * {@code true} to show a button that opens the 'details' popup containing detailed job/resume info (default = {@code true}). - */ - public boolean ShowDetailsButton = true; - - /** - * {@code true} to add a button in the Actions menu that matches other jobs/resumes similar to the current one (default = {@code true}). - */ - public boolean ShowFindSimilar = true; - - /** - * {@code true} to include custom web sourcing in search/match results. Cannot be used for bimetric scoring (default = {@code false}). - */ - public boolean ShowWebSourcing; - - /** - * {@code true} to include job boards in search/match results. Cannot be used for bimetric scoring (default = {@code true}). - * Must add credentials in the Tx Console - */ - public boolean ShowJobBoards = true; - - /** - * {@code true} to allow the user to save custom searches or select from pre-made criteria templates (default = {@code false}). - */ - public boolean ShowSavedSearches; - - /** - * Contains all the User Action Hooks - * for the Match UI session. These are used to make a seamless integration between your system and the Matching UI. - */ - public UserActionHookCollection Hooks; - - /** - * Picklists shown in the UI for your users to filter on your user-defined tags. - *
See also: https://developer.textkernel.com/tx-platform/v10/ai-matching/overview/user-defined-tags/ - */ - public List UserDefinedTagsPicklists; - - /** - * If you are using custom skills, provide your custom skills list names here. The builtin skills lists are always included. - */ - public List SkillsAutoCompleteCustomSkillsList; -} diff --git a/src/main/java/com/textkernel/tx/models/api/matching/ui/UserDefinedTagsPicklist.java b/src/main/java/com/textkernel/tx/models/api/matching/ui/UserDefinedTagsPicklist.java deleted file mode 100644 index 6cc8c3a57..000000000 --- a/src/main/java/com/textkernel/tx/models/api/matching/ui/UserDefinedTagsPicklist.java +++ /dev/null @@ -1,18 +0,0 @@ -// Copyright © 2023 Textkernel BV. All rights reserved. -// This file is provided for use by, or on behalf of, Textkernel licensees -// within the terms of their license of Textkernel products or Textkernel customers -// within the Terms of Service pertaining to the Textkernel SaaS products. - -package com.textkernel.tx.models.api.matching.ui; - -import java.util.List; - -/** A picklist to show to a user for filtering on user-defined tags*/ -public class UserDefinedTagsPicklist { - - /** The label for this picklist in the UI */ - public String Label; - - /** A list of user-defined tags that the user will be able to pick from */ - public List Options; -} diff --git a/src/main/java/com/textkernel/tx/models/api/matching/ui/hooks/ClientSideHook.java b/src/main/java/com/textkernel/tx/models/api/matching/ui/hooks/ClientSideHook.java deleted file mode 100644 index e2fb4cef2..000000000 --- a/src/main/java/com/textkernel/tx/models/api/matching/ui/hooks/ClientSideHook.java +++ /dev/null @@ -1,23 +0,0 @@ -// Copyright © 2023 Textkernel BV. All rights reserved. -// This file is provided for use by, or on behalf of, Textkernel licensees -// within the terms of their license of Textkernel products or Textkernel customers -// within the Terms of Service pertaining to the Textkernel SaaS products. - -package com.textkernel.tx.models.api.matching.ui.hooks; - -/** A hook that does some client-side action (opening a tab/window, running some javascript)*/ -public class ClientSideHook extends UserActionHook { - /** - * A Javascript action to perform when the user clicks the button. This will post a Javascript - * message back to the parent/opener window so that the integrator can run some Javascript. - *
This uses window.postMessage() - *
NOTE: you can use this or {@link #UrlAction} but not both - */ - public JsAction JsAction; - - /** - * A URL action to perform when the user clicks the button. This can open a new window or redirect an existing window to a URL. - *
NOTE: you can use this or {@link #JsAction} but not both - */ - public UrlAction UrlAction; -} diff --git a/src/main/java/com/textkernel/tx/models/api/matching/ui/hooks/JsAction.java b/src/main/java/com/textkernel/tx/models/api/matching/ui/hooks/JsAction.java deleted file mode 100644 index e15976f56..000000000 --- a/src/main/java/com/textkernel/tx/models/api/matching/ui/hooks/JsAction.java +++ /dev/null @@ -1,30 +0,0 @@ -// Copyright © 2023 Textkernel BV. All rights reserved. -// This file is provided for use by, or on behalf of, Textkernel licensees -// within the terms of their license of Textkernel products or Textkernel customers -// within the Terms of Service pertaining to the Textkernel SaaS products. - -package com.textkernel.tx.models.api.matching.ui.hooks; - -/** An action performed in Javascript*/ -public class JsAction { - - /** - * Any data you want to be sent (in addition to document information) in the 'message' - * parameter for the window.postMessage() call. For more information see - * https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage - */ - public Object Data; - - /** - * The 'targetOrigin' parameter for the window.postMessage() call. For more information see - * https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage - *
NOTE: while this is optional, it is recommended for security purposes in the window.postMessage() protocol - */ - public String TargetOrigin; - - /** - * One of "parent" or "opener", depending if you use an iFrame to show the Matching UI - * in your system, or if you open it in a separate tab/window. - */ - public String Target; -} diff --git a/src/main/java/com/textkernel/tx/models/api/matching/ui/hooks/ServerSideHook.java b/src/main/java/com/textkernel/tx/models/api/matching/ui/hooks/ServerSideHook.java deleted file mode 100644 index 753fd794d..000000000 --- a/src/main/java/com/textkernel/tx/models/api/matching/ui/hooks/ServerSideHook.java +++ /dev/null @@ -1,19 +0,0 @@ -// Copyright © 2023 Textkernel BV. All rights reserved. -// This file is provided for use by, or on behalf of, Textkernel licensees -// within the terms of their license of Textkernel products or Textkernel customers -// within the Terms of Service pertaining to the Textkernel SaaS products. - -package com.textkernel.tx.models.api.matching.ui.hooks; - -/** A hook that does some server-side action (performs an HTTP POST to your server)*/ -public class ServerSideHook extends UserActionHook { - /** The URL for an HTTP POST call to perform some action in your system.*/ - public String Url; - - /** - * Any data from your system that you need to associate with this session/action. - * This is sent (in addition to document information) in the POST body. - *
For more information see https://developer.textkernel.com/tx-platform/v10/matching-ui/overview/#ui-match-hooks - */ - public Object CustomInfo; -} diff --git a/src/main/java/com/textkernel/tx/models/api/matching/ui/hooks/SourcingHook.java b/src/main/java/com/textkernel/tx/models/api/matching/ui/hooks/SourcingHook.java deleted file mode 100644 index d022eaa1d..000000000 --- a/src/main/java/com/textkernel/tx/models/api/matching/ui/hooks/SourcingHook.java +++ /dev/null @@ -1,12 +0,0 @@ -// Copyright © 2023 Textkernel BV. All rights reserved. -// This file is provided for use by, or on behalf of, Textkernel licensees -// within the terms of their license of Textkernel products or Textkernel customers -// within the Terms of Service pertaining to the Textkernel SaaS products. - -package com.textkernel.tx.models.api.matching.ui.hooks; - -/** A hook that does some server-side action for sourcing results (performs and HTTP POST to your server) - *
NOTE: Bulk actions are not supported for Sourcing hooks, yet. Setting {@link UserActionHook#IsBulk} will have no effect. - * */ -public class SourcingHook extends ServerSideHook { -} diff --git a/src/main/java/com/textkernel/tx/models/api/matching/ui/hooks/UrlAction.java b/src/main/java/com/textkernel/tx/models/api/matching/ui/hooks/UrlAction.java deleted file mode 100644 index 54f95eff5..000000000 --- a/src/main/java/com/textkernel/tx/models/api/matching/ui/hooks/UrlAction.java +++ /dev/null @@ -1,25 +0,0 @@ -// Copyright © 2023 Textkernel BV. All rights reserved. -// This file is provided for use by, or on behalf of, Textkernel licensees -// within the terms of their license of Textkernel products or Textkernel customers -// within the Terms of Service pertaining to the Textkernel SaaS products. - -package com.textkernel.tx.models.api.matching.ui.hooks; - -/** An action performed with a URL (opening a new window, displaying some webpage)*/ -public class UrlAction { - /** - * The URL to show (either in another tab/window or in an iFrame inside the Matching UI). - *
NOTE: the UI will do a string.replace() on this URL to replace {id} with the document - * id (that this action was performed on) and {indexId} with the index id (containing the document the action - * was performed on). - *
- * For example: https://my-ats.com/contact-info/{id} gets transformed to https://my-ats.com/contact-info/34879 - */ - public String Url; - - /** - * Use "tx" to open a popup inside the Matching UI and display the webpage. - * Any other value will be used just like the target attribute on a normal anchor tag ("_blank" for a new tab/window, etc). - */ - public String Target; -} diff --git a/src/main/java/com/textkernel/tx/models/api/matching/ui/hooks/UserActionHook.java b/src/main/java/com/textkernel/tx/models/api/matching/ui/hooks/UserActionHook.java deleted file mode 100644 index 970aa6e11..000000000 --- a/src/main/java/com/textkernel/tx/models/api/matching/ui/hooks/UserActionHook.java +++ /dev/null @@ -1,20 +0,0 @@ -// Copyright © 2023 Textkernel BV. All rights reserved. -// This file is provided for use by, or on behalf of, Textkernel licensees -// within the terms of their license of Textkernel products or Textkernel customers -// within the Terms of Service pertaining to the Textkernel SaaS products. - -package com.textkernel.tx.models.api.matching.ui.hooks; - -/** A base class for all 3 kinds of hooks*/ -public class UserActionHook { - /** Text to display on the button for the user action. */ - public String LinkText; - - /** - * Set to {@code true} to allow users to select multiple documents and perform this action on all of them at once. - *
NOTE: this can only be set to {@code true} when you use a {@link JsAction}. {@link UrlAction}s are not supported. - *
See https://developer.textkernel.com/tx-platform/v10/matching-ui/overview/#ui-match-hooks for more info. - *
This value is not supported for Sourcing hooks, yet - */ - public boolean IsBulk; -} diff --git a/src/main/java/com/textkernel/tx/models/api/matching/ui/hooks/UserActionHookCollection.java b/src/main/java/com/textkernel/tx/models/api/matching/ui/hooks/UserActionHookCollection.java deleted file mode 100644 index feac8088b..000000000 --- a/src/main/java/com/textkernel/tx/models/api/matching/ui/hooks/UserActionHookCollection.java +++ /dev/null @@ -1,34 +0,0 @@ -// Copyright © 2023 Textkernel BV. All rights reserved. -// This file is provided for use by, or on behalf of, Textkernel licensees -// within the terms of their license of Textkernel products or Textkernel customers -// within the Terms of Service pertaining to the Textkernel SaaS products. - -package com.textkernel.tx.models.api.matching.ui.hooks; - -import java.util.List; - -/** A collection of Matching UI User Action Hooks*/ -public class UserActionHookCollection { - /** - * The client-side User Action Hooks - * for a Matching UI session. These can be used to do some client-side action (opening a tab/window, running some javascript) - * when a user clicks a button on a particular match result. - */ - public List Client; - - /** - * The server-side (HTTP POST) - * User Action Hooks - * for a Matching UI session. These can be used to do some server-side action (performs an HTTP POST to your server) - * when a user clicks a button on a particular match result. - */ - public List Server; - - /** - * The server-side (HTTP POST) - * User Action Hooks - * for 'Sourcing' results during a Matching UI session. These can be used to do some server-side action (performs an HTTP POST to your server) - * when a user clicks a button on a particular 'Sourcing' result. - */ - public List Sourcing; -} diff --git a/src/main/java/com/textkernel/tx/models/api/matching/ui/request/GenerateUIRequest.java b/src/main/java/com/textkernel/tx/models/api/matching/ui/request/GenerateUIRequest.java deleted file mode 100644 index eb6d78715..000000000 --- a/src/main/java/com/textkernel/tx/models/api/matching/ui/request/GenerateUIRequest.java +++ /dev/null @@ -1,20 +0,0 @@ -// Copyright © 2023 Textkernel BV. All rights reserved. -// This file is provided for use by, or on behalf of, Textkernel licensees -// within the terms of their license of Textkernel products or Textkernel customers -// within the Terms of Service pertaining to the Textkernel SaaS products. - -package com.textkernel.tx.models.api.matching.ui.request; - -/** - * The request body for generating a Matching UI session - * @param The type of search/match to be performed in the session - * */ -public class GenerateUIRequest extends MatchUISettings { - /** The SaaS request that defines the match/search.*/ - public T SaasRequest; - - public GenerateUIRequest(T saasRequest, MatchUISettings settings) { - SaasRequest = saasRequest; - copyFrom(settings); - } -} diff --git a/src/main/java/com/textkernel/tx/models/api/matching/ui/request/MatchUISettings.java b/src/main/java/com/textkernel/tx/models/api/matching/ui/request/MatchUISettings.java deleted file mode 100644 index 53d63fbfe..000000000 --- a/src/main/java/com/textkernel/tx/models/api/matching/ui/request/MatchUISettings.java +++ /dev/null @@ -1,37 +0,0 @@ -// Copyright © 2023 Textkernel BV. All rights reserved. -// This file is provided for use by, or on behalf of, Textkernel licensees -// within the terms of their license of Textkernel products or Textkernel customers -// within the Terms of Service pertaining to the Textkernel SaaS products. - -package com.textkernel.tx.models.api.matching.ui.request; - -import com.textkernel.tx.models.api.geocoding.GeocodeOptions; -import com.textkernel.tx.models.api.matching.ui.UIOptions; -import com.textkernel.tx.models.api.parsing.BasicParseOptions; - -/** Settings for generating a Matching UI session*/ -public class MatchUISettings { - - /** Various options for the Matching UI user experience*/ - public UIOptions UIOptions; - - /** - * Options for parsing documents from external sources such as job boards - * and custom web sourcing. You only need to use this if you are using Sourcing - */ - public BasicParseOptions ParseOptions; - - /** - * Settings for geocoding within the Matching UI. This is used - * when you allow your users to perform radius filtering. - */ - public GeocodeOptions GeocodeOptions; - - void copyFrom(MatchUISettings other) { - if (other != null) { - UIOptions = other.UIOptions; - ParseOptions = other.ParseOptions; - GeocodeOptions = other.GeocodeOptions; - } - } -} diff --git a/src/main/java/com/textkernel/tx/models/api/matching/ui/request/UIBimetricScoreJobRequest.java b/src/main/java/com/textkernel/tx/models/api/matching/ui/request/UIBimetricScoreJobRequest.java deleted file mode 100644 index e826d1cb1..000000000 --- a/src/main/java/com/textkernel/tx/models/api/matching/ui/request/UIBimetricScoreJobRequest.java +++ /dev/null @@ -1,17 +0,0 @@ -// Copyright © 2023 Textkernel BV. All rights reserved. -// This file is provided for use by, or on behalf of, Textkernel licensees -// within the terms of their license of Textkernel products or Textkernel customers -// within the Terms of Service pertaining to the Textkernel SaaS products. - -package com.textkernel.tx.models.api.matching.ui.request; - -import com.textkernel.tx.models.api.bimetricscoring.BimetricScoreJobRequest; - -/** - * The request body for generating a Matching UI session - * */ -public class UIBimetricScoreJobRequest extends GenerateUIRequest { - public UIBimetricScoreJobRequest(BimetricScoreJobRequest request, MatchUISettings settings) { - super(request, settings); - } -} diff --git a/src/main/java/com/textkernel/tx/models/api/matching/ui/request/UIBimetricScoreResumeRequest.java b/src/main/java/com/textkernel/tx/models/api/matching/ui/request/UIBimetricScoreResumeRequest.java deleted file mode 100644 index f53a57d27..000000000 --- a/src/main/java/com/textkernel/tx/models/api/matching/ui/request/UIBimetricScoreResumeRequest.java +++ /dev/null @@ -1,17 +0,0 @@ -// Copyright © 2023 Textkernel BV. All rights reserved. -// This file is provided for use by, or on behalf of, Textkernel licensees -// within the terms of their license of Textkernel products or Textkernel customers -// within the Terms of Service pertaining to the Textkernel SaaS products. - -package com.textkernel.tx.models.api.matching.ui.request; - -import com.textkernel.tx.models.api.bimetricscoring.BimetricScoreResumeRequest; - -/** - * The request body for generating a Matching UI session - * */ -public class UIBimetricScoreResumeRequest extends GenerateUIRequest { - public UIBimetricScoreResumeRequest(BimetricScoreResumeRequest request, MatchUISettings settings) { - super(request, settings); - } -} diff --git a/src/main/java/com/textkernel/tx/models/api/matching/ui/request/UIMatchByDocumentIdOptions.java b/src/main/java/com/textkernel/tx/models/api/matching/ui/request/UIMatchByDocumentIdOptions.java deleted file mode 100644 index c5352ba04..000000000 --- a/src/main/java/com/textkernel/tx/models/api/matching/ui/request/UIMatchByDocumentIdOptions.java +++ /dev/null @@ -1,17 +0,0 @@ -// Copyright © 2023 Textkernel BV. All rights reserved. -// This file is provided for use by, or on behalf of, Textkernel licensees -// within the terms of their license of Textkernel products or Textkernel customers -// within the Terms of Service pertaining to the Textkernel SaaS products. - -package com.textkernel.tx.models.api.matching.ui.request; - -import com.textkernel.tx.models.api.matching.request.MatchByDocumentIdOptions; - -/** - * The request body for generating a Matching UI session - * */ -public class UIMatchByDocumentIdOptions extends GenerateUIRequest { - public UIMatchByDocumentIdOptions(MatchByDocumentIdOptions options, MatchUISettings settings) { - super(options, settings); - } -} diff --git a/src/main/java/com/textkernel/tx/models/api/matching/ui/request/UIMatchJobRequest.java b/src/main/java/com/textkernel/tx/models/api/matching/ui/request/UIMatchJobRequest.java deleted file mode 100644 index b3abf060b..000000000 --- a/src/main/java/com/textkernel/tx/models/api/matching/ui/request/UIMatchJobRequest.java +++ /dev/null @@ -1,17 +0,0 @@ -// Copyright © 2023 Textkernel BV. All rights reserved. -// This file is provided for use by, or on behalf of, Textkernel licensees -// within the terms of their license of Textkernel products or Textkernel customers -// within the Terms of Service pertaining to the Textkernel SaaS products. - -package com.textkernel.tx.models.api.matching.ui.request; - -import com.textkernel.tx.models.api.matching.MatchJobRequest; - -/** - * The request body for generating a Matching UI session - * */ -public class UIMatchJobRequest extends GenerateUIRequest { - public UIMatchJobRequest(MatchJobRequest request, MatchUISettings settings) { - super(request, settings); - } -} diff --git a/src/main/java/com/textkernel/tx/models/api/matching/ui/request/UIMatchResumeRequest.java b/src/main/java/com/textkernel/tx/models/api/matching/ui/request/UIMatchResumeRequest.java deleted file mode 100644 index a762685de..000000000 --- a/src/main/java/com/textkernel/tx/models/api/matching/ui/request/UIMatchResumeRequest.java +++ /dev/null @@ -1,17 +0,0 @@ -// Copyright © 2023 Textkernel BV. All rights reserved. -// This file is provided for use by, or on behalf of, Textkernel licensees -// within the terms of their license of Textkernel products or Textkernel customers -// within the Terms of Service pertaining to the Textkernel SaaS products. - -package com.textkernel.tx.models.api.matching.ui.request; - -import com.textkernel.tx.models.api.matching.MatchResumeRequest; - -/** - * The request body for generating a Matching UI session - * */ -public class UIMatchResumeRequest extends GenerateUIRequest { - public UIMatchResumeRequest(MatchResumeRequest request, MatchUISettings settings) { - super(request, settings); - } -} diff --git a/src/main/java/com/textkernel/tx/models/api/matching/ui/request/UISearchRequest.java b/src/main/java/com/textkernel/tx/models/api/matching/ui/request/UISearchRequest.java deleted file mode 100644 index b273152cd..000000000 --- a/src/main/java/com/textkernel/tx/models/api/matching/ui/request/UISearchRequest.java +++ /dev/null @@ -1,17 +0,0 @@ -// Copyright © 2023 Textkernel BV. All rights reserved. -// This file is provided for use by, or on behalf of, Textkernel licensees -// within the terms of their license of Textkernel products or Textkernel customers -// within the Terms of Service pertaining to the Textkernel SaaS products. - -package com.textkernel.tx.models.api.matching.ui.request; - -import com.textkernel.tx.models.api.matching.SearchRequest; - -/** - * The request body for generating a Matching UI session - * */ -public class UISearchRequest extends GenerateUIRequest { - public UISearchRequest(SearchRequest request, MatchUISettings settings) { - super(request, settings); - } -} diff --git a/src/main/java/com/textkernel/tx/models/api/parsing/ParseOptions.java b/src/main/java/com/textkernel/tx/models/api/parsing/ParseOptions.java index fcf5a0760..12c781c0c 100644 --- a/src/main/java/com/textkernel/tx/models/api/parsing/ParseOptions.java +++ b/src/main/java/com/textkernel/tx/models/api/parsing/ParseOptions.java @@ -7,8 +7,10 @@ import java.util.List; +import com.textkernel.tx.exceptions.TxUsableJobException; +import com.textkernel.tx.exceptions.TxUsableResumeException; import com.textkernel.tx.models.api.geocoding.GeocodeOptions; -import com.textkernel.tx.models.api.indexes.IndexSingleDocumentInfo; +import com.textkernel.tx.models.api.indexes.IndexingOptionsGeneric; /** Options for parsing */ public class ParseOptions extends BasicParseOptions { @@ -38,10 +40,13 @@ public class ParseOptions extends BasicParseOptions { public GeocodeOptions GeocodeOptions; /** - * If you are using AI Matching, use this property to also index the document after it is parsed/geocoded. - * This means you only need to send the document to our API once instead of twice for parsing+indexing. + * If you are using Search & Match, use this property to also index/upload the document after it is parsed/geocoded. + *

+ * NOTE: if you set this while parsing, you should try/catch for {@link TxUsableResumeException} or {@link TxUsableJobException} + * that are thrown when parsing was successful but an error occured during indexing + *

*/ - public IndexSingleDocumentInfo IndexingOptions; + public IndexingOptionsGeneric IndexingOptions; /** * Only used for resumes. When {@code true}, and the document is English, the LLM Parser will be used. diff --git a/src/main/java/com/textkernel/tx/services/AccountService.java b/src/main/java/com/textkernel/tx/services/AccountService.java new file mode 100644 index 000000000..d13e08566 --- /dev/null +++ b/src/main/java/com/textkernel/tx/services/AccountService.java @@ -0,0 +1,38 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx.services; + +import com.textkernel.tx.EnvironmentSettings; +import com.textkernel.tx.TxClient; +import com.textkernel.tx.exceptions.TxException; +import com.textkernel.tx.http.HttpResponse; +import com.textkernel.tx.models.api.account.GetAccountInfoResponse; + +import okhttp3.OkHttpClient; +import okhttp3.Request; + +/** See {@link TxClient#account()} */ +public class AccountService extends ServiceBase { + + /** See {@link TxClient#account()} */ + public AccountService(OkHttpClient httpClient, EnvironmentSettings settings) { + super(httpClient, settings); + } + + /** + * Get the account info (remaining credits, max concurrency, etc). + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public GetAccountInfoResponse getAccountInfo() throws TxException { + Request apiRequest = new Request.Builder() + .url(_endpoints.account()) + .build(); + + HttpResponse response = executeRequest(apiRequest, GetAccountInfoResponse.class, getBodyIfDebug(apiRequest)); + return response.getData(); + } +} diff --git a/src/main/java/com/textkernel/tx/services/ApiEndpoints.java b/src/main/java/com/textkernel/tx/services/ApiEndpoints.java new file mode 100644 index 000000000..7734e82b1 --- /dev/null +++ b/src/main/java/com/textkernel/tx/services/ApiEndpoints.java @@ -0,0 +1,107 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx.services; + +import java.util.List; + +import com.textkernel.tx.DataCenter; +import com.textkernel.tx.models.api.dataenrichment.TaxonomyFormat; + +public class ApiEndpoints { + + private DataCenter _dataCenter; + + ApiEndpoints(DataCenter dataCenter) { + if (dataCenter == null) { + throw new IllegalArgumentException("dataCenter cannot be null"); + } + _dataCenter = dataCenter; + } + + private static String sanitize(String indexOrDocId) throws IllegalArgumentException { + if (indexOrDocId == null || indexOrDocId.length() == 0) { + throw new IllegalArgumentException("Index or document id is null or empty"); + } + + for (char c : indexOrDocId.toCharArray()) { + //if its not a letter, digit, dash, or underscore, invalid + if (!(Character.isLetterOrDigit(c) || c == '-' || c == '_')) { + String charName = Character.isWhitespace(c) ? "whitespace" : String.valueOf(c); + throw new IllegalArgumentException("Index or document id contains an invalid character: " + charName); + } + } + + return indexOrDocId; + } + + String account() { return _dataCenter.Url + "/account"; } + String parseResume() { return _dataCenter.Url + "/parser/resume"; } + String parseJob() { return _dataCenter.Url + "/parser/joborder"; } + + String index(String id) { return _dataCenter.Url + "/index/" + sanitize(id); } + String indexDocumentCount(String id) { return _dataCenter.Url + "/index/" + sanitize(id) + "/count"; } + String allIndexes() { return _dataCenter.Url + "/index"; } + + String resume(String indexId, String docId) { return _dataCenter.Url + "/index/" + sanitize(indexId) + "/resume/" + sanitize(docId); } + String job(String indexId, String docId) { return _dataCenter.Url + "/index/" + sanitize(indexId) + "/joborder/" + sanitize(docId); } + String multipleResumes(String indexId) { return _dataCenter.Url + "/index/" + sanitize(indexId) + "/resumes"; } + String multipleJobs(String indexId) { return _dataCenter.Url + "/index/" + sanitize(indexId) + "/joborders"; } + String document(String indexId, String docId) { return _dataCenter.Url + "/index/" + sanitize(indexId) + "/documents/" + sanitize(docId); } + String multipleDocuments(String indexId) { return _dataCenter.Url + "/index/" + sanitize(indexId) + "/documents"; } + + String matchResume() { return _dataCenter.Url + "/matcher/resume"; } + String matchJob() { return _dataCenter.Url + "/matcher/joborder"; } + String matchDocId(String indexId, String docId) { return _dataCenter.Url + "/matcher/indexes/" + sanitize(indexId) + "/documents/" + sanitize(docId); } + String search() { return _dataCenter.Url + "/searcher"; } + + String bimetricScoreResume() { return _dataCenter.Url + "/scorer/bimetric/resume"; } + String bimetricScoreJob() { return _dataCenter.Url + "/scorer/bimetric/joborder"; } + + String geocodeResume() { return _dataCenter.Url + "/geocoder/resume"; } + String geocodeJob() { return _dataCenter.Url + "/geocoder/joborder"; } + String geocodeAndIndexResume() { return _dataCenter.Url + "/geocodeAndIndex/resume"; } + String geocodeAndIndexJob() { return _dataCenter.Url + "/geocodeAndIndex/joborder"; } + + static String DESVersion(boolean includeCerts) { return includeCerts ? "/v2" : ""; } + + String desSkillsGetTaxonomy(TaxonomyFormat format, boolean includeCerts) { return _dataCenter.Url + "/skills" + DESVersion(includeCerts) + "/taxonomy?format="+ format; } + String desSkillsGetMetadata(boolean includeCerts) { return _dataCenter.Url + "/skills" + DESVersion(includeCerts) + "/metadata"; } + String desSkillsNormalize(boolean includeCerts) { return _dataCenter.Url + "/skills" + DESVersion(includeCerts) + "/normalize"; } + String desSkillsExtract(boolean includeCerts) { return _dataCenter.Url + "/skills" + DESVersion(includeCerts) + "/extract"; } + String desSkillsLookup(boolean includeCerts) { return _dataCenter.Url + "/skills" + DESVersion(includeCerts) + "/lookup"; } + String desSkillsAutoComplete(boolean includeCerts) { return _dataCenter.Url + "/skills" + DESVersion(includeCerts) + "/autoComplete"; } + String desProfessionsGetTaxonomy(TaxonomyFormat format, String language) { return _dataCenter.Url + "/professions/taxonomy?format="+ format +"&language="+ language; } + String desProfessionsGetMetadata() { return _dataCenter.Url + "/professions/metadata"; } + String desProfessionsNormalize() { return _dataCenter.Url + "/professions/normalize"; } + String desProfessionsLookup() { return _dataCenter.Url + "/professions/lookup"; } + String desProfessionsAutoComplete() { return _dataCenter.Url + "/professions/autoComplete"; } + String desOntologySuggestSkillsFromProfessions(boolean includeCerts) { return _dataCenter.Url + "/ontology" + DESVersion(includeCerts) + "/suggest-skills-from-professions"; } + String desOntologySuggestSkillsFromSkills(boolean includeCerts) { return _dataCenter.Url + "/ontology" + DESVersion(includeCerts) + "/suggest-skills-from-skills"; } + String desOntologyCompareProfessions(boolean includeCerts) { return _dataCenter.Url + "/ontology" + DESVersion(includeCerts) + "/compare-professions"; } + String desOntologySuggestProfessions(boolean includeCerts) { return _dataCenter.Url + "/ontology" + DESVersion(includeCerts) + "/suggest-professions"; } + String desOntologyCompareSkillsToProfession(boolean includeCerts) { return _dataCenter.Url + "/ontology" + DESVersion(includeCerts) + "/compare-skills-to-profession"; } + String desOntologySkillsSimilarityScore(boolean includeCerts) { return _dataCenter.Url + "/ontology" + DESVersion(includeCerts) + "/skills-similarity-score"; } + + String jobDescriptionGenerate() { return _dataCenter.Url + "/job-description/generate"; } + String jobDescriptionSuggestSkills() { return _dataCenter.Url + "/job-description/suggest-skills"; } + + String formatResume() { return _dataCenter.Url + "/formatter/resume/template"; } + + String matchV2CandidatesAddDocument(String documentId) { return _dataCenter.Url + "/matchv2/candidates/" + documentId; } + String matchV2CandidatesDeleteDocuments(List documentIds, String env) { + return String.format("%s/matchv2/candidates?ids=%s&SearchAndMatchEnvironment=%s", _dataCenter.Url, String.join(",", documentIds), env); + } + String matchV2CandidatesSearch() { return _dataCenter.Url + "/matchv2/candidates/search"; } + String matchV2CandidatesMatchDocument() { return _dataCenter.Url + "/matchv2/candidates/match"; } + String matchV2CandidatesAutocomplete() { return _dataCenter.Url + "/matchv2/candidates/autocomplete"; } + String matchV2JobsAddDocument(String documentId) { return _dataCenter.Url + "/matchv2/vacancies/" + documentId; } + String matchV2JobsDeleteDocuments(List documentIds, String env) { + return String.format("%s/matchv2/vacancies?ids=%s&SearchAndMatchEnvironment=%s", _dataCenter.Url, String.join(",", documentIds), env); + } + String matchV2JobsSearch() { return _dataCenter.Url + "/matchv2/vacancies/search"; } + String matchV2JobsMatchDocument() { return _dataCenter.Url + "/matchv2/vacancies/match"; } + String matchV2JobsAutocomplete() { return _dataCenter.Url + "/matchv2/vacancies/autocomplete"; } +} diff --git a/src/main/java/com/textkernel/tx/services/FormatterService.java b/src/main/java/com/textkernel/tx/services/FormatterService.java new file mode 100644 index 000000000..d334da8b6 --- /dev/null +++ b/src/main/java/com/textkernel/tx/services/FormatterService.java @@ -0,0 +1,43 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx.services; + +import com.textkernel.tx.EnvironmentSettings; +import com.textkernel.tx.TxClient; +import com.textkernel.tx.exceptions.TxException; +import com.textkernel.tx.http.HttpResponse; +import com.textkernel.tx.models.api.formatter.FormatResumeRequest; +import com.textkernel.tx.models.api.formatter.FormatResumeResponse; + +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; + +/** See {@link TxClient#formatter()} */ +public class FormatterService extends ServiceBase { + + /** See {@link TxClient#formatter()} */ + public FormatterService(OkHttpClient httpClient, EnvironmentSettings settings) { + super(httpClient, settings); + } + + /** + * Format a resume into a standardized template that you provide + * @param request The request body + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public FormatResumeResponse formatResume(FormatResumeRequest request) throws TxException { + RequestBody body = createJsonBody(request); + Request apiRequest = new Request.Builder() + .url(_endpoints.formatResume()) + .post(body) + .build(); + + HttpResponse response = executeRequest(apiRequest, FormatResumeResponse.class, getBodyIfDebug(apiRequest)); + return response.getData(); + } +} diff --git a/src/main/java/com/textkernel/tx/services/GeocoderService.java b/src/main/java/com/textkernel/tx/services/GeocoderService.java new file mode 100644 index 000000000..297832ca7 --- /dev/null +++ b/src/main/java/com/textkernel/tx/services/GeocoderService.java @@ -0,0 +1,328 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx.services; + +import com.textkernel.tx.EnvironmentSettings; +import com.textkernel.tx.TxClient; +import com.textkernel.tx.exceptions.TxException; +import com.textkernel.tx.http.HttpResponse; +import com.textkernel.tx.models.GeoCoordinates; +import com.textkernel.tx.models.api.geocoding.Address; +import com.textkernel.tx.models.api.geocoding.GeocodeAndIndexJobRequest; +import com.textkernel.tx.models.api.geocoding.GeocodeAndIndexJobResponse; +import com.textkernel.tx.models.api.geocoding.GeocodeAndIndexJobResponseValue; +import com.textkernel.tx.models.api.geocoding.GeocodeAndIndexResumeRequest; +import com.textkernel.tx.models.api.geocoding.GeocodeAndIndexResumeResponse; +import com.textkernel.tx.models.api.geocoding.GeocodeAndIndexResumeResponseValue; +import com.textkernel.tx.models.api.geocoding.GeocodeCredentials; +import com.textkernel.tx.models.api.geocoding.GeocodeJobRequest; +import com.textkernel.tx.models.api.geocoding.GeocodeJobResponse; +import com.textkernel.tx.models.api.geocoding.GeocodeOptionsBase; +import com.textkernel.tx.models.api.geocoding.GeocodeProvider; +import com.textkernel.tx.models.api.geocoding.GeocodeResumeRequest; +import com.textkernel.tx.models.api.geocoding.GeocodeResumeResponse; +import com.textkernel.tx.models.api.indexes.IndexingOptionsGeneric; +import com.textkernel.tx.models.job.ParsedJob; +import com.textkernel.tx.models.resume.ParsedResume; + +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; + +/** See {@link TxClient#geocoder()} */ +public class GeocoderService extends ServiceBase { + + /** See {@link TxClient#geocoder()} */ + public GeocoderService(OkHttpClient httpClient, EnvironmentSettings settings) { + super(httpClient, settings); + } + + private GeocodeResumeResponse internalGeocode(ParsedResume resume, GeocodeCredentials geocodeCredentials, Address address) throws TxException { + GeocodeResumeRequest request = new GeocodeResumeRequest(); + request.ResumeData = resume; + request.Provider = geocodeCredentials != null ? geocodeCredentials.Provider : GeocodeProvider.Google; + request.ProviderKey = geocodeCredentials != null ? geocodeCredentials.ProviderKey : null; + request.PostalAddress = address; + + RequestBody body = createJsonBody(request); + Request apiRequest = new Request.Builder() + .url(_endpoints.geocodeResume()) + .post(body) + .build(); + + HttpResponse response = executeRequest(apiRequest, GeocodeResumeResponse.class, getBodyIfDebug(apiRequest)); + return response.getData(); + } + + private GeocodeJobResponse internalGeocode(ParsedJob job, GeocodeCredentials geocodeCredentials, Address address) throws TxException { + GeocodeJobRequest request = new GeocodeJobRequest(); + request.JobData = job; + request.Provider = geocodeCredentials != null ? geocodeCredentials.Provider : GeocodeProvider.Google; + request.ProviderKey = geocodeCredentials != null ? geocodeCredentials.ProviderKey : null; + request.PostalAddress = address; + + RequestBody body = createJsonBody(request); + Request apiRequest = new Request.Builder() + .url(_endpoints.geocodeJob()) + .post(body) + .build(); + + HttpResponse response = executeRequest(apiRequest, GeocodeJobResponse.class, getBodyIfDebug(apiRequest)); + return response.getData(); + } + + /** + * Uses the address in the resume (if present) to look up geocoordinates and add them into the ParsedResume object. + * These coordinates are used by the AI Searching/Matching engine. + * @param resume The resume to insert the geocoordinates (from the address) into + * @param geocodeCredentials - The credentials you want to use for geocoding (use {@code null} for built-in credentials) + * @return The API response body + * @throws TxException Thrown when an API error occurred + */ + public GeocodeResumeResponse geocode(ParsedResume resume, GeocodeCredentials geocodeCredentials) throws TxException { + return internalGeocode(resume, geocodeCredentials, null); + } + + /** + * Use this if you would like to provide an address for geocoding instead of using the one in the parsed + * resume. The address included in the parsed resume (if present) will not be modified. + * @param resume The resume to insert the geocoordinates (from the address) into + * @param address The address to use to retrieve geocoordinates + * @param geocodeCredentials - The credentials you want to use for geocoding (use {@code null} for built-in credentials) + * @return The API response body + * @throws TxException Thrown when an API error occurred + */ + public GeocodeResumeResponse geocode(ParsedResume resume, Address address, GeocodeCredentials geocodeCredentials) throws TxException { + return internalGeocode(resume, geocodeCredentials, address); + } + + /** + * Uses the address in the job (if present) to look up geocoordinates and add them into the ParsedJob object. + * These coordinates are used by the AI Searching/Matching engine. + * @param job The job to insert the geocoordinates (from the address) into + * @param geocodeCredentials - The credentials you want to use for geocoding (use {@code null} for built-in credentials) + * @return The API response body + * @throws TxException Thrown when an API error occurred + */ + public GeocodeJobResponse geocode(ParsedJob job, GeocodeCredentials geocodeCredentials) throws TxException { + return internalGeocode(job, geocodeCredentials, null); + } + + /** + * Use this if you would like to provide an address for geocoding instead of using the one in the parsed + * job. The address included in the parsed job (if present) will not be modified. + * @param job The job to insert the geocoordinates (from the address) into + * @param address The address to use to retrieve geocoordinates + * @param geocodeCredentials - The credentials you want to use for geocoding (use {@code null} for built-in credentials) + * @return The API response body + * @throws TxException Thrown when an API error occurred + */ + public GeocodeJobResponse geocode(ParsedJob job, Address address, GeocodeCredentials geocodeCredentials) throws TxException { + return internalGeocode(job, geocodeCredentials, address); + } + + private GeocodeAndIndexResumeResponse internalGeocodeAndIndex( + ParsedResume resume, + GeocodeCredentials geocodeCredentials, + IndexingOptionsGeneric indexingOptions, + boolean indexIfGeocodeFails, + Address address, + GeoCoordinates coordinates) throws TxException { + + setEnvironment(indexingOptions); + + GeocodeOptionsBase options = new GeocodeOptionsBase(); + options.Provider = geocodeCredentials != null ? geocodeCredentials.Provider : GeocodeProvider.Google; + options.ProviderKey = geocodeCredentials != null ? geocodeCredentials.ProviderKey : null; + options.PostalAddress = address; + options.GeoCoordinates = coordinates; + + GeocodeAndIndexResumeRequest request = new GeocodeAndIndexResumeRequest(); + request.ResumeData = resume; + request.GeocodeOptions = options; + request.IndexingOptions = indexingOptions; + request.IndexIfGeocodeFails = indexIfGeocodeFails; + + RequestBody body = createJsonBody(request); + Request apiRequest = new Request.Builder() + .url(_endpoints.geocodeAndIndexResume()) + .post(body) + .build(); + + HttpResponse response = executeRequest(apiRequest, GeocodeAndIndexResumeResponse.class, getBodyIfDebug(apiRequest)); + GeocodeAndIndexResumeResponseValue responseVal = response.getData().Value; + + if (!indexIfGeocodeFails && responseVal.GeocodeResponse != null && !responseVal.GeocodeResponse.isSuccess()) { + throw new TxException(getBodyIfDebug(apiRequest), response.getResponse(), responseVal.GeocodeResponse, response.getData().getInfo().TransactionId); + } + + if (responseVal.IndexingResponse != null && !responseVal.IndexingResponse.isSuccess()) { + throw new TxException(getBodyIfDebug(apiRequest), response.getResponse(), responseVal.IndexingResponse, response.getData().getInfo().TransactionId); + } + + return response.getData(); + } + + private GeocodeAndIndexJobResponse internalGeocodeAndIndex( + ParsedJob job, + GeocodeCredentials geocodeCredentials, + IndexingOptionsGeneric indexingOptions, + boolean indexIfGeocodeFails, + Address address, + GeoCoordinates coordinates) throws TxException { + + setEnvironment(indexingOptions); + + GeocodeOptionsBase options = new GeocodeOptionsBase(); + options.Provider = geocodeCredentials != null ? geocodeCredentials.Provider : GeocodeProvider.Google; + options.ProviderKey = geocodeCredentials != null ? geocodeCredentials.ProviderKey : null; + options.PostalAddress = address; + options.GeoCoordinates = coordinates; + + GeocodeAndIndexJobRequest request = new GeocodeAndIndexJobRequest(); + request.JobData = job; + request.GeocodeOptions = options; + request.IndexingOptions = indexingOptions; + request.IndexIfGeocodeFails = indexIfGeocodeFails; + + RequestBody body = createJsonBody(request); + Request apiRequest = new Request.Builder() + .url(_endpoints.geocodeAndIndexJob()) + .post(body) + .build(); + + HttpResponse response = executeRequest(apiRequest, GeocodeAndIndexJobResponse.class, getBodyIfDebug(apiRequest)); + GeocodeAndIndexJobResponseValue responseVal = response.getData().Value; + + if (!indexIfGeocodeFails && responseVal.GeocodeResponse != null && !responseVal.GeocodeResponse.isSuccess()) { + throw new TxException(getBodyIfDebug(apiRequest), response.getResponse(), responseVal.GeocodeResponse, response.getData().getInfo().TransactionId); + } + + if (responseVal.IndexingResponse != null && !responseVal.IndexingResponse.isSuccess()) { + throw new TxException(getBodyIfDebug(apiRequest), response.getResponse(), responseVal.IndexingResponse, response.getData().getInfo().TransactionId); + } + + return response.getData(); + } + + /** + * Uses the address in the resume (if present) to look up geocoordinates and add them into the ParsedResume object. + * These coordinates are used by the AI Searching/Matching engine. + * @param resume The resume to geocode + * @param indexingOptions What index/document id to use to index the document after geocoding + * @param indexIfGeocodeFails Indicates whether or not the document should still be added to the index if the geocode request fails. + * @param geocodeCredentials - The credentials you want to use for geocoding (use {@code null} for built-in credentials) + * @return The API response body + * @throws TxException Thrown when an API error occurred + */ + public GeocodeAndIndexResumeResponse geocodeAndIndex( + ParsedResume resume, + IndexingOptionsGeneric indexingOptions, + boolean indexIfGeocodeFails, + GeocodeCredentials geocodeCredentials) throws TxException { + return internalGeocodeAndIndex(resume, geocodeCredentials, indexingOptions, indexIfGeocodeFails, null, null); + } + + /** + * Use this if you would like to provide an address for geocoding instead of using the one in the parsed + * resume. The address included in the parsed resume (if present) will not be modified. + * @param resume The resume to insert the geocoordinates (from the address) into + * @param indexingOptions What index/document id to use to index the document after geocoding + * @param address The address to use to retrieve geocoordinates + * @param indexIfGeocodeFails Indicates whether or not the document should still be added to the index if the geocode request fails. + * @param geocodeCredentials - The credentials you want to use for geocoding (use {@code null} for built-in credentials) + * @return The API response body + * @throws TxException Thrown when an API error occurred + */ + public GeocodeAndIndexResumeResponse geocodeAndIndex( + ParsedResume resume, + IndexingOptionsGeneric indexingOptions, + Address address, + boolean indexIfGeocodeFails, + GeocodeCredentials geocodeCredentials) throws TxException { + return internalGeocodeAndIndex(resume, geocodeCredentials, indexingOptions, indexIfGeocodeFails, address, null); + } + + /** + * Use this if you already have latitude/longitude coordinates and simply wish to add them to your parsed resume. + * The coordinates will be inserted into your parsed resume, and the address included in the + * parsed resume (if present) will not be modified. + * @param resume The resume to insert the geocoordinates into + * @param indexingOptions What index/document id to use to index the document after geocoding + * @param coordinates The geocoordinates to use + * @param indexIfGeocodeFails Indicates whether or not the document should still be added to the index if the geocode request fails. + * @param geocodeCredentials - The credentials you want to use for geocoding (use {@code null} for built-in credentials) + * @return The API response body + * @throws TxException Thrown when an API error occurred + */ + public GeocodeAndIndexResumeResponse geocodeAndIndex( + ParsedResume resume, + IndexingOptionsGeneric indexingOptions, + GeoCoordinates coordinates, + boolean indexIfGeocodeFails, + GeocodeCredentials geocodeCredentials) throws TxException { + return internalGeocodeAndIndex(resume, geocodeCredentials, indexingOptions, indexIfGeocodeFails, null, coordinates); + } + + /** + * Uses the address in the job (if present) to look up geocoordinates and add them into the ParsedJob object. + * These coordinates are used by the AI Searching/Matching engine. + * @param job The job to geocode + * @param indexingOptions What index/document id to use to index the document after geocoding + * @param indexIfGeocodeFails Indicates whether or not the document should still be added to the index if the geocode request fails. + * @param geocodeCredentials - The credentials you want to use for geocoding (use {@code null} for built-in credentials) + * @return The API response body + * @throws TxException Thrown when an API error occurred + */ + public GeocodeAndIndexJobResponse geocodeAndIndex( + ParsedJob job, + IndexingOptionsGeneric indexingOptions, + boolean indexIfGeocodeFails, + GeocodeCredentials geocodeCredentials) throws TxException { + return internalGeocodeAndIndex(job, geocodeCredentials, indexingOptions, indexIfGeocodeFails, null, null); + } + + /** + * Use this if you would like to provide an address for geocoding instead of using the one in the parsed + * rjobesume. The address included in the parsed job (if present) will not be modified. + * @param job The job to insert the geocoordinates (from the address) into + * @param indexingOptions What index/document id to use to index the document after geocoding + * @param address The address to use to retrieve geocoordinates + * @param indexIfGeocodeFails Indicates whether or not the document should still be added to the index if the geocode request fails. + * @param geocodeCredentials - The credentials you want to use for geocoding (use {@code null} for built-in credentials) + * @return The API response body + * @throws TxException Thrown when an API error occurred + */ + public GeocodeAndIndexJobResponse geocodeAndIndex( + ParsedJob job, + IndexingOptionsGeneric indexingOptions, + Address address, + boolean indexIfGeocodeFails, + GeocodeCredentials geocodeCredentials) throws TxException { + return internalGeocodeAndIndex(job, geocodeCredentials, indexingOptions, indexIfGeocodeFails, address, null); + } + + /** + * Use this if you already have latitude/longitude coordinates and simply wish to add them to your parsed job. + * The coordinates will be inserted into your parsed job, and the address included in the + * parsed job (if present) will not be modified. + * @param job The job to insert the geocoordinates into + * @param indexingOptions What index/document id to use to index the document after geocoding + * @param coordinates The geocoordinates to use + * @param indexIfGeocodeFails Indicates whether or not the document should still be added to the index if the geocode request fails. + * @param geocodeCredentials - The credentials you want to use for geocoding (use {@code null} for built-in credentials) + * @return The API response body + * @throws TxException Thrown when an API error occurred + */ + public GeocodeAndIndexJobResponse geocodeAndIndex( + ParsedJob job, + IndexingOptionsGeneric indexingOptions, + GeoCoordinates coordinates, + boolean indexIfGeocodeFails, + GeocodeCredentials geocodeCredentials) throws TxException { + return internalGeocodeAndIndex(job, geocodeCredentials, indexingOptions, indexIfGeocodeFails, null, coordinates); + } +} diff --git a/src/main/java/com/textkernel/tx/services/MatchV2Service.java b/src/main/java/com/textkernel/tx/services/MatchV2Service.java new file mode 100644 index 000000000..caddeb828 --- /dev/null +++ b/src/main/java/com/textkernel/tx/services/MatchV2Service.java @@ -0,0 +1,245 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx.services; + +import java.util.List; +import java.util.Map; + +import com.textkernel.tx.EnvironmentSettings; +import com.textkernel.tx.TxClient; +import com.textkernel.tx.exceptions.TxException; +import com.textkernel.tx.http.HttpResponse; +import com.textkernel.tx.models.api.matchV2.autocomplete.AutocompleteCandidatesField; +import com.textkernel.tx.models.api.matchV2.autocomplete.AutocompleteJobsField; +import com.textkernel.tx.models.api.matchV2.autocomplete.AutocompleteRequest; +import com.textkernel.tx.models.api.matchV2.autocomplete.AutocompleteResponse; +import com.textkernel.tx.models.api.matchV2.documents.AddCandidateRequest; +import com.textkernel.tx.models.api.matchV2.documents.AddCandidateResponse; +import com.textkernel.tx.models.api.matchV2.documents.AddJobRequest; +import com.textkernel.tx.models.api.matchV2.documents.AddJobResponse; +import com.textkernel.tx.models.api.matchV2.documents.DeleteDocumentsResponse; +import com.textkernel.tx.models.api.matchV2.documents.DocumentSource; +import com.textkernel.tx.models.api.matchV2.querying.MatchRequest; +import com.textkernel.tx.models.api.matchV2.querying.Options; +import com.textkernel.tx.models.api.matchV2.querying.SearchQuery; +import com.textkernel.tx.models.api.matchV2.querying.SearchResponse; +import com.textkernel.tx.models.job.ParsedJob; +import com.textkernel.tx.models.resume.ParsedResume; + +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; + +/** See {@link TxClient#searchMatchV2()} */ +public class MatchV2Service extends ServiceBase { + + /** See {@link TxClient#searchMatchV2()} */ + public MatchV2Service(OkHttpClient httpClient, EnvironmentSettings settings) { + super(httpClient, settings); + } + + /** + * Upload a candidates CV to the search and match V2 environment. + * @param documentId The id to use for the document + * @param resume Parsed output from the Textkernel CV/Resume Parser + * @param roles (optional) The roles associated with the request. Defaults to ["All"] if none are provided. + * @param anonymize (optional) A boolean flag to strip PII data out of the resume before indexing + * @param customFields (optional) A collection of custom fields represented as key-value pairs + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public AddCandidateResponse addCandidate(String documentId, ParsedResume resume, List roles, boolean anonymize, Map customFields) throws TxException { + AddCandidateRequest request = new AddCandidateRequest(); + request.Anonymize = anonymize; + request.ResumeData = resume; + request.Roles = roles; + request.SearchAndMatchEnvironment = _settings.MatchV2Environment; + request.CustomFields = customFields; + + RequestBody body = createJsonBody(request); + Request apiRequest = new Request.Builder() + .url(_endpoints.matchV2CandidatesAddDocument(documentId)) + .post(body) + .build(); + + HttpResponse response = executeRequest(apiRequest, AddCandidateResponse.class, getBodyIfDebug(apiRequest)); + return response.getData(); + } + + /** + * Upload a job to the search and match V2 environment. + * @param documentId The id to use for the document + * @param resume Parsed output from the Textkernel Job Parser + * @param roles (optional) The roles associated with the request. Defaults to ["All"] if none are provided. + * @param customFields (optional) A collection of custom fields represented as key-value pairs + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public AddJobResponse addJob(String documentId, ParsedJob job, List roles, Map customFields) throws TxException { + AddJobRequest request = new AddJobRequest(); + request.JobData = job; + request.Roles = roles; + request.SearchAndMatchEnvironment = _settings.MatchV2Environment; + request.CustomFields = customFields; + + RequestBody body = createJsonBody(request); + Request apiRequest = new Request.Builder() + .url(_endpoints.matchV2JobsAddDocument(documentId)) + .post(body) + .build(); + + HttpResponse response = executeRequest(apiRequest, AddJobResponse.class, getBodyIfDebug(apiRequest)); + return response.getData(); + } + + /** + * Delete candidate documents from environment + * @param documentIds The document IDs to delete + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public DeleteDocumentsResponse deleteCandidates(List documentIds) throws TxException { + Request apiRequest = new Request.Builder() + .url(_endpoints.matchV2CandidatesDeleteDocuments(documentIds, _settings.MatchV2Environment.toString())) + .delete() + .build(); + + HttpResponse response = executeRequest(apiRequest, DeleteDocumentsResponse.class, getBodyIfDebug(apiRequest)); + return response.getData(); + } + + /** + * Delete job documents from environment + * @param documentIds The document IDs to delete + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public DeleteDocumentsResponse deleteJobs(List documentIds) throws TxException { + Request apiRequest = new Request.Builder() + .url(_endpoints.matchV2JobsDeleteDocuments(documentIds, _settings.MatchV2Environment.toString())) + .delete() + .build(); + + HttpResponse response = executeRequest(apiRequest, DeleteDocumentsResponse.class, getBodyIfDebug(apiRequest)); + return response.getData(); + } + + private SearchResponse matchInternal(Options options, SearchQuery query, DocumentSource sourceDocument, String url) throws TxException { + MatchRequest request = new MatchRequest(); + request.Options = options; + request.SearchAndMatchEnvironment = _settings.MatchV2Environment; + request.Query = query; + request.SourceDocument = sourceDocument; + + RequestBody body = createJsonBody(request); + Request apiRequest = new Request.Builder() + .url(url) + .post(body) + .build(); + + HttpResponse response = executeRequest(apiRequest, SearchResponse.class, getBodyIfDebug(apiRequest)); + return response.getData(); + } + + private SearchResponse searchInternal(Options options, SearchQuery query, String url) throws TxException { + return matchInternal(options, query, null, url); + } + + /** + * Match an existing candidate document with filters provided. + * @param sourceDocument The document to generate the search query from + * @param options Options for the Match request + * @param query (optional) The query object that will be combined with the match query to drive the search + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public SearchResponse matchCandidates(DocumentSource sourceDocument, Options options, SearchQuery query) throws TxException { + return matchInternal(options, query, sourceDocument, _endpoints.matchV2CandidatesMatchDocument()); + } + + /** + * Match an existing job document with filters provided. + * @param sourceDocument The document to generate the search query from + * @param options Options for the Match request + * @param query (optional) The query object that will be combined with the match query to drive the search + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public SearchResponse matchJobs(DocumentSource sourceDocument, Options options, SearchQuery query) throws TxException { + return matchInternal(options, query, sourceDocument, _endpoints.matchV2JobsMatchDocument()); + } + + /** + * Search for a candidate based on the query provided. + * @param query The query object that will drive the search. + * @param options Options for the search request + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public SearchResponse searchCandidates(SearchQuery query, Options options) throws TxException { + return searchInternal(options, query, _endpoints.matchV2CandidatesSearch()); + } + + /** + * Search for a job based on the query provided. + * @param query The query object that will drive the search. + * @param options Options for the search request + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public SearchResponse searchJobs(SearchQuery query, Options options) throws TxException { + return searchInternal(options, query, _endpoints.matchV2JobsSearch()); + } + + private AutocompleteResponse autocompleteInternal(String url, T field, String input, String... languages) throws TxException { + AutocompleteRequest request = new AutocompleteRequest(); + request.Field = field; + request.Input = input; + request.SearchAndMatchEnvironment = _settings.MatchV2Environment; + request.Language = String.join(",", languages); + + RequestBody body = createJsonBody(request); + Request apiRequest = new Request.Builder() + .url(url) + .post(body) + .build(); + + HttpResponse response = executeRequest(apiRequest, AutocompleteResponse.class, getBodyIfDebug(apiRequest)); + return response.getData(); + } + + /** + * Returns a list of suggested Completions. This endpoint is used to give a user instant + * feedback while typing a query. If the given field is the FULLTEXT field, the service + * returns suggestions from all configured dictionaries that are not explicitly excluded from full-text suggestions. + * @param field Which field to use to retrieve completions + * @param input The user-typed input string + * @param languages + * Optional 2-letter ISO-639-1 language codes. The first language is used for field label translations. + * All languages are used to retrieve completions when the environment doesn't have default languages set. + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public AutocompleteResponse autocompleteCandidates(AutocompleteCandidatesField field, String input, String... languages) throws TxException { + return autocompleteInternal(_endpoints.matchV2CandidatesAutocomplete(), field, input, languages); + } + + /** + * Returns a list of suggested Completions. This endpoint is used to give a user instant + * feedback while typing a query. If the given field is the FULLTEXT field, the service + * returns suggestions from all configured dictionaries that are not explicitly excluded from full-text suggestions. + * @param field Which field to use to retrieve completions + * @param input The user-typed input string + * @param languages + * Optional 2-letter ISO-639-1 language codes. The first language is used for field label translations. + * All languages are used to retrieve completions when the environment doesn't have default languages set. + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public AutocompleteResponse autocompleteJobs(AutocompleteJobsField field, String input, String... languages) throws TxException { + return autocompleteInternal(_endpoints.matchV2JobsAutocomplete(), field, input, languages); + } +} diff --git a/src/main/java/com/textkernel/tx/services/ParserService.java b/src/main/java/com/textkernel/tx/services/ParserService.java new file mode 100644 index 000000000..ed23eb1b5 --- /dev/null +++ b/src/main/java/com/textkernel/tx/services/ParserService.java @@ -0,0 +1,96 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx.services; + +import com.textkernel.tx.EnvironmentSettings; +import com.textkernel.tx.TxClient; +import com.textkernel.tx.exceptions.TxException; +import com.textkernel.tx.exceptions.TxGeocodeJobException; +import com.textkernel.tx.exceptions.TxGeocodeResumeException; +import com.textkernel.tx.exceptions.TxIndexJobException; +import com.textkernel.tx.exceptions.TxIndexResumeException; +import com.textkernel.tx.http.HttpResponse; +import com.textkernel.tx.models.api.parsing.ParseJobResponse; +import com.textkernel.tx.models.api.parsing.ParseRequest; +import com.textkernel.tx.models.api.parsing.ParseResumeResponse; + +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; + +/** See {@link TxClient#parser()} */ +public class ParserService extends ServiceBase { + + /** See {@link TxClient#parser()} */ + public ParserService(OkHttpClient httpClient, EnvironmentSettings settings) { + super(httpClient, settings); + } + + /** + * Parse a resume + * @param request The request body + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public ParseResumeResponse parseResume(ParseRequest request) throws TxException { + + setEnvironment(request.IndexingOptions); + + RequestBody body = createJsonBody(request); + Request apiRequest = new Request.Builder() + .url(_endpoints.parseResume()) + .post(body) + .build(); + + HttpResponse response = executeRequest(apiRequest, ParseResumeResponse.class, getBodyIfDebug(apiRequest)); + + if (response.getData().Value.ParsingResponse != null && !response.getData().Value.ParsingResponse.isSuccess()) { + throw new TxException(getBodyIfDebug(apiRequest), response.getResponse(), response.getData().Value.ParsingResponse, response.getData().Info.TransactionId); + } + + if (response.getData().Value.GeocodeResponse != null && !response.getData().Value.GeocodeResponse.isSuccess()) { + throw new TxGeocodeResumeException(response.getResponse(), response.getData().Value.GeocodeResponse, response.getData().Info.TransactionId, response.getData()); + } + + if (response.getData().Value.IndexingResponse != null && !response.getData().Value.IndexingResponse.isSuccess()) { + throw new TxIndexResumeException(response.getResponse(), response.getData().Value.IndexingResponse, response.getData().Info.TransactionId, response.getData()); + } + + return response.getData(); + } + + /** + * Parse a job + * @param request The request body + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public ParseJobResponse parseJob(ParseRequest request) throws TxException { + setEnvironment(request.IndexingOptions); + + RequestBody body = createJsonBody(request); + Request apiRequest = new Request.Builder() + .url(_endpoints.parseJob()) + .post(body) + .build(); + + HttpResponse response = executeRequest(apiRequest, ParseJobResponse.class, getBodyIfDebug(apiRequest)); + + if (response.getData().Value.ParsingResponse != null && !response.getData().Value.ParsingResponse.isSuccess()) { + throw new TxException(getBodyIfDebug(apiRequest), response.getResponse(), response.getData().Value.ParsingResponse, response.getData().Info.TransactionId); + } + + if (response.getData().Value.GeocodeResponse != null && !response.getData().Value.GeocodeResponse.isSuccess()) { + throw new TxGeocodeJobException(response.getResponse(), response.getData().Value.GeocodeResponse, response.getData().Info.TransactionId, response.getData()); + } + + if (response.getData().Value.IndexingResponse != null && !response.getData().Value.IndexingResponse.isSuccess()) { + throw new TxIndexJobException(response.getResponse(), response.getData().Value.IndexingResponse, response.getData().Info.TransactionId, response.getData()); + } + + return response.getData(); + } +} diff --git a/src/main/java/com/textkernel/tx/services/SearchMatchService.java b/src/main/java/com/textkernel/tx/services/SearchMatchService.java new file mode 100644 index 000000000..0c0ffb61d --- /dev/null +++ b/src/main/java/com/textkernel/tx/services/SearchMatchService.java @@ -0,0 +1,615 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx.services; + +import java.util.List; + +import com.textkernel.tx.EnvironmentSettings; +import com.textkernel.tx.TxClient; +import com.textkernel.tx.exceptions.TxException; +import com.textkernel.tx.http.HttpResponse; +import com.textkernel.tx.models.api.bimetricscoring.BimetricScoreJobRequest; +import com.textkernel.tx.models.api.bimetricscoring.BimetricScoreResponse; +import com.textkernel.tx.models.api.bimetricscoring.BimetricScoreResumeRequest; +import com.textkernel.tx.models.api.bimetricscoring.IParsedDocWithId; +import com.textkernel.tx.models.api.bimetricscoring.ParsedJobWithId; +import com.textkernel.tx.models.api.bimetricscoring.ParsedResumeWithId; +import com.textkernel.tx.models.api.indexes.CreateIndexRequest; +import com.textkernel.tx.models.api.indexes.CreateIndexResponse; +import com.textkernel.tx.models.api.indexes.DeleteDocumentResponse; +import com.textkernel.tx.models.api.indexes.DeleteIndexResponse; +import com.textkernel.tx.models.api.indexes.DeleteMultipleDocumentsRequest; +import com.textkernel.tx.models.api.indexes.DeleteMultipleDocumentsResponse; +import com.textkernel.tx.models.api.indexes.GetAllIndexesResponse; +import com.textkernel.tx.models.api.indexes.GetJobResponse; +import com.textkernel.tx.models.api.indexes.GetResumeResponse; +import com.textkernel.tx.models.api.indexes.IndexDocumentResponse; +import com.textkernel.tx.models.api.indexes.IndexJobInfo; +import com.textkernel.tx.models.api.indexes.IndexJobRequest; +import com.textkernel.tx.models.api.indexes.IndexMultipleDocumentsResponse; +import com.textkernel.tx.models.api.indexes.IndexMultipleJobsRequest; +import com.textkernel.tx.models.api.indexes.IndexMultipleResumesRequest; +import com.textkernel.tx.models.api.indexes.IndexResumeInfo; +import com.textkernel.tx.models.api.indexes.IndexResumeRequest; +import com.textkernel.tx.models.api.indexes.UpdateUserDefinedTagsRequest; +import com.textkernel.tx.models.api.indexes.UpdateUserDefinedTagsResponse; +import com.textkernel.tx.models.api.indexes.UserDefinedTagsMethod; +import com.textkernel.tx.models.api.matching.CategoryWeights; +import com.textkernel.tx.models.api.matching.MatchJobRequest; +import com.textkernel.tx.models.api.matching.MatchResponse; +import com.textkernel.tx.models.api.matching.MatchResumeRequest; +import com.textkernel.tx.models.api.matching.SearchRequest; +import com.textkernel.tx.models.api.matching.SearchResponse; +import com.textkernel.tx.models.api.matching.request.FilterCriteria; +import com.textkernel.tx.models.api.matching.request.MatchByDocumentIdOptions; +import com.textkernel.tx.models.api.matching.request.PaginationSettings; +import com.textkernel.tx.models.api.matching.request.SearchMatchSettings; +import com.textkernel.tx.models.job.ParsedJob; +import com.textkernel.tx.models.matching.IndexType; +import com.textkernel.tx.models.resume.ParsedResume; + +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; + +/** See {@link TxClient#searchMatchV1()} */ +public class SearchMatchService extends ServiceBase { + + /** See {@link TxClient#searchMatchV1()} */ + public SearchMatchService(OkHttpClient httpClient, EnvironmentSettings settings) { + super(httpClient, settings); + } + + /** + * Create a new index + * @param type The type of documents stored in this index. Either 'Resume' or 'Job' + * @param indexId + * The ID to assign to the new index. This is restricted to alphanumeric with dashes + * and underscores. All values will be converted to lower-case. + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public CreateIndexResponse createIndex(IndexType type, String indexId) throws TxException { + CreateIndexRequest request = new CreateIndexRequest(); + request.IndexType = type; + + RequestBody body = createJsonBody(request); + Request apiRequest = new Request.Builder() + .url(_endpoints.index(indexId)) + .post(body) + .build(); + + HttpResponse response = executeRequest(apiRequest, CreateIndexResponse.class, getBodyIfDebug(apiRequest)); + return response.getData(); + } + + /** + * Get all existing indexes + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public GetAllIndexesResponse getAllIndexes() throws TxException { + Request apiRequest = new Request.Builder() + .url(_endpoints.allIndexes()) + .build(); + + HttpResponse response = executeRequest(apiRequest, GetAllIndexesResponse.class, getBodyIfDebug(apiRequest)); + return response.getData(); + } + + /** + * Delete an existing index. Note that this is a destructive action and cannot be undone. + * All the documents in this index will be deleted. + * @param indexId The index to delete (case-insensitive). + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public DeleteIndexResponse deleteIndex(String indexId) throws TxException { + Request apiRequest = new Request.Builder() + .url(_endpoints.index(indexId)) + .delete() + .build(); + + HttpResponse response = executeRequest(apiRequest, DeleteIndexResponse.class, getBodyIfDebug(apiRequest)); + return response.getData(); + } + + /** + * Add a resume to an existing index + * @param resume A resume generated by the Resume Parser + * @param indexId The index the document should be added into (case-insensitive). + * @param documentId + * The ID to assign to the new document. This is restricted to alphanumeric + * with dashes and underscores. All values will be converted to lower-case. + * @param userDefinedTags The user-defined tags that the resume should have, or {@code null} + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public IndexDocumentResponse indexDocument( + ParsedResume resume, + String indexId, + String documentId, + List userDefinedTags) throws TxException { + IndexResumeRequest request = new IndexResumeRequest(); + request.ResumeData = resume; + request.UserDefinedTags = userDefinedTags; + + RequestBody body = createJsonBody(request); + Request apiRequest = new Request.Builder() + .url(_endpoints.resume(indexId, documentId)) + .post(body) + .build(); + + HttpResponse response = executeRequest(apiRequest, IndexDocumentResponse.class, getBodyIfDebug(apiRequest)); + return response.getData(); + } + + /** + * Add a job to an existing index + * @param job A job generated by the Job Parser + * @param indexId The index the document should be added into (case-insensitive). + * @param documentId + * The ID to assign to the new document. This is restricted to alphanumeric + * with dashes and underscores. All values will be converted to lower-case. + * @param userDefinedTags The user-defined tags that the resume should have, or {@code null} + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public IndexDocumentResponse indexDocument( + ParsedJob job, + String indexId, + String documentId, + List userDefinedTags) throws TxException { + IndexJobRequest request = new IndexJobRequest(); + request.JobData = job; + request.UserDefinedTags = userDefinedTags; + + RequestBody body = createJsonBody(request); + Request apiRequest = new Request.Builder() + .url(_endpoints.job(indexId, documentId)) + .post(body) + .build(); + + HttpResponse response = executeRequest(apiRequest, IndexDocumentResponse.class, getBodyIfDebug(apiRequest)); + return response.getData(); + } + + /** + * Add several resumes to an existing index + * @param resumes The resumes generated by the Resume Parser paired with their DocumentIds + * @param indexId The index the documents should be added into (case-insensitive). + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public IndexMultipleDocumentsResponse indexMultipleResumes(List resumes, String indexId) throws TxException { + IndexMultipleResumesRequest request = new IndexMultipleResumesRequest(); + request.Resumes = resumes; + + RequestBody body = createJsonBody(request); + Request apiRequest = new Request.Builder() + .url(_endpoints.multipleResumes(indexId)) + .post(body) + .build(); + + HttpResponse response = executeRequest(apiRequest, IndexMultipleDocumentsResponse.class, getBodyIfDebug(apiRequest)); + return response.getData(); + } + + /** + * Add several jobs to an existing index + * @param jobs The jobs generated by the Job Parser paired with their DocumentIds + * @param indexId The index the documents should be added into (case-insensitive). + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public IndexMultipleDocumentsResponse indexMultipleJobs(List jobs, String indexId) throws TxException { + IndexMultipleJobsRequest request = new IndexMultipleJobsRequest(); + request.Jobs = jobs; + + RequestBody body = createJsonBody(request); + Request apiRequest = new Request.Builder() + .url(_endpoints.multipleJobs(indexId)) + .post(body) + .build(); + + HttpResponse response = executeRequest(apiRequest, IndexMultipleDocumentsResponse.class, getBodyIfDebug(apiRequest)); + return response.getData(); + } + + /** + * Delete an existing document from an index + * @param indexId The index containing the document + * @param documentId The ID of the document to delete + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public DeleteDocumentResponse deleteDocument(String indexId, String documentId) throws TxException { + Request apiRequest = new Request.Builder() + .url(_endpoints.document(indexId, documentId)) + .delete() + .build(); + + HttpResponse response = executeRequest(apiRequest, DeleteDocumentResponse.class, getBodyIfDebug(apiRequest)); + return response.getData(); + } + + /** + * Delete a group of existing documents from an index + * @param indexId The index containing the documents + * @param documentIds The IDs of the documents to delete + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public DeleteMultipleDocumentsResponse deleteMultipleDocuments(String indexId, List documentIds) throws TxException { + DeleteMultipleDocumentsRequest request = new DeleteMultipleDocumentsRequest(); + request.DocumentIds = documentIds; + RequestBody requestBody = createJsonBody(request); + Request apiRequest = new Request.Builder() + .url(_endpoints.multipleDocuments(indexId)) + .delete(requestBody) + .build(); + + HttpResponse response = executeRequest(apiRequest, DeleteMultipleDocumentsResponse.class, getBodyIfDebug(apiRequest)); + return response.getData(); + } + + /** + * Retrieve an existing resume from an index + * @param indexId The index containing the resume + * @param documentId The ID of the resume to retrieve + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public GetResumeResponse getResume(String indexId, String documentId) throws TxException { + Request apiRequest = new Request.Builder() + .url(_endpoints.resume(indexId, documentId)) + .build(); + + HttpResponse response = executeRequest(apiRequest, GetResumeResponse.class, getBodyIfDebug(apiRequest)); + return response.getData(); + } + + /** + * Retrieve an existing job from an index + * @param indexId The index containing the job + * @param documentId The ID of the job to retrieve + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public GetJobResponse getJob(String indexId, String documentId) throws TxException { + Request apiRequest = new Request.Builder() + .url(_endpoints.job(indexId, documentId)) + .build(); + + HttpResponse response = executeRequest(apiRequest, GetJobResponse.class, getBodyIfDebug(apiRequest)); + return response.getData(); + } + + /** + * Updates the user-defined tags for a resume + * @param indexId The index containing the resume + * @param documentId The ID of the resume to update + * @param userDefinedTags The user-defined tags to add/delete/etc + * @param method Which method to use for the specified user-defined tags + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public UpdateUserDefinedTagsResponse updateResumeUserDefinedTags( + String indexId, + String documentId, + List userDefinedTags, + UserDefinedTagsMethod method) throws TxException { + UpdateUserDefinedTagsRequest request = new UpdateUserDefinedTagsRequest(); + request.UserDefinedTags = userDefinedTags; + request.Method = method; + + RequestBody body = createJsonBody(request); + Request apiRequest = new Request.Builder() + .url(_endpoints.resume(indexId, documentId)) + .patch(body) + .build(); + + HttpResponse response = executeRequest(apiRequest, UpdateUserDefinedTagsResponse.class, getBodyIfDebug(apiRequest)); + return response.getData(); + } + + /** + * Updates the user-defined tags for a job + * @param indexId The index containing the job + * @param documentId The ID of the job to update + * @param userDefinedTags The user-defined tags to add/delete/etc + * @param method Which method to use for the specified user-defined tags + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public UpdateUserDefinedTagsResponse updateJobUserDefinedTags( + String indexId, + String documentId, + List userDefinedTags, + UserDefinedTagsMethod method) throws TxException { + UpdateUserDefinedTagsRequest request = new UpdateUserDefinedTagsRequest(); + request.UserDefinedTags = userDefinedTags; + request.Method = method; + + RequestBody body = createJsonBody(request); + Request apiRequest = new Request.Builder() + .url(_endpoints.job(indexId, documentId)) + .patch(body) + .build(); + + HttpResponse response = executeRequest(apiRequest, UpdateUserDefinedTagsResponse.class, getBodyIfDebug(apiRequest)); + return response.getData(); + } + + /** + * Find matches for a non-indexed resume. + * @param resume The resume (generated by the Resume Parser) to use as the source for a match query + * @param indexesToQuery The indexes to find results in. These must all be of the same type (resumes or jobs) + * @param preferredWeights + * The preferred category weights for scoring the results. If {@code null}, + * The best values will be determined based on the source resume + * @param filters Any filters to apply prior to the match (a result must satisfy all the filters), or {@code null} + * @param settings The settings for this match request. Use {@code null} for defaults. + * @param numResults The number of results to show. Use {@code 0} for the default. + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public MatchResponse match( + ParsedResume resume, + List indexesToQuery, + CategoryWeights preferredWeights, + FilterCriteria filters, + SearchMatchSettings settings, + int numResults) throws TxException { + + MatchResumeRequest request = createRequest(resume, indexesToQuery, preferredWeights, filters, settings, numResults); + RequestBody body = createJsonBody(request); + Request apiRequest = new Request.Builder() + .url(_endpoints.matchResume()) + .post(body) + .build(); + + HttpResponse response = executeRequest(apiRequest, MatchResponse.class, getBodyIfDebug(apiRequest)); + return response.getData(); + } + + MatchResumeRequest createRequest( + ParsedResume resume, + List indexesToQuery, + CategoryWeights preferredWeights, + FilterCriteria filters, + SearchMatchSettings settings, + int numResults) { + MatchResumeRequest request = new MatchResumeRequest(); + request.ResumeData = resume; + request.IndexIdsToSearchInto = indexesToQuery; + request.PreferredCategoryWeights = preferredWeights; + request.FilterCriteria = filters; + request.Settings = settings; + request.Take = numResults; + return request; + } + + /** + * Find matches for a non-indexed job. + * @param job The job (generated by the Job Parser) to use as the source for a match query + * @param indexesToQuery The indexes to find results in. These must all be of the same type (resumes or jobs) + * @param preferredWeights + * The preferred category weights for scoring the results. If {@code null}, + * The best values will be determined based on the source job + * @param filters Any filters to apply prior to the match (a result must satisfy all the filters), or {@code null} + * @param settings The settings for this match request. Use {@code null} for defaults. + * @param numResults The number of results to show. Use {@code 0} for the default. + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public MatchResponse match( + ParsedJob job, + List indexesToQuery, + CategoryWeights preferredWeights, + FilterCriteria filters, + SearchMatchSettings settings, + int numResults) throws TxException { + + MatchJobRequest request = createRequest(job, indexesToQuery, preferredWeights, filters, settings, numResults); + RequestBody body = createJsonBody(request); + Request apiRequest = new Request.Builder() + .url(_endpoints.matchJob()) + .post(body) + .build(); + + HttpResponse response = executeRequest(apiRequest, MatchResponse.class, getBodyIfDebug(apiRequest)); + return response.getData(); + } + + MatchJobRequest createRequest( + ParsedJob job, + List indexesToQuery, + CategoryWeights preferredWeights, + FilterCriteria filters, + SearchMatchSettings settings, + int numResults) { + MatchJobRequest request = new MatchJobRequest(); + request.JobData = job; + request.IndexIdsToSearchInto = indexesToQuery; + request.PreferredCategoryWeights = preferredWeights; + request.FilterCriteria = filters; + request.Settings = settings; + request.Take = numResults; + return request; + } + + /** + * Find matches for a resume or job that is already indexed + * @param indexId The index containing the document you want to match + * @param documentId The ID of the document to match + * @param indexesToQuery The indexes to find results in. These must all be of the same type (resumes or jobs) + * @param preferredWeights + * The preferred category weights for scoring the results. If {@code null}, + * The best values will be determined based on the source resume/job + * @param filters Any filters to apply prior to the match (a result must satisfy all the filters), or {@code null} + * @param settings The settings for this match request. Use {@code null} for defaults. + * @param numResults The number of results to show. Use {@code 0} for the default. + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public MatchResponse match( + String indexId, + String documentId, + List indexesToQuery, + CategoryWeights preferredWeights, + FilterCriteria filters, + SearchMatchSettings settings, + int numResults) throws TxException { + + MatchByDocumentIdOptions request = createRequest(indexesToQuery, preferredWeights, filters, settings, numResults); + RequestBody body = createJsonBody(request); + Request apiRequest = new Request.Builder() + .url(_endpoints.matchDocId(indexId, documentId)) + .post(body) + .build(); + + HttpResponse response = executeRequest(apiRequest, MatchResponse.class, getBodyIfDebug(apiRequest)); + return response.getData(); + } + + MatchByDocumentIdOptions createRequest( + List indexesToQuery, + CategoryWeights preferredWeights, + FilterCriteria filters, + SearchMatchSettings settings, + int numResults) { + MatchByDocumentIdOptions request = new MatchByDocumentIdOptions(); + request.IndexIdsToSearchInto = indexesToQuery; + request.PreferredCategoryWeights = preferredWeights; + request.FilterCriteria = filters; + request.Settings = settings; + request.Take = numResults; + return request; + } + + /** + * Search for resumes or jobs that meet specific criteria + * @param indexesToQuery The indexes to find results in. These must all be of the same type (resumes or jobs) + * @param query The search query. A result must satisfy all of these criteria + * @param settings The settings for this search request. Use {@code null} for defaults. + * @param pagination Pagination settings. Use {@code null} for defaults. + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public SearchResponse search( + List indexesToQuery, + FilterCriteria query, + SearchMatchSettings settings, + PaginationSettings pagination) throws TxException { + SearchRequest request = createRequest(indexesToQuery, query, settings, pagination); + RequestBody body = createJsonBody(request); + Request apiRequest = new Request.Builder() + .url(_endpoints.search()) + .post(body) + .build(); + + HttpResponse response = executeRequest(apiRequest, SearchResponse.class, getBodyIfDebug(apiRequest)); + return response.getData(); + } + + SearchRequest createRequest(List indexesToQuery, FilterCriteria query, SearchMatchSettings settings, PaginationSettings pagination) { + SearchRequest request = new SearchRequest(); + request.IndexIdsToSearchInto = indexesToQuery; + request.FilterCriteria = query; + request.Settings = settings; + request.PaginationSettings = pagination; + return request; + } + + /** + * Score one or more target documents against a source resume + * @param Either {@link ParsedResumeWithId} or {@link ParsedJobWithId} + * @param sourceResume The source resume + * @param targetDocuments The target resumes/jobs + * @param preferredWeights + * The preferred category weights for scoring the results. If {@code null}, + * The best values will be determined based on the source resume. + * @param settings The settings for this search request. Use {@code null} for defaults. + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + @SuppressWarnings("unchecked") //these actually are checked, compiler just can't tell + public BimetricScoreResponse bimetricScore( + ParsedResumeWithId sourceResume, + List targetDocuments, + CategoryWeights preferredWeights, + SearchMatchSettings settings) throws TxException { + + BimetricScoreResumeRequest request = new BimetricScoreResumeRequest(); + request.PreferredCategoryWeights = preferredWeights; + request.Settings = settings; + request.SourceResume = sourceResume; + + if (targetDocuments.size() > 0) { + //we must only cast/set either TargetResumes or TargetJobs here since + // Java has type erasure and both casts would succeed and we'd send both params to the API + if (targetDocuments.get(0) instanceof ParsedResumeWithId) { + request.TargetResumes = (List)targetDocuments; + } + else { + request.TargetJobs = (List)targetDocuments; + } + } + + RequestBody body = createJsonBody(request); + Request apiRequest = new Request.Builder() + .url(_endpoints.bimetricScoreResume()) + .post(body) + .build(); + + HttpResponse response = executeRequest(apiRequest, BimetricScoreResponse.class, getBodyIfDebug(apiRequest)); + return response.getData(); + } + + /** + * Score one or more target documents against a source job + * @param Either {@link ParsedResumeWithId} or {@link ParsedJobWithId} + * @param sourceJob The source job + * @param targetDocuments The target resumes/jobs + * @param preferredWeights + * The preferred category weights for scoring the results. If {@code null}, + * The best values will be determined based on the source job. + * @param settings The settings for this search request. Use {@code null} for defaults. + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + @SuppressWarnings("unchecked") //these actually are checked, compiler just can't tell + public BimetricScoreResponse bimetricScore( + ParsedJobWithId sourceJob, + List targetDocuments, + CategoryWeights preferredWeights, + SearchMatchSettings settings) throws TxException { + BimetricScoreJobRequest request = new BimetricScoreJobRequest(); + request.PreferredCategoryWeights = preferredWeights; + request.Settings = settings; + request.SourceJob = sourceJob; + + if (targetDocuments.size() > 0) { + //we must only cast/set either TargetResumes or TargetJobs here since + // Java has type erasure and both casts would succeed and we'd send both params to the API + if (targetDocuments.get(0) instanceof ParsedResumeWithId) { + request.TargetResumes = (List)targetDocuments; + } + else { + request.TargetJobs = (List)targetDocuments; + } + } + RequestBody body = createJsonBody(request); + Request apiRequest = new Request.Builder() + .url(_endpoints.bimetricScoreJob()) + .post(body) + .build(); + + HttpResponse response = executeRequest(apiRequest, BimetricScoreResponse.class, getBodyIfDebug(apiRequest)); + return response.getData(); + } +} diff --git a/src/main/java/com/textkernel/tx/services/ServiceBase.java b/src/main/java/com/textkernel/tx/services/ServiceBase.java new file mode 100644 index 000000000..114357eb6 --- /dev/null +++ b/src/main/java/com/textkernel/tx/services/ServiceBase.java @@ -0,0 +1,112 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx.services; + +import java.io.IOException; + +import com.textkernel.tx.EnvironmentSettings; +import com.textkernel.tx.TxClient; +import com.textkernel.tx.exceptions.TxException; +import com.textkernel.tx.http.HttpResponse; +import com.textkernel.tx.models.api.ApiResponse; +import com.textkernel.tx.models.api.ApiResponseInfoLite; +import com.textkernel.tx.models.api.indexes.IndexingOptionsGeneric; +import com.textkernel.tx.models.api.indexes.SearchAndMatchVersion; +import com.textkernel.tx.utilities.TxJsonSerializer; + +import okhttp3.MediaType; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; +import okhttp3.Response; + +/** Base class for all Tx services */ +abstract class ServiceBase { + + private OkHttpClient _httpClient; + private static final MediaType JSON = MediaType.get("application/json; charset=utf-8"); + protected final EnvironmentSettings _settings; + protected final ApiEndpoints _endpoints; + + protected ServiceBase(OkHttpClient httpClient, EnvironmentSettings settings) { + _httpClient = httpClient; + _settings = settings; + _endpoints = new ApiEndpoints(settings.DataCenter); + } + + protected void setEnvironment(IndexingOptionsGeneric options) { + if (options != null && options.SearchAndMatchVersion == SearchAndMatchVersion.V2) { + //ensure this is set correctly + options.SearchAndMatchEnvironment = _settings.MatchV2Environment; + } + } + + static String getBodyIfDebug(Request request) { + + if (TxClient.ShowFullRequestBodyInExceptions) { + try { + final Request copy = request.newBuilder().build(); + final okio.Buffer buffer = new okio.Buffer(); + RequestBody body = copy.body(); + if (body != null) { + body.writeTo(buffer); + return buffer.readUtf8(); + } + return null; + } + catch (IOException e) { + return null; + } + } + + return null; + } + + @SuppressWarnings("deprecation") + protected RequestBody createJsonBody(Object body) { + // Use OkHttp v3 signature to ensure binary compatibility between v3 and v4 + // https://github.com/textkernel/tx-java/issues/36 + return RequestBody.create(JSON, TxJsonSerializer.serialize(body)); + } + + protected > HttpResponse executeRequest(Request apiRequest, Class classOfT, String requestBody) throws TxException { + + ApiResponseInfoLite errorInfo = new ApiResponseInfoLite(); + errorInfo.Code = "Error"; + errorInfo.Message = "Unknown API error."; + + HttpResponse apiResponse = null; + Response rawResponse = null; + + try { + rawResponse = _httpClient.newCall(apiRequest).execute(); + apiResponse = new HttpResponse(rawResponse, classOfT); + + if (rawResponse != null && rawResponse.code() == 413) { + errorInfo.Message = "Request body was too large."; + throw new TxException(requestBody, rawResponse, errorInfo, null); + } + + if (rawResponse != null && apiResponse.getData() == null && rawResponse.code() != 200) { + //something went wrong, a non-200 status code + errorInfo.Message = rawResponse.code() + " - " + rawResponse.message(); + } + + if (apiResponse == null || apiResponse.getData() == null) throw new TxException(requestBody, rawResponse, errorInfo, null); + } + catch (IOException e) { + errorInfo.Message = e.getMessage(); + TxException newEx = new TxException(requestBody, rawResponse, errorInfo, null); + newEx.InnerException = e; + throw newEx; + } + + if (!rawResponse.isSuccessful()) throw new TxException(requestBody, rawResponse, apiResponse.getData().Info); + + return apiResponse; + } + +} diff --git a/src/main/java/com/textkernel/tx/services/SkillsIntelligenceService.java b/src/main/java/com/textkernel/tx/services/SkillsIntelligenceService.java new file mode 100644 index 000000000..17f0a6473 --- /dev/null +++ b/src/main/java/com/textkernel/tx/services/SkillsIntelligenceService.java @@ -0,0 +1,899 @@ +// Copyright © 2023 Textkernel BV. All rights reserved. +// This file is provided for use by, or on behalf of, Textkernel licensees +// within the terms of their license of Textkernel products or Textkernel customers +// within the Terms of Service pertaining to the Textkernel SaaS products. + +package com.textkernel.tx.services; + +import java.util.ArrayList; +import java.util.Collections; +import java.util.Comparator; +import java.util.List; +import java.util.Optional; +import java.util.stream.Collectors; + +import com.textkernel.tx.EnvironmentSettings; +import com.textkernel.tx.TxClient; +import com.textkernel.tx.exceptions.TxException; +import com.textkernel.tx.http.HttpResponse; +import com.textkernel.tx.models.api.dataenrichment.AutocompleteRequest; +import com.textkernel.tx.models.api.dataenrichment.GetMetadataResponse; +import com.textkernel.tx.models.api.dataenrichment.TaxonomyFormat; +import com.textkernel.tx.models.api.dataenrichment.ontology.request.CompareProfessionsRequest; +import com.textkernel.tx.models.api.dataenrichment.ontology.request.CompareSkillsToProfessionRequest; +import com.textkernel.tx.models.api.dataenrichment.ontology.request.SkillsSimilarityScoreRequest; +import com.textkernel.tx.models.api.dataenrichment.ontology.request.SuggestProfessionsRequest; +import com.textkernel.tx.models.api.dataenrichment.ontology.request.SuggestSkillsFromProfessionsRequest; +import com.textkernel.tx.models.api.dataenrichment.ontology.request.SuggestSkillsFromSkillsRequest; +import com.textkernel.tx.models.api.dataenrichment.ontology.response.CompareProfessionsResponse; +import com.textkernel.tx.models.api.dataenrichment.ontology.response.CompareSkillsToProfessionResponse; +import com.textkernel.tx.models.api.dataenrichment.ontology.response.SkillScore; +import com.textkernel.tx.models.api.dataenrichment.ontology.response.SkillsSimilarityScoreResponse; +import com.textkernel.tx.models.api.dataenrichment.ontology.response.SuggestProfessionsResponse; +import com.textkernel.tx.models.api.dataenrichment.ontology.response.SuggestSkillsResponse; +import com.textkernel.tx.models.api.dataenrichment.professions.request.LookupProfessionCodesRequest; +import com.textkernel.tx.models.api.dataenrichment.professions.request.NormalizeProfessionsRequest; +import com.textkernel.tx.models.api.dataenrichment.professions.response.GetProfessionsTaxonomyResponse; +import com.textkernel.tx.models.api.dataenrichment.professions.response.GetProfessionsTaxonomyResponseValue; +import com.textkernel.tx.models.api.dataenrichment.professions.response.LookupProfessionCodesResponse; +import com.textkernel.tx.models.api.dataenrichment.professions.response.NormalizeProfessionsResponse; +import com.textkernel.tx.models.api.dataenrichment.professions.response.ProfessionsAutoCompleteResponse; +import com.textkernel.tx.models.api.dataenrichment.skills.request.ExtractSkillsRequest; +import com.textkernel.tx.models.api.dataenrichment.skills.request.LookupSkillsRequest; +import com.textkernel.tx.models.api.dataenrichment.skills.request.NormalizeSkillsRequest; +import com.textkernel.tx.models.api.dataenrichment.skills.request.SkillsAutoCompleteRequest; +import com.textkernel.tx.models.api.dataenrichment.skills.response.AutoCompleteSkillsResponse; +import com.textkernel.tx.models.api.dataenrichment.skills.response.ExtractSkillsResponse; +import com.textkernel.tx.models.api.dataenrichment.skills.response.GetSkillsTaxonomyResponse; +import com.textkernel.tx.models.api.dataenrichment.skills.response.GetSkillsTaxonomyResponseValue; +import com.textkernel.tx.models.api.dataenrichment.skills.response.LookupSkillCodesResponse; +import com.textkernel.tx.models.api.dataenrichment.skills.response.NormalizeSkillsResponse; +import com.textkernel.tx.models.api.jobdescription.GenerateJobRequest; +import com.textkernel.tx.models.api.jobdescription.GenerateJobResponse; +import com.textkernel.tx.models.api.jobdescription.SuggestSkillsFromJobTitleRequest; +import com.textkernel.tx.models.api.jobdescription.SuggestSkillsFromJobTitleResponse; +import com.textkernel.tx.models.job.ParsedJob; +import com.textkernel.tx.models.resume.ParsedResume; +import com.textkernel.tx.models.resume.employment.Position; +import com.textkernel.tx.models.resume.skills.ResumeNormalizedSkill; + +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; + +/** See {@link TxClient#skillsIntelligence()} */ +public class SkillsIntelligenceService extends ServiceBase { + + /** See {@link TxClient#skillsIntelligence()} */ + public SkillsIntelligenceService(OkHttpClient httpClient, EnvironmentSettings settings) { + super(httpClient, settings); + } + + /** + * Get all skills in the taxonomy with associated IDs and descriptions in all supported languages. + * @param format The format of the returned taxonomy.
NOTE: if you set this to {@link TaxonomyFormat#csv}, only the {@link GetSkillsTaxonomyResponseValue#CsvOutput} will be populated. + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public GetSkillsTaxonomyResponse getSkillsTaxonomy(TaxonomyFormat format) throws TxException { + Request apiRequest = new Request.Builder() + .url(_endpoints.desSkillsGetTaxonomy(format, _settings.SkillsIntelligenceIncludeCertifications)) + .build(); + + HttpResponse response = executeRequest(apiRequest, GetSkillsTaxonomyResponse.class, getBodyIfDebug(apiRequest)); + return response.getData(); + } + + /** + * Get all skills in the taxonomy with associated IDs and descriptions in all supported languages. + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public GetSkillsTaxonomyResponse getSkillsTaxonomy() throws TxException { + return getSkillsTaxonomy(TaxonomyFormat.json); + } + + /** + * Get metadata about the skills taxonomy/service. + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public GetMetadataResponse getSkillsTaxonomyMetadata() throws TxException { + Request apiRequest = new Request.Builder() + .url(_endpoints.desSkillsGetMetadata(_settings.SkillsIntelligenceIncludeCertifications)) + .build(); + + HttpResponse response = executeRequest(apiRequest, GetMetadataResponse.class, getBodyIfDebug(apiRequest)); + return response.getData(); + } + + /** + * Returns normalized skills that begin with a given prefix, based on the chosen language(s). Each skill is associated with multiple descriptions. If any of the descriptions are a good completion of the given prefix, the skill is included in the results. + * @param prefix The skill prefix to be completed. Must contain at least 1 character. + * @param languages The language(s) used to search for matching skills (the language of the provided Prefix). A maximum of 5 languages can be provided. Must be one of the supported ISO codes.
Default is 'en' only. + * @param outputLanguage The language to ouput the found skill descriptions in (default is 'en'). Must be one of the supported ISO codes. + * @param types If specified, only these types of skills will be returned. The following values are acceptable: Professional, IT, Language, Soft, All. + * @param limit The maximum number of returned skills. The default is 10 and the maximum is 100. + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public AutoCompleteSkillsResponse autocompleteSkill(String prefix, List languages, String outputLanguage, List types, int limit) throws TxException { + SkillsAutoCompleteRequest request = new SkillsAutoCompleteRequest(); + request.Prefix = prefix; + request.Limit = limit; + request.Types = types; + request.Languages = languages; + request.OutputLanguage = outputLanguage; + + RequestBody body = createJsonBody(request); + Request apiRequest = new Request.Builder() + .url(_endpoints.desSkillsAutoComplete(_settings.SkillsIntelligenceIncludeCertifications)) + .post(body) + .build(); + + HttpResponse response = executeRequest(apiRequest, AutoCompleteSkillsResponse.class, getBodyIfDebug(apiRequest)); + return response.getData(); + } + + /** + * Returns normalized skills that begin with a given prefix, based on the chosen language(s). Each skill is associated with multiple descriptions. If any of the descriptions are a good completion of the given prefix, the skill is included in the results. + * @param prefix The skill prefix to be completed. Must contain at least 1 character. + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public AutoCompleteSkillsResponse autocompleteSkill(String prefix) throws TxException { + return autocompleteSkill(prefix,null,null,null,10); + } + + /** + * Get the details associated with given skills in the taxonomy. + * @param skillIds The IDs of the skills to get details about. A maximum of 100 IDs can be requested. + * @param outputLanguage The language to use for the output skill descriptions. If not provided, defaults to en. If specified, must be one of the supported ISO codes.
Default is 'en'. + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public LookupSkillCodesResponse lookupSkills(List skillIds, String outputLanguage) throws TxException { + LookupSkillsRequest request = new LookupSkillsRequest(); + request.SkillIds = skillIds; + request.OutputLanguage = outputLanguage; + + RequestBody body = createJsonBody(request); + Request apiRequest = new Request.Builder() + .url(_endpoints.desSkillsLookup(_settings.SkillsIntelligenceIncludeCertifications)) + .post(body) + .build(); + + HttpResponse response = executeRequest(apiRequest, LookupSkillCodesResponse.class, getBodyIfDebug(apiRequest)); + return response.getData(); + } + + /** + * Get the details associated with given skills in the taxonomy. + * @param skillIds The IDs of the skills to get details about. A maximum of 100 IDs can be requested. + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public LookupSkillCodesResponse lookupSkills(List skillIds) throws TxException { + return lookupSkills(skillIds,null); + } + + /** + * Normalize the given skills to the most closely-related skills in the taxonomy. + * @param skills The list of skills to normalize (up to 50 skills, each skill may not exceed 100 characters). + * @param language The language of the given skills. Must be one of the supported ISO codes.
Default is 'en'. + * @param outputLanguage The language to use for the output skill descriptions. Must be one of the supported ISO codes.
Defaults to whatever is used for the 'language' parameter. + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public NormalizeSkillsResponse normalizeSkills(List skills, String language, String outputLanguage) throws TxException { + NormalizeSkillsRequest request = new NormalizeSkillsRequest(); + request.Skills = skills; + request.Language = language; + request.OutputLanguage = outputLanguage; + + RequestBody body = createJsonBody(request); + Request apiRequest = new Request.Builder() + .url(_endpoints.desSkillsNormalize(_settings.SkillsIntelligenceIncludeCertifications)) + .post(body) + .build(); + + HttpResponse response = executeRequest(apiRequest, NormalizeSkillsResponse.class, getBodyIfDebug(apiRequest)); + return response.getData(); + } + + /** + * Normalize the given skills to the most closely-related skills in the taxonomy. + * @param skills The list of skills to normalize (up to 50 skills, each skill may not exceed 100 characters). + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public NormalizeSkillsResponse normalizeSkills(List skills) throws TxException { + return normalizeSkills(skills,null,null); + } + + /** + * Extracts known skills from the given text. + * @param text The text to extract skills from. There is a 24,000 character limit. + * @param language The language of the input text. Must be one of the supported ISO codes.
Default is 'en'. + * @param outputLanguage The language to use for the output skill descriptions. If not provided, defaults to the input language. Must be one of the supported ISO codes. + * @param threshold A value from [0 - 1] for the minimum confidence threshold for extracted skills. Lower values will return more skills, but also increase the likelihood of ambiguity-related errors. The recommended and default value is 0.5. + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public ExtractSkillsResponse extractSkills(String text, String language, String outputLanguage, float threshold) throws TxException { + ExtractSkillsRequest request = new ExtractSkillsRequest(); + request.Text = text; + request.Language = language; + request.OutputLanguage = outputLanguage; + request.Threshold = threshold; + + RequestBody body = createJsonBody(request); + Request apiRequest = new Request.Builder() + .url(_endpoints.desSkillsExtract(_settings.SkillsIntelligenceIncludeCertifications)) + .post(body) + .build(); + + HttpResponse response = executeRequest(apiRequest, ExtractSkillsResponse.class, getBodyIfDebug(apiRequest)); + return response.getData(); + } + + /** + * Extracts known skills from the given text. + * @param text The text to extract skills from. There is a 24,000 character limit. + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public ExtractSkillsResponse extractSkills(String text) throws TxException { + return extractSkills(text,null,null,0.5f); + } + + /** + * Get all professions in the taxonomy with associated IDs and descriptions in all supported languages. + * @param language The language parameter returns the taxonomy with descriptions only in that specified language. If not specified, descriptions in all languages are returned. Must be specified as one of the supported ISO codes. + * @param format The format of the returned taxonomy.
NOTE: if you set this to {@link TaxonomyFormat#csv}, only the {@link GetProfessionsTaxonomyResponseValue#CsvOutput} will be populated. + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public GetProfessionsTaxonomyResponse getProfessionsTaxonomy(String language, TaxonomyFormat format) throws TxException { + Request apiRequest = new Request.Builder() + .url(_endpoints.desProfessionsGetTaxonomy(format,language)) + .build(); + + HttpResponse response = executeRequest(apiRequest, GetProfessionsTaxonomyResponse.class, getBodyIfDebug(apiRequest)); + return response.getData(); + } + + /** + * Get all professions in the taxonomy with associated IDs and descriptions in all supported languages. + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public GetProfessionsTaxonomyResponse getProfessionsTaxonomy() throws TxException { + return getProfessionsTaxonomy(null,TaxonomyFormat.json); + } + + /** + * Get metadata about the professions taxonomy/service. + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public GetMetadataResponse getProfessionsTaxonomyMetadata() throws TxException { + Request apiRequest = new Request.Builder() + .url(_endpoints.desProfessionsGetMetadata()) + .build(); + + HttpResponse response = executeRequest(apiRequest, GetMetadataResponse.class, getBodyIfDebug(apiRequest)); + return response.getData(); + } + + /** + * Returns normalized professions that begin with a given prefix, based on the chosen language(s). Each profession is associated with multiple descriptions. If any of the descriptions are a good completion of the given prefix, the profession is included in the results. + * @param prefix The job title prefix to be completed. Must contain at least 1 character. + * @param languages The language(s) used to search for matching professions (the language of the provided Prefix). A maximum of 5 languages can be provided. Must be one of the supported ISO codes. Default is 'en' only. + * @param outputLanguage The language to ouput the found professions in (default is 'en'). Must be one of the supported ISO codes. + * @param limit The maximum number of returned professions. The default is 10 and the maximum is 100. + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public ProfessionsAutoCompleteResponse autocompleteProfession(String prefix, List languages, String outputLanguage, int limit) throws TxException { + AutocompleteRequest request = new AutocompleteRequest(); + request.Prefix = prefix; + request.Limit = limit; + request.Languages = languages; + request.OutputLanguage = outputLanguage; + + RequestBody body = createJsonBody(request); + Request apiRequest = new Request.Builder() + .url(_endpoints.desProfessionsAutoComplete()) + .post(body) + .build(); + + HttpResponse response = executeRequest(apiRequest, ProfessionsAutoCompleteResponse.class, getBodyIfDebug(apiRequest)); + return response.getData(); + } + + /** + * Returns normalized professions that begin with a given prefix, based on the default language of english. Each profession is associated with multiple descriptions. If any of the descriptions are a good completion of the given prefix, the profession is included in the results. + * @param prefix The job title prefix to be completed. Must contain at least 1 character. + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public ProfessionsAutoCompleteResponse autocompleteProfession(String prefix) throws TxException { + List languages = new ArrayList<>(); + languages.add("en"); + return autocompleteProfession(prefix,languages,"en",10); + } + + /** + * Normalize the given job titles to the most closely-related professions in the taxonomy. + * @param jobTitles The list of job titles to normalize (up to 10 job titles, each job title may not exceed 400 characters). + * @param language The language of the input job titles. Must be one of the supported ISO codes.
Default is 'en'. + * @param outputLanguage The language to use for descriptions of the returned normalized professions. Must be one of the supported ISO codes.
Defaults to whatever is used for the 'language' parameter. + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public NormalizeProfessionsResponse normalizeProfessions(List jobTitles, String language, String outputLanguage) throws TxException { + NormalizeProfessionsRequest request = new NormalizeProfessionsRequest(); + request.JobTitles = jobTitles; + request.Language = language; + request.OutputLanguage = outputLanguage; + + RequestBody body = createJsonBody(request); + Request apiRequest = new Request.Builder() + .url(_endpoints.desProfessionsNormalize()) + .post(body) + .build(); + + HttpResponse response = executeRequest(apiRequest, NormalizeProfessionsResponse.class, getBodyIfDebug(apiRequest)); + return response.getData(); + } + + /** + * Normalize the given job titles to the most closely-related professions in the taxonomy. + * @param jobTitles The list of job titles to normalize (up to 10 job titles, each job title may not exceed 400 characters). + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public NormalizeProfessionsResponse normalizeProfessions(List jobTitles) throws TxException { + return normalizeProfessions(jobTitles,null,null); + } + + /** + * Get details for the given professions in the taxonomy. + * @param codeIds The profession code IDs to get details about from the Professions Taxonomy. + * @param outputLanguage The language to use for professions descriptions (default is en). Must be an allowed ISO code.
Default is 'en'. + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public LookupProfessionCodesResponse lookupProfessions(List codeIds, String outputLanguage) throws TxException { + LookupProfessionCodesRequest request = new LookupProfessionCodesRequest(); + request.CodeIds = codeIds; + request.OutputLanguage = outputLanguage; + + RequestBody body = createJsonBody(request); + Request apiRequest = new Request.Builder() + .url(_endpoints.desProfessionsLookup()) + .post(body) + .build(); + + HttpResponse response = executeRequest(apiRequest, LookupProfessionCodesResponse.class, getBodyIfDebug(apiRequest)); + return response.getData(); + } + + /** + * Get details for the given professions in the taxonomy. + * @param codeIds The profession code IDs to get details about from the Professions Taxonomy. + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public LookupProfessionCodesResponse lookupProfessions(List codeIds) throws TxException { + return lookupProfessions(codeIds,null); + } + + /** + * Compare two professions based on the skills associated with each. + * @param profession1 A profession code ID from the Professions Taxonomy to compare. + * @param profession2 A profession code ID from the Professions Taxonomy to compare. + * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public CompareProfessionsResponse compareProfessions(int profession1, int profession2, String outputLanguage) throws TxException { + CompareProfessionsRequest request = new CompareProfessionsRequest(); + request.ProfessionACodeId = profession1; + request.ProfessionBCodeId = profession2; + request.OutputLanguage = outputLanguage; + + RequestBody body = createJsonBody(request); + Request apiRequest = new Request.Builder() + .url(_endpoints.desOntologyCompareProfessions(_settings.SkillsIntelligenceIncludeCertifications)) + .post(body) + .build(); + + HttpResponse response = executeRequest(apiRequest, CompareProfessionsResponse.class, getBodyIfDebug(apiRequest)); + return response.getData(); + } + + /** + * Compare a given set of skills to the skills related to a given profession. + * @param professionCodeId The profession code ID from the Professions Taxonomy to compare the skill set to. + * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code + * @param skills The skills which should be compared against the given profession. The list can contain up to 50 skills. + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public CompareSkillsToProfessionResponse compareSkillsToProfessions(int professionCodeId, String outputLanguage, List skills) throws TxException { + CompareSkillsToProfessionRequest request = new CompareSkillsToProfessionRequest(); + request.Skills = new ArrayList(); + int amountOfSkills = skills.size() > 50 ? 50 : skills.size(); + + for(int i = 0; i < amountOfSkills; i++) { + request.Skills.add(skills.get(i)); + }; + request.ProfessionCodeId = professionCodeId; + request.OutputLanguage = outputLanguage; + + RequestBody body = createJsonBody(request); + Request apiRequest = new Request.Builder() + .url(_endpoints.desOntologyCompareSkillsToProfession(_settings.SkillsIntelligenceIncludeCertifications)) + .post(body) + .build(); + + HttpResponse response = executeRequest(apiRequest, CompareSkillsToProfessionResponse.class, getBodyIfDebug(apiRequest)); + return response.getData(); + } + + /** + * Compare the skills of a candidate to the skills related to a job using the Ontology API. + * @param resume The resume containing the skills of the candidate + * @param professionCodeId The profession code ID from the Professions Taxonomy to compare the skill set to. + * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code + * @param weightSkillsByExperience Whether or not to give a higher weight to skills that the candidate has more experience with. + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public CompareSkillsToProfessionResponse compareSkillsToProfessions( + ParsedResume resume, + int professionCodeId, + String outputLanguage, + boolean weightSkillsByExperience) throws TxException { + if(resume != null && resume.Skills != null && resume.Skills.Normalized != null && resume.Skills.Normalized.size() > 0){ + return compareSkillsToProfessions(professionCodeId, outputLanguage, getNormalizedSkillsFromResume(resume, weightSkillsByExperience)); + } + throw new IllegalArgumentException("The resume must be parsed with V2 skills selected, and with skills normalization enabled"); + } + + /** + * Suggests skills related to given professions. The service returns salient skills that are strongly associated with the professions. + * @param professionCodeIds The code IDs of the professions to suggest skills for. + * @param limit The maximum amount of suggested skills returned. If not sure what value should be, provide 10 as default limit. + * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public SuggestSkillsResponse suggestSkillsFromProfessions(List professionCodeIds, int limit, String outputLanguage) throws TxException { + SuggestSkillsFromProfessionsRequest request = new SuggestSkillsFromProfessionsRequest(); + request.ProfessionCodeIds = professionCodeIds; + request.Limit = limit; + request.OutputLanguage = outputLanguage; + + RequestBody body = createJsonBody(request); + Request apiRequest = new Request.Builder() + .url(_endpoints.desOntologySuggestSkillsFromProfessions(_settings.SkillsIntelligenceIncludeCertifications)) + .post(body) + .build(); + + HttpResponse response = executeRequest(apiRequest, SuggestSkillsResponse.class, getBodyIfDebug(apiRequest)); + return response.getData(); + } + + /** + * Suggests skills related to given professions. The service returns salient skills that are strongly associated with the professions. + * @param professionCodeIds The code IDs of the professions to suggest skills for. + * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public SuggestSkillsResponse suggestSkillsFromProfessions(List professionCodeIds, String outputLanguage) throws TxException { + return suggestSkillsFromProfessions(professionCodeIds, 10, outputLanguage); + } + + /** + * Suggests skills related to a resume based on the recent professions in the resume. + * @param resume The resume to suggest skills for (based on the professions in the resume). + * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public SuggestSkillsResponse suggestSkillsFromProfessions(ParsedResume resume, String outputLanguage) throws TxException { + if(resume != null && resume.EmploymentHistory != null && resume.EmploymentHistory.Positions != null){ + List normalizedProfs = new ArrayList(); + for(Position position: resume.EmploymentHistory.Positions){ + if (position != null && position.NormalizedProfession != null && position.NormalizedProfession.Profession != null && position.NormalizedProfession.Profession.CodeId != null){ + normalizedProfs.add(position.NormalizedProfession.Profession.CodeId); + } + } + + if (normalizedProfs.size() > 0){ + return suggestSkillsFromProfessions(normalizedProfs, outputLanguage); + } + } + throw new IllegalArgumentException("No professions were found in the resume, or the resume was parsed without professions normalization enabled"); + } + + /** + * Suggests skills related to a resume based on the recent professions in the resume. + * @param resume The resume to suggest skills for (based on the professions in the resume). + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public SuggestSkillsResponse suggestSkillsFromProfessions(ParsedResume resume) throws TxException { + return suggestSkillsFromProfessions(resume, null); + } + + /** + * Suggests skills related to a job based on the profession title in the job. + * @param job The resume to suggest skills for (based on the professions in the resume). + * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public SuggestSkillsResponse suggestSkillsFromProfessions(ParsedJob job, String outputLanguage) throws TxException { + if(job != null && job.JobTitles != null && job.JobTitles.NormalizedProfession != null && job.JobTitles.NormalizedProfession.Profession != null && job.JobTitles.NormalizedProfession.Profession.CodeId != null){ + List ids = new ArrayList(); + ids.add(job.JobTitles.NormalizedProfession.Profession.CodeId); + + return suggestSkillsFromProfessions(ids, outputLanguage); + } + throw new IllegalArgumentException("No professions were found in the job, or the job was parsed without professions normalization enabled"); + } + + /** + * Suggests skills related to a job based on the profession title in the job. + * @param job The resume to suggest skills for (based on the professions in the resume). + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public SuggestSkillsResponse suggestSkillsFromProfessions(ParsedJob job) throws TxException { + return suggestSkillsFromProfessions(job, null); + } + + private List getNormalizedSkillsFromResume(ParsedResume resume, boolean weightSkillsByExperience) { + if(resume != null && resume.Skills != null && resume.Skills.Normalized != null && resume.Skills.Normalized.size() > 0){ + List skills = new ArrayList(); + + ResumeNormalizedSkill maxExperienceSkill = Collections.max(resume.Skills.Normalized, Comparator.comparing(s -> s.MonthsExperience != null ? s.MonthsExperience.Value : 0)); + Integer maxExperience = Optional.ofNullable(maxExperienceSkill).map(s -> s.MonthsExperience).map(e -> e.Value).orElse(0); + + for(int i = 0; i < resume.Skills.Normalized.size(); i++) { + ResumeNormalizedSkill curSkill = resume.Skills.Normalized.get(i); + SkillScore newSkill = new SkillScore(curSkill.Id); + int curMonthsExperience = Optional.ofNullable(curSkill.MonthsExperience).map(e -> e.Value).orElse(0); + newSkill.Score = (weightSkillsByExperience && maxExperience > 0) ? curMonthsExperience / (float)maxExperience : 1; + + skills.add(newSkill); + } + + return skills; + } + throw new IllegalArgumentException("The resume must be parsed with V2 skills selected, and with skills normalization enabled."); + } + + /** + * Suggest professions based on the skills within a given resume. + * @param resume The professions are suggested based on the skills within this resume. + * @param limit The maximum amount of professions returned. If not sure what value should be, provide 10 as default limit. + * @param returnMissingSkills Flag to enable returning a list of missing skills per suggested profession. + * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code + * @param weightSkillsByExperience Whether or not to give a higher weight to skills that the candidate has more experience with. + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public SuggestProfessionsResponse suggestProfessionsFromSkills( + ParsedResume resume, + int limit, + boolean returnMissingSkills, + String outputLanguage, + boolean weightSkillsByExperience) throws TxException { + if(resume != null && resume.Skills != null && resume.Skills.Normalized != null && resume.Skills.Normalized.size() > 0){ + return suggestProfessionsFromSkills(getNormalizedSkillsFromResume(resume, weightSkillsByExperience), limit, returnMissingSkills, outputLanguage); + } + throw new IllegalArgumentException("The resume must be parsed with V2 skills selected, and with skills normalization enabled."); + } + + /** + * Suggest professions based on the skills within a given resume. + * @param resume The professions are suggested based on the skills within this resume. Defaults limit returned to 10 and does not return missing skills. Use another overload to specify these parameters. + * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public SuggestProfessionsResponse suggestProfessionsFromSkills(ParsedResume resume, String outputLanguage) throws TxException { + return suggestProfessionsFromSkills(resume, 10, false, outputLanguage, true); + } + + /** + * Suggest professions based on the skills within a given resume. + * @param resume The professions are suggested based on the skills within this resume. Defaults limit returned to 10 and does not return missing skills. Use another overload to specify these parameters. + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public SuggestProfessionsResponse suggestProfessionsFromSkills(ParsedResume resume) throws TxException { + return suggestProfessionsFromSkills(resume, null); + } + + /** + * Suggest professions based on the skills within a given job. + * @param job The professions are suggested based on the skills within this job. + * @param limit The maximum amount of professions returned. If not sure what value should be, provide 10 as default limit. + * @param returnMissingSkills Flag to enable returning a list of missing skills per suggested profession. + * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public SuggestProfessionsResponse suggestProfessionsFromSkills(ParsedJob job, int limit, boolean returnMissingSkills, String outputLanguage) throws TxException { + if(job != null && job.Skills != null && job.Skills.Normalized != null && job.Skills.Normalized.size() > 0){ + List skills = new ArrayList(); + int amountOfSkills = job.Skills.Normalized.size() > 50 ? 50 : job.Skills.Normalized.size(); + for(int i = 0; i < amountOfSkills; i++) { + skills.add(new SkillScore(job.Skills.Normalized.get(i).Id)); + } + + return suggestProfessionsFromSkills(skills, limit, returnMissingSkills, outputLanguage); + } + throw new IllegalArgumentException("The job must be parsed with V2 skills selected, and with skills normalization enabled"); + } + + /** + * Suggest professions based on the skills within a given job. + * @param job The professions are suggested based on the skills within this job. Defaults limit returned to 10 and does not return missing skills. Use another overload to specify these parameters. + * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public SuggestProfessionsResponse suggestProfessionsFromSkills(ParsedJob job, String outputLanguage) throws TxException { + return suggestProfessionsFromSkills(job, 10, false, outputLanguage); + } + + /** + * Suggest professions based on the skills within a given job. + * @param job The professions are suggested based on the skills within this job. Defaults limit returned to 10 and does not return missing skills. Use another overload to specify these parameters. + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public SuggestProfessionsResponse suggestProfessionsFromSkills(ParsedJob job) throws TxException { + return suggestProfessionsFromSkills(job, null); + } + + /** + * Suggest professions based on a given set of skills. + * @param skills The skills used to return the most relevant professions. The list can contain up to 50 skills. + * @param limit The maximum amount of professions returned. If not sure what value should be, provide 10 as default limit. + * @param returnMissingSkills Flag to enable returning a list of missing skills per suggested profession. + * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public SuggestProfessionsResponse suggestProfessionsFromSkills( + List skills, + int limit, + boolean returnMissingSkills, + String outputLanguage) throws TxException { + SuggestProfessionsRequest request = new SuggestProfessionsRequest(); + request.Skills = skills; + request.Limit = limit; + request.ReturnMissingSkills = returnMissingSkills; + request.OutputLanguage = outputLanguage; + + RequestBody body = createJsonBody(request); + Request apiRequest = new Request.Builder() + .url(_endpoints.desOntologySuggestProfessions(_settings.SkillsIntelligenceIncludeCertifications)) + .post(body) + .build(); + + HttpResponse response = executeRequest(apiRequest, SuggestProfessionsResponse.class, getBodyIfDebug(apiRequest)); + return response.getData(); + } + + /** + * Suggest professions based on a given set of skill IDs. + * @param skillIds The skill IDs used to return the most relevant professions. The list can contain up to 50 skill IDs. Defaults limit returned to 10 and does not return missing skills. Use another overload to specify these parameters. + * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public SuggestProfessionsResponse suggestProfessionsFromSkills(List skillIds, String outputLanguage) throws TxException { + List skills = skillIds.stream() + .map(s -> new SkillScore(s)) + .collect(Collectors.toList()); + return suggestProfessionsFromSkills(skills, 10, false, outputLanguage); + } + + /** + * Returns skills related to a given skill or set of skills. The service returns closely related skills in a sense that + * knowing the provided skills either implies knowledge about the returned related skills, or should make it considerably + * easier to acquire knowledge about them. + * @param skills The skills (and optionally, scores) for which the service should return related skills. The list can contain up to 50 skills. + * @param limit The maximum amount of suggested skills returned. The maximum is 25. + * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public SuggestSkillsResponse suggestSkillsFromSkills( + List skills, + int limit, + String outputLanguage) throws TxException { + SuggestSkillsFromSkillsRequest request = new SuggestSkillsFromSkillsRequest(); + request.Skills = skills; + request.Limit = limit; + request.OutputLanguage = outputLanguage; + + RequestBody body = createJsonBody(request); + Request apiRequest = new Request.Builder() + .url(_endpoints.desOntologySuggestSkillsFromSkills(_settings.SkillsIntelligenceIncludeCertifications)) + .post(body) + .build(); + + HttpResponse response = executeRequest(apiRequest, SuggestSkillsResponse.class, getBodyIfDebug(apiRequest)); + return response.getData(); + } + + /** + * Returns skills related to a given skill or set of skills. The service returns closely related skills in a sense that + * knowing the provided skills either implies knowledge about the returned related skills, or should make it considerably + * easier to acquire knowledge about them. + * @param skillIds The skill IDs for which the service should return related skills. The list can contain up to 50 skills. + * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public SuggestSkillsResponse suggestSkillsFromSkills(List skillIds, String outputLanguage) throws TxException { + return suggestSkillsFromSkills(skillIds.stream().map(s -> new SkillScore(s)).collect(Collectors.toList()), 25, outputLanguage); + } + + /** + * Suggests skills related to a job (but not in the job) based on the skills in the job. The service returns closely related skills in a sense that + * knowing the provided skills either implies knowledge about the returned related skills, or should make it considerably + * easier to acquire knowledge about them. + * @param job The job to suggest skills for (based on the skills in the job). + * @param limit The maximum amount of suggested skills returned. The maximum is 25. + * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public SuggestSkillsResponse suggestSkillsFromSkills( + ParsedJob job, + int limit, + String outputLanguage) throws TxException { + if(job != null && job.Skills != null && job.Skills.Normalized != null && job.Skills.Normalized.size() > 0){ + List skills = new ArrayList(); + int amountOfSkills = job.Skills.Normalized.size() > 50 ? 50 : job.Skills.Normalized.size(); + for(int i = 0; i < amountOfSkills; i++) { + skills.add(new SkillScore(job.Skills.Normalized.get(i).Id)); + } + + return suggestSkillsFromSkills(skills, limit, outputLanguage); + } + throw new IllegalArgumentException("The job must be parsed with V2 skills selected, and with skills normalization enabled"); + } + + /** + * Suggests skills related to a job (but not in the job) based on the skills in the job. The service returns closely related skills in a sense that + * knowing the provided skills either implies knowledge about the returned related skills, or should make it considerably + * easier to acquire knowledge about them. + * @param job The job to suggest skills for (based on the skills in the job). + * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public SuggestSkillsResponse suggestSkillsFromSkills(ParsedJob job, String outputLanguage) throws TxException { + return suggestSkillsFromSkills(job, 25, outputLanguage); + } + + /** + * Suggests skills related to a resume (but not in the resume) based on the skills in the resume. The service returns closely related skills in a sense that + * knowing the provided skills either implies knowledge about the returned related skills, or should make it considerably + * easier to acquire knowledge about them. + * @param resume The resume to suggest skills for (based on the skills in the resume). + * @param limit The maximum amount of suggested skills returned. The maximum is 25. + * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code + * @param weightSkillsByExperience Whether or not to give a higher weight to skills that the candidate has more experience with. + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public SuggestSkillsResponse suggestSkillsFromSkills( + ParsedResume resume, + int limit, + String outputLanguage, + boolean weightSkillsByExperience) throws TxException { + return suggestSkillsFromSkills(getNormalizedSkillsFromResume(resume, weightSkillsByExperience), limit, outputLanguage); + } + + /** + * Suggests skills related to a resume (but not in the resume) based on the skills in the resume. The service returns closely related skills in a sense that + * knowing the provided skills either implies knowledge about the returned related skills, or should make it considerably + * easier to acquire knowledge about them. + * @param resume The resume to suggest skills for (based on the skills in the resume). + * @param outputLanguage The language to use for the returned descriptions. If not provided, no descriptions are returned. Must be one of the supported ISO code + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public SuggestSkillsResponse suggestSkillsFromSkills(ParsedResume resume, String outputLanguage) throws TxException { + return suggestSkillsFromSkills(resume, 25, outputLanguage, true); + } + + /** + * Determines how closely related one set of skills is to another. The service defines closely related skills + * such that knowing a skill either implies knowledge about another skill, or should make it considerably + * easier to acquire knowledge about that skill. + * @param skillSetA A set of skills (and optionally, scores) to score against the other set of skills. The list can contain up to 50 skills. + * @param skillSetB A set of skills (and optionally, scores) to score against the other set of skills. The list can contain up to 50 skills. + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public SkillsSimilarityScoreResponse skillsSimilarityScore(List skillSetA, List skillSetB) throws TxException { + SkillsSimilarityScoreRequest request = new SkillsSimilarityScoreRequest(); + request.SkillsA = skillSetA; + request.SkillsB = skillSetB; + + RequestBody body = createJsonBody(request); + Request apiRequest = new Request.Builder() + .url(_endpoints.desOntologySkillsSimilarityScore(_settings.SkillsIntelligenceIncludeCertifications)) + .post(body) + .build(); + + HttpResponse response = executeRequest(apiRequest, SkillsSimilarityScoreResponse.class, getBodyIfDebug(apiRequest)); + return response.getData(); + } + + /** + * Generates a job description based on specified parameters. + * @param request The request body + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public GenerateJobResponse generateJobDescription(GenerateJobRequest request) throws TxException { + RequestBody body = createJsonBody(request); + Request apiRequest = new Request.Builder() + .url(_endpoints.jobDescriptionGenerate()) + .post(body) + .build(); + + HttpResponse response = executeRequest(apiRequest, GenerateJobResponse.class, getBodyIfDebug(apiRequest)); + return response.getData(); + } + + /** + * Takes a job title and suggests relevant skills. + * @param jobTitle The title of the job for which skills are being suggested. + * @param language Language of the suggested skills in ISO 639-1 code format. + * @param limit Maximum number of skills to suggest. If not specified this parameter defaults to 10. This value cannot exceed 50. + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public SuggestSkillsFromJobTitleResponse suggestSkillsFromJobTitle(String jobTitle, String language, Integer limit) throws TxException { + SuggestSkillsFromJobTitleRequest request = new SuggestSkillsFromJobTitleRequest(); + request.JobTitle = jobTitle; + request.Language = language; + request.Limit = limit; + + RequestBody body = createJsonBody(request); + Request apiRequest = new Request.Builder() + .url(_endpoints.jobDescriptionSuggestSkills()) + .post(body) + .build(); + + HttpResponse response = executeRequest(apiRequest, SuggestSkillsFromJobTitleResponse.class, getBodyIfDebug(apiRequest)); + return response.getData(); + } + + /** + * Takes a job title and suggests relevant skills. + * @param jobTitle The title of the job for which skills are being suggested. + * @return The API response body + * @throws TxException Thrown when an API error occurs + */ + public SuggestSkillsFromJobTitleResponse suggestSkillsFromJobTitle(String jobTitle) throws TxException { + return suggestSkillsFromJobTitle(jobTitle, "en", null); + } +} diff --git a/src/test/java/com/textkernel/tx/SDKTests.java b/src/test/java/com/textkernel/tx/SDKTests.java index 4bda43cc0..1b3989d3b 100644 --- a/src/test/java/com/textkernel/tx/SDKTests.java +++ b/src/test/java/com/textkernel/tx/SDKTests.java @@ -7,6 +7,7 @@ import com.textkernel.tx.exceptions.TxException; import com.textkernel.tx.models.api.matching.request.FilterCriteria; + import java.util.ArrayList; import static org.junit.jupiter.api.Assertions.*; import org.junit.jupiter.api.Test; @@ -16,10 +17,14 @@ public class SDKTests extends TestBase { @Test public void test401Error(){ DataCenter fakeDC = new DataCenter("https://api.us.textkernel.com/tx/v9/fake"); - TxClient client = new TxClient("1234", "1234", fakeDC); + TxClientSettings settings = new TxClientSettings(); + settings.AccountId = "1234"; + settings.ServiceKey = "1234"; + settings.DataCenter = fakeDC; + TxClient client = new TxClient(settings); try { - client.getAccountInfo(); + client.account().getAccountInfo(); } catch (TxException e){ assertEquals(401, e.HttpStatusCode); @@ -29,10 +34,14 @@ public void test401Error(){ @Test public void test500Message(){ DataCenter fakeDC = new DataCenter("https://thisisnotarealurlatall-akmeaoiaefoij.com/"); - TxClient client = new TxClient("1234", "1234", fakeDC); + TxClientSettings settings = new TxClientSettings(); + settings.AccountId = "1234"; + settings.ServiceKey = "1234"; + settings.DataCenter = fakeDC; + TxClient client = new TxClient(settings); try { - client.getAccountInfo(); + client.account().getAccountInfo(); } catch (TxException e){ assertEquals(500, e.HttpStatusCode); @@ -40,25 +49,20 @@ public void test500Message(){ } } - @Test - public void testSelfHostedDataCenter(){ - String url = "https://selfhosted.customer.com"; - DataCenter fakeDC = new DataCenter(url); - ApiEndpoints endpoints = new ApiEndpoints(fakeDC); - - assertEquals(url + "/account", endpoints.account()); - } - @Test public void testDebugRequestBody(){ DataCenter fakeDC = new DataCenter("https://thisisnotarealurlatall-akmeaoiaefoij.com/"); - TxClient client = new TxClient("1234", "1234", fakeDC); - client.ShowFullRequestBodyInExceptions = true; + TxClientSettings settings = new TxClientSettings(); + settings.AccountId = "1234"; + settings.ServiceKey = "1234"; + settings.DataCenter = fakeDC; + TxClient client = new TxClient(settings); + TxClient.ShowFullRequestBodyInExceptions = true; try { ArrayList index = new ArrayList<>(); index.add("testIndex"); - client.search(index, new FilterCriteria(), null, null); + client.searchMatchV1().search(index, new FilterCriteria(), null, null); } catch (TxException e){ String expectedRequest = "{\"IndexIdsToSearchInto\":[\"testIndex\"],\"FilterCriteria\":{\"UserDefinedTagsMustAllExist\":false,\"HasPatents\":false,\"HasSecurityCredentials\":false,\"IsAuthor\":false,\"IsPublicSpeaker\":false,\"IsMilitary\":false,\"EmployersMustAllBeCurrentEmployer\":false,\"SkillsMustAllExist\":false,\"IsTopStudent\":false,\"IsCurrentStudent\":false,\"IsRecentGraduate\":false,\"LanguagesKnownMustAllExist\":false}}"; diff --git a/src/test/java/com/textkernel/tx/TestBase.java b/src/test/java/com/textkernel/tx/TestBase.java index a6b3f1a83..cf18ab47e 100644 --- a/src/test/java/com/textkernel/tx/TestBase.java +++ b/src/test/java/com/textkernel/tx/TestBase.java @@ -11,6 +11,7 @@ import com.textkernel.tx.models.TxDate; import com.textkernel.tx.models.api.geocoding.GeocodeCredentials; import com.textkernel.tx.models.api.geocoding.GeocodeProvider; +import com.textkernel.tx.models.api.matchV2.MatchV2Environment; import com.textkernel.tx.models.api.parsing.ParseJobResponseValue; import com.textkernel.tx.models.api.parsing.ParseOptions; import com.textkernel.tx.models.api.parsing.ParseRequest; @@ -32,6 +33,7 @@ public abstract class TestBase { protected static TxClient Client; + protected static TxClient ClientDESv2; protected static GeocodeCredentials GeocodeCredentials; protected static ParsedResume TestParsedResume; @@ -48,9 +50,9 @@ private static class Credentials { } private static class TestDataCenter extends DataCenter { - public static TestDataCenter Local = new TestDataCenter("https://api-acc.us.textkernel.com/tx", "v10"); - protected TestDataCenter(String root, String version) { - super(root, version, true); + public static TestDataCenter Local = new TestDataCenter("https://api-acc.us.textkernel.com/tx/v10"); + protected TestDataCenter(String root) { + super(root); } } @@ -63,9 +65,21 @@ protected TestDataCenter(String root, String version) { GeocodeCredentials.Provider = GeocodeProvider.Google; GeocodeCredentials.ProviderKey = data.GeocodeProviderKey; - Client = new TxClient(data.AccountId, data.ServiceKey, TestDataCenter.Local); - - ParseResumeResponseValue parseResumeResponseValue = Client.parseResume(new ParseRequest(TestData.Resume, null)).Value; + TxClientSettings settings = new TxClientSettings(); + settings.AccountId = data.AccountId; + settings.ServiceKey = data.ServiceKey; + settings.DataCenter = TestDataCenter.Local; + Client = new TxClient(settings); + + TxClientSettings settingsV2 = new TxClientSettings(); + settingsV2.AccountId = data.AccountId; + settingsV2.ServiceKey = data.ServiceKey; + settingsV2.DataCenter = TestDataCenter.Local; + settingsV2.SkillsIntelligenceIncludeCertifications = true; + settingsV2.MatchV2Environment = MatchV2Environment.ACC; + ClientDESv2 = new TxClient(settingsV2); + + ParseResumeResponseValue parseResumeResponseValue = Client.parser().parseResume(new ParseRequest(TestData.Resume, null)).Value; TestParsedResume = parseResumeResponseValue.ResumeData; ParseOptions v2Options = new ParseOptions(); @@ -74,19 +88,19 @@ protected TestDataCenter(String root, String version) { v2Options.SkillsSettings = new SkillsSettings(); v2Options.SkillsSettings.Normalize = true; v2Options.SkillsSettings.TaxonomyVersion = "V2"; - parseResumeResponseValue = Client.parseResume(new ParseRequest(TestData.Resume, v2Options)).Value; + parseResumeResponseValue = Client.parser().parseResume(new ParseRequest(TestData.Resume, v2Options)).Value; TestParsedResumeV2 = parseResumeResponseValue.ResumeData; - parseResumeResponseValue = Client.parseResume(new ParseRequest(TestData.ResumeWithAddress, null)).Value; + parseResumeResponseValue = Client.parser().parseResume(new ParseRequest(TestData.ResumeWithAddress, null)).Value; TestParsedResumeWithAddress = parseResumeResponseValue.ResumeData; - ParseJobResponseValue parseJobResponseValue = Client.parseJob(new ParseRequest(TestData.JobOrder, null)).Value; + ParseJobResponseValue parseJobResponseValue = Client.parser().parseJob(new ParseRequest(TestData.JobOrder, null)).Value; TestParsedJob = parseJobResponseValue.JobData; - parseJobResponseValue = Client.parseJob(new ParseRequest(TestData.JobOrderWithAddress, null)).Value; + parseJobResponseValue = Client.parser().parseJob(new ParseRequest(TestData.JobOrderWithAddress, null)).Value; TestParsedJobWithAddress = parseJobResponseValue.JobData; - parseJobResponseValue = Client.parseJob(new ParseRequest(TestData.JobOrderTech, null)).Value; + parseJobResponseValue = Client.parser().parseJob(new ParseRequest(TestData.JobOrderTech, null)).Value; TestParsedJobTech = parseJobResponseValue.JobData; } catch (Exception e) { @@ -97,16 +111,21 @@ public Document getTestFileAsDocument(String filename) throws IOException { return new Document("./src/test/resources/" + filename); } + public static void delayForIndexSync() { + delayForIndexSync(1); + } + + public static void delayForIndexSync(long timeout) { try { - TimeUnit.SECONDS.sleep(1); + TimeUnit.SECONDS.sleep(timeout); } catch (Exception e) { } } public static void cleanUpIndex(String indexName) { try { - Client.deleteIndex(indexName); + Client.searchMatchV1().deleteIndex(indexName); } catch (Exception e) { } } diff --git a/src/test/java/com/textkernel/tx/integration/AIMatchingTests.java b/src/test/java/com/textkernel/tx/integration/AIMatchingTests.java index 903936355..42b24a9af 100644 --- a/src/test/java/com/textkernel/tx/integration/AIMatchingTests.java +++ b/src/test/java/com/textkernel/tx/integration/AIMatchingTests.java @@ -12,7 +12,6 @@ import com.textkernel.tx.models.api.matching.SearchResponseValue; import com.textkernel.tx.models.api.matching.request.FilterCriteria; import com.textkernel.tx.models.api.matching.request.PaginationSettings; -import com.textkernel.tx.models.api.matching.ui.GenerateUIResponse; import com.textkernel.tx.models.matching.IndexType; import okhttp3.OkHttpClient; import okhttp3.Request; @@ -47,13 +46,13 @@ public class AIMatchingTests extends TestBase { @BeforeAll static void setup() throws TxException { // create indexes - Client.createIndex(IndexType.Job, _jobIndexId); - Client.createIndex(IndexType.Resume, _resumeIndexId); + Client.searchMatchV1().createIndex(IndexType.Job, _jobIndexId); + Client.searchMatchV1().createIndex(IndexType.Resume, _resumeIndexId); delayForIndexSync(); // add a document to each index - Client.indexDocument(TestParsedJobTech, _jobIndexId, _documentId, null); - Client.indexDocument(TestParsedResume, _resumeIndexId, _documentId, null); + Client.searchMatchV1().indexDocument(TestParsedJobTech, _jobIndexId, _documentId, null); + Client.searchMatchV1().indexDocument(TestParsedResume, _resumeIndexId, _documentId, null); delayForIndexSync(); } @@ -74,42 +73,42 @@ private static Stream provideSearchTerms() { @MethodSource("provideSearchTerms") public void testSearch(String indexId, String validSearchTerm) { assertThrows(TxException.class, () -> { - Client.search(null, null, null, null); + Client.searchMatchV1().search(null, null, null, null); }); List indexesToQuery = new ArrayList<>(); indexesToQuery.add(indexId); assertThrows(TxException.class, () -> { - Client.search(indexesToQuery, null, null, null); + Client.searchMatchV1().search(indexesToQuery, null, null, null); }); FilterCriteria filterCritera = new FilterCriteria(); assertThrows(TxException.class, () -> { - Client.search(null, filterCritera, null, null); + Client.searchMatchV1().search(null, filterCritera, null, null); }); assertThrows(TxException.class, () -> { List indexes = new ArrayList<>(); indexes.add("fake-index-id"); - Client.search(indexes, filterCritera, null, null); + Client.searchMatchV1().search(indexes, filterCritera, null, null); }); assertThrows(TxException.class, () -> { - Client.search(indexesToQuery, filterCritera, null, null); + Client.searchMatchV1().search(indexesToQuery, filterCritera, null, null); }); filterCritera.SearchExpression = validSearchTerm; assertDoesNotThrow(() -> { PaginationSettings pageSettings = new PaginationSettings(); pageSettings.Take = 10; - SearchResponseValue response = Client.search(indexesToQuery, filterCritera, null, pageSettings).Value; + SearchResponseValue response = Client.searchMatchV1().search(indexesToQuery, filterCritera, null, pageSettings).Value; assertEquals(1, response.CurrentCount); assertEquals(1, response.TotalCount); }); filterCritera.SearchExpression = "ThisIsATermThatIsntInTheDocument"; assertDoesNotThrow(() -> { - SearchResponseValue response = Client.search(indexesToQuery, filterCritera, null, null).Value; + SearchResponseValue response = Client.searchMatchV1().search(indexesToQuery, filterCritera, null, null).Value; assertEquals(0, response.CurrentCount); assertEquals(0, response.TotalCount); }); @@ -119,18 +118,18 @@ public void testSearch(String indexId, String validSearchTerm) { public void testMatchJob() { assertThrows(TxException.class, () -> { - Client.match(TestParsedJobTech, null, null, null, null, 0); + Client.searchMatchV1().match(TestParsedJobTech, null, null, null, null, 0); }); assertDoesNotThrow(() -> { - MatchResponseValue matchResponse = Client.match(TestParsedJobTech, _jobsIndexes, null, null, null, 0).Value; + MatchResponseValue matchResponse = Client.searchMatchV1().match(TestParsedJobTech, _jobsIndexes, null, null, null, 0).Value; assertEquals(1, matchResponse.CurrentCount); assertEquals(1, matchResponse.TotalCount); assertEquals(1, matchResponse.Matches.size()); }); assertDoesNotThrow(() -> { - MatchResponseValue matchResponse = Client.match(TestParsedJobTech, _resumesIndexes, null, null, null, 0).Value; + MatchResponseValue matchResponse = Client.searchMatchV1().match(TestParsedJobTech, _resumesIndexes, null, null, null, 0).Value; assertEquals(1, matchResponse.CurrentCount); assertEquals(1, matchResponse.TotalCount); assertEquals(1, matchResponse.Matches.size()); @@ -140,18 +139,18 @@ public void testMatchJob() @Test public void testMatchResume() { assertThrows(TxException.class, () -> { - Client.match(TestParsedResume, null, null, null, null, 0); + Client.searchMatchV1().match(TestParsedResume, null, null, null, null, 0); }); assertDoesNotThrow(() -> { - MatchResponseValue matchResponse = Client.match(TestParsedResume, _jobsIndexes, null, null, null, 0).Value; + MatchResponseValue matchResponse = Client.searchMatchV1().match(TestParsedResume, _jobsIndexes, null, null, null, 0).Value; assertEquals(1, matchResponse.CurrentCount); assertEquals(1, matchResponse.TotalCount); assertEquals(1, matchResponse.Matches.size()); }); assertDoesNotThrow(() -> { - MatchResponseValue matchResponse = Client.match(TestParsedResume, _resumesIndexes, null, null, null, 0).Value; + MatchResponseValue matchResponse = Client.searchMatchV1().match(TestParsedResume, _resumesIndexes, null, null, null, 0).Value; assertEquals(1, matchResponse.CurrentCount); assertEquals(1, matchResponse.TotalCount); assertEquals(1, matchResponse.Matches.size()); @@ -161,199 +160,67 @@ public void testMatchResume() { @Test public void testMatchIndexedDocument() { assertThrows(IllegalArgumentException.class, () -> { - Client.match("", null, null, null, null, null, 0); + Client.searchMatchV1().match("", null, null, null, null, null, 0); }); assertThrows(IllegalArgumentException.class, () -> { - Client.match(null, _documentId, _resumesIndexes, null, null, null, 0); + Client.searchMatchV1().match(null, _documentId, _resumesIndexes, null, null, null, 0); }); assertThrows(IllegalArgumentException.class, () -> { - Client.match("", _documentId, _resumesIndexes, null, null, null, 0); + Client.searchMatchV1().match("", _documentId, _resumesIndexes, null, null, null, 0); }); assertThrows(IllegalArgumentException.class, () -> { - Client.match(" ", _documentId, _resumesIndexes, null, null, null, 0); + Client.searchMatchV1().match(" ", _documentId, _resumesIndexes, null, null, null, 0); }); assertThrows(IllegalArgumentException.class, () -> { - Client.match(_resumeIndexId, null, _resumesIndexes, null, null, null, 0); ; + Client.searchMatchV1().match(_resumeIndexId, null, _resumesIndexes, null, null, null, 0); ; }); assertThrows(IllegalArgumentException.class, () -> { - Client.match(_resumeIndexId, "", _resumesIndexes, null, null, null, 0); ; + Client.searchMatchV1().match(_resumeIndexId, "", _resumesIndexes, null, null, null, 0); ; }); assertThrows(IllegalArgumentException.class, () -> { - Client.match(_resumeIndexId, " ", _resumesIndexes, null, null, null, 0); ; + Client.searchMatchV1().match(_resumeIndexId, " ", _resumesIndexes, null, null, null, 0); ; }); assertThrows(TxException.class, () -> { - Client.match(_resumeIndexId, _documentId, null, null, null, null, 0); ; + Client.searchMatchV1().match(_resumeIndexId, _documentId, null, null, null, null, 0); ; }); assertThrows(TxException.class, () -> { - Client.match(_resumeIndexId, _documentId, new ArrayList(), null, null, null, 0); ; + Client.searchMatchV1().match(_resumeIndexId, _documentId, new ArrayList(), null, null, null, 0); ; }); assertDoesNotThrow(() -> { - MatchResponseValue matchResponse = Client.match(_resumeIndexId, _documentId, _resumesIndexes, null, null, null, 0).Value; + MatchResponseValue matchResponse = Client.searchMatchV1().match(_resumeIndexId, _documentId, _resumesIndexes, null, null, null, 0).Value; assertEquals(1, matchResponse.CurrentCount); assertEquals(1, matchResponse.TotalCount); assertEquals(1, matchResponse.Matches.size()); }); assertDoesNotThrow(() -> { - MatchResponseValue matchResponse = Client.match(_resumeIndexId, _documentId, _jobsIndexes, null, null, null, 0).Value; + MatchResponseValue matchResponse = Client.searchMatchV1().match(_resumeIndexId, _documentId, _jobsIndexes, null, null, null, 0).Value; assertEquals(1, matchResponse.CurrentCount); assertEquals(1, matchResponse.TotalCount); assertEquals(1, matchResponse.Matches.size()); }); assertDoesNotThrow(() -> { - MatchResponseValue matchResponse = Client.match(_jobIndexId, _documentId, _resumesIndexes, null, null, null, 0).Value; + MatchResponseValue matchResponse = Client.searchMatchV1().match(_jobIndexId, _documentId, _resumesIndexes, null, null, null, 0).Value; assertEquals(1, matchResponse.CurrentCount); assertEquals(1, matchResponse.TotalCount); assertEquals(1, matchResponse.Matches.size()); }); assertDoesNotThrow(() -> { - MatchResponseValue matchResponse = Client.match(_jobIndexId, _documentId, _jobsIndexes, null, null, null, 0).Value; + MatchResponseValue matchResponse = Client.searchMatchV1().match(_jobIndexId, _documentId, _jobsIndexes, null, null, null, 0).Value; assertEquals(1, matchResponse.CurrentCount); assertEquals(1, matchResponse.TotalCount); assertEquals(1, matchResponse.Matches.size()); }); } - - @Test - public void TestMatchUISearch() { - AtomicReference uiResponse = new AtomicReference<>(); - - assertThrows(TxException.class, () -> { - Client.ui(null).search(null, null, null, null); - }); - - assertThrows(TxException.class, () -> { - Client.ui(null).search(new ArrayList(), null, null, null); - }); - - assertDoesNotThrow(() -> { - uiResponse.set(Client.ui(null).search(_resumesIndexes, null, null, null)); - }); - - assertTrue(DoesURLExist(uiResponse.get().url)); - } - - @Test - public void testMatchUIMatchJob() { - AtomicReference uiResponse = new AtomicReference<>(); - - assertThrows(TxException.class, () -> { - Client.ui(null).match(TestParsedJobTech, null, null, null, null, 0); - }); - - assertDoesNotThrow(() -> { - uiResponse.set(Client.ui(null).match(TestParsedJobTech, _resumesIndexes, null, null, null, 0)); - }); - - assertTrue(DoesURLExist(uiResponse.get().url)); - - assertDoesNotThrow(() -> { - uiResponse.set(Client.ui(null).match(TestParsedJobTech, _jobsIndexes, null, null, null, 0)); - }); - - assertTrue(DoesURLExist(uiResponse.get().url)); - } - - @Test - public void testMatchUIMatchResume() { - AtomicReference uiResponse = new AtomicReference<>(); - - assertThrows(TxException.class, () -> { - Client.ui(null).match(TestParsedResume, null, null, null, null, 0); - }); - - assertDoesNotThrow(() -> { - uiResponse.set(Client.ui(null).match(TestParsedResume, _resumesIndexes, null, null, null, 0)); - assertTrue(DoesURLExist(uiResponse.get().url)); - }); - - assertDoesNotThrow(() -> { - uiResponse.set(Client.ui(null).match(TestParsedResume, _jobsIndexes, null, null, null, 0)); - assertTrue(DoesURLExist(uiResponse.get().url)); - }); - } - - @Test - public void TestMatchUIMatchIndexedDocument() { - assertThrows(IllegalArgumentException.class, () -> { - Client.ui(null).match("", null, null, null, null, null, 0); - }); - - assertThrows(IllegalArgumentException.class, () -> { - Client.ui(null).match(null, _documentId, _resumesIndexes, null, null, null, 0); - }); - - assertThrows(IllegalArgumentException.class, () -> { - Client.ui(null).match("", _documentId, _resumesIndexes, null, null, null, 0); - }); - - assertThrows(IllegalArgumentException.class, () -> { - Client.ui(null).match(" ", _documentId, _resumesIndexes, null, null, null, 0); - }); - - assertThrows(IllegalArgumentException.class, () -> { - Client.ui(null).match(_resumeIndexId, null, _resumesIndexes, null, null, null, 0); ; - }); - - assertThrows(IllegalArgumentException.class, () -> { - Client.ui(null).match(_resumeIndexId, "", _resumesIndexes, null, null, null, 0); ; - }); - - assertThrows(IllegalArgumentException.class, () -> { - Client.ui(null).match(_resumeIndexId, " ", _resumesIndexes, null, null, null, 0); ; - }); - - assertThrows(TxException.class, () -> { - Client.ui(null).match(_resumeIndexId, _documentId, null, null, null, null, 0); ; - }); - - assertThrows(TxException.class, () -> { - Client.ui(null).match(_resumeIndexId, _documentId, new ArrayList(), null, null, null, 0); ; - }); - - AtomicReference uiResponse = new AtomicReference<>(); - - assertDoesNotThrow(() -> { - uiResponse.set(Client.ui(null).match(_resumeIndexId, _documentId, _resumesIndexes, null, null, null, 0)); ; - assertTrue(DoesURLExist(uiResponse.get().url)); - }); - - assertDoesNotThrow(() -> { - uiResponse.set(Client.ui(null).match(_resumeIndexId, _documentId, _jobsIndexes, null, null, null, 0)); ; - assertTrue(DoesURLExist(uiResponse.get().url)); - }); - - assertDoesNotThrow(() -> { - uiResponse.set(Client.ui(null).match(_jobIndexId, _documentId, _resumesIndexes, null, null, null, 0)); ; - assertTrue(DoesURLExist(uiResponse.get().url)); - }); - - assertDoesNotThrow(() -> { - uiResponse.set(Client.ui(null).match(_jobIndexId, _documentId, _jobsIndexes, null, null, null, 0)); ; - assertTrue(DoesURLExist(uiResponse.get().url)); - }); - } - - private boolean DoesURLExist(String url) { - Request apiRequest = new Request.Builder() - .url(url) - .build(); - try { - return new OkHttpClient().newCall(apiRequest).execute().isSuccessful(); - } - catch (Exception e){ - return false; - } - } } diff --git a/src/test/java/com/textkernel/tx/integration/AccountTests.java b/src/test/java/com/textkernel/tx/integration/AccountTests.java index fa8c16cad..ad03b5be6 100644 --- a/src/test/java/com/textkernel/tx/integration/AccountTests.java +++ b/src/test/java/com/textkernel/tx/integration/AccountTests.java @@ -21,7 +21,7 @@ public void testGetAccount() throws Exception AtomicReference accountInfo = new AtomicReference<>(); assertDoesNotThrow(() -> { - accountInfo.set(Client.getAccountInfo()); + accountInfo.set(Client.account().getAccountInfo()); }); assertNotNull(accountInfo.get().Info.CustomerDetails.AccountId); diff --git a/src/test/java/com/textkernel/tx/integration/BimetricScoringTests.java b/src/test/java/com/textkernel/tx/integration/BimetricScoringTests.java index 11cd916ab..062aefc28 100644 --- a/src/test/java/com/textkernel/tx/integration/BimetricScoringTests.java +++ b/src/test/java/com/textkernel/tx/integration/BimetricScoringTests.java @@ -33,46 +33,46 @@ public class BimetricScoringTests extends TestBase { @Test public void testBimetricScoringResume() { assertThrows(TxException.class, () -> { - Client.bimetricScore(new ParsedResumeWithId(), new ArrayList(), null, null); + Client.searchMatchV1().bimetricScore(new ParsedResumeWithId(), new ArrayList(), null, null); }); assertThrows(TxException.class, () -> { - Client.bimetricScore(TestParsedResumeWithId, new ArrayList(), null, null); + Client.searchMatchV1().bimetricScore(TestParsedResumeWithId, new ArrayList(), null, null); }); assertThrows(TxException.class, () -> { List list = new ArrayList<>(); list.add(TestParsedResumeWithId); - Client.bimetricScore(new ParsedResumeWithId(), list, null, null); + Client.searchMatchV1().bimetricScore(new ParsedResumeWithId(), list, null, null); }); assertDoesNotThrow(() -> { List list = new ArrayList<>(); list.add(TestParsedResumeWithId); - Client.bimetricScore(TestParsedResumeWithId, list, null, null); + Client.searchMatchV1().bimetricScore(TestParsedResumeWithId, list, null, null); }); } @Test public void testBimetricScoringJob() { assertThrows(TxException.class, () -> { - Client.bimetricScore(new ParsedJobWithId(), new ArrayList(), null, null); + Client.searchMatchV1().bimetricScore(new ParsedJobWithId(), new ArrayList(), null, null); }); assertThrows(TxException.class, () -> { - Client.bimetricScore(TestParsedJobWithId, new ArrayList(), null, null); + Client.searchMatchV1().bimetricScore(TestParsedJobWithId, new ArrayList(), null, null); }); assertThrows(TxException.class, () -> { List list = new ArrayList<>(); list.add(TestParsedJobWithId); - Client.bimetricScore(new ParsedJobWithId(), list, null, null); + Client.searchMatchV1().bimetricScore(new ParsedJobWithId(), list, null, null); }); assertDoesNotThrow(() -> { List list = new ArrayList<>(); list.add(TestParsedJobWithId); - Client.bimetricScore(TestParsedJobWithId, list, null, null); + Client.searchMatchV1().bimetricScore(TestParsedJobWithId, list, null, null); }); } } diff --git a/src/test/java/com/textkernel/tx/integration/DataEnrichmentServiceTests.java b/src/test/java/com/textkernel/tx/integration/DataEnrichmentServiceTests.java index 98c69835d..aa4218e7b 100644 --- a/src/test/java/com/textkernel/tx/integration/DataEnrichmentServiceTests.java +++ b/src/test/java/com/textkernel/tx/integration/DataEnrichmentServiceTests.java @@ -23,14 +23,14 @@ public class DataEnrichmentServiceTests extends TestBase { @Test public void testSkillsTaxonomy() { assertDoesNotThrow(() -> { - Client.getSkillsTaxonomy(TaxonomyFormat.json); + Client.skillsIntelligence().getSkillsTaxonomy(TaxonomyFormat.json); }); } @Test public void testSkillsMetadata() { assertDoesNotThrow(() -> { - Client.getSkillsTaxonomyMetadata(); + Client.skillsIntelligence().getSkillsTaxonomyMetadata(); }); } @@ -41,7 +41,7 @@ public void testSkillAutoComplete() { languages.add("en"); ArrayList types = new ArrayList(); types.add("all"); - Client.autocompleteSkill("soft", languages, "en", types, 10); + Client.skillsIntelligence().autocompleteSkill("soft", languages, "en", types, 10); }); } @@ -54,7 +54,7 @@ public void testSkillAutoCompleteV2() { languages.add("en"); ArrayList types = new ArrayList(); types.add("certification"); - wrapper[0] = Client.autocompleteSkillV2("soft", languages, "en", types, 10); + wrapper[0] = ClientDESv2.skillsIntelligence().autocompleteSkill("soft", languages, "en", types, 10); }); assertNotNull(wrapper[0].Value); @@ -67,7 +67,7 @@ public void testSkillsLookup() { assertDoesNotThrow(() -> { ArrayList skillIds = new ArrayList(); skillIds.add("KS120B874P2P6BK1MQ0T"); - Client.lookupSkills(skillIds, "en"); + Client.skillsIntelligence().lookupSkills(skillIds, "en"); }); } @@ -76,28 +76,28 @@ public void testSkillsNormalize() { assertDoesNotThrow(() -> { ArrayList skills = new ArrayList(); skills.add("Microsoft excel"); - Client.normalizeSkills(skills, "en", "en"); + Client.skillsIntelligence().normalizeSkills(skills, "en", "en"); }); } @Test public void testSkillsExtract() { assertDoesNotThrow(() -> { - Client.extractSkills("Microsoft, developer python, software, clerical office assistant, excel", "en", "en", 0.5f); + Client.skillsIntelligence().extractSkills("Microsoft, developer python, software, clerical office assistant, excel", "en", "en", 0.5f); }); } @Test public void testProfessionsTaxonomy() { assertDoesNotThrow(() -> { - Client.getProfessionsTaxonomy("en",TaxonomyFormat.json); + Client.skillsIntelligence().getProfessionsTaxonomy("en",TaxonomyFormat.json); }); } @Test public void testProfessionsMetadata() { assertDoesNotThrow(() -> { - Client.getProfessionsTaxonomyMetadata(); + Client.skillsIntelligence().getProfessionsTaxonomyMetadata(); }); } @@ -106,7 +106,7 @@ public void testProfessionsAutoComplete() { assertDoesNotThrow(() -> { ArrayList languages = new ArrayList(); languages.add("en"); - Client.autocompleteProfession("soft",languages , "en", 10 ); + Client.skillsIntelligence().autocompleteProfession("soft",languages , "en", 10 ); }); } @@ -115,7 +115,7 @@ public void testProfessionsNormalize() { assertDoesNotThrow(() -> { ArrayList jobTitles = new ArrayList(); jobTitles.add("Software Engineer"); - Client.normalizeProfessions(jobTitles, "en", "en"); + Client.skillsIntelligence().normalizeProfessions(jobTitles, "en", "en"); }); } @@ -124,14 +124,14 @@ public void testProfessionsLookup() { assertDoesNotThrow(() -> { ArrayList codeIds = new ArrayList(); codeIds.add(2000); - Client.lookupProfessions(codeIds, "en"); + Client.skillsIntelligence().lookupProfessions(codeIds, "en"); }); } @Test public void testCompareProfessions() { assertDoesNotThrow(() -> { - Client.compareProfessions(696, 3178, "en"); + Client.skillsIntelligence().compareProfessions(696, 3178, "en"); }); } @@ -142,7 +142,7 @@ public void testCompareSkillsToProfessions() { skills.add(new SkillScore("KS120076FGP5WGWYMP0F")); skills.add(new SkillScore("KS04UWLJBN9X1M3N0PZ4")); - Client.compareSkillsToProfessions(696, "en", skills); + Client.skillsIntelligence().compareSkillsToProfessions(696, "en", skills); }); } @@ -151,7 +151,7 @@ public void testSuggestSkillsFromProfessions() { assertDoesNotThrow(() -> { ArrayList professionCodeIds = new ArrayList(); professionCodeIds.add(696); - Client.suggestSkillsFromProfessions(professionCodeIds, 10, null); + Client.skillsIntelligence().suggestSkillsFromProfessions(professionCodeIds, 10, null); }); } @@ -162,7 +162,7 @@ public void testSuggestSkillsFromSkills() { skillIds.add("KS120076FGP5WGWYMP0F"); skillIds.add("KS125HH5XDBPZT3RFGZZ"); skillIds.add("KS124PR62MV42B5C9S9F"); - Client.suggestSkillsFromSkills(skillIds, null); + Client.skillsIntelligence().suggestSkillsFromSkills(skillIds, null); }); } @@ -173,7 +173,7 @@ public void testSuggestProfessions() { skillIds.add("KS120076FGP5WGWYMP0F"); skillIds.add("KS125HH5XDBPZT3RFGZZ"); skillIds.add("KS124PR62MV42B5C9S9F"); - Client.suggestProfessionsFromSkills(skillIds, null); + Client.skillsIntelligence().suggestProfessionsFromSkills(skillIds, null); }); } @@ -184,7 +184,7 @@ public void testSkillsSimilarityScore() { skillIds.add(new SkillScore("KS120076FGP5WGWYMP0F")); skillIds.add(new SkillScore("KS125HH5XDBPZT3RFGZZ")); skillIds.add(new SkillScore("KS124PR62MV42B5C9S9F")); - Client.skillsSimilarityScore(skillIds, skillIds); + Client.skillsIntelligence().skillsSimilarityScore(skillIds, skillIds); }); } } \ No newline at end of file diff --git a/src/test/java/com/textkernel/tx/integration/FormatterTests.java b/src/test/java/com/textkernel/tx/integration/FormatterTests.java index fe9b4fac3..58edf56e1 100644 --- a/src/test/java/com/textkernel/tx/integration/FormatterTests.java +++ b/src/test/java/com/textkernel/tx/integration/FormatterTests.java @@ -23,7 +23,7 @@ public void testFormatResume() { byte[] templateBytes = java.util.Base64.getDecoder().decode(templateStr); FormatResumeRequest request = new FormatResumeRequest(TestParsedResume, templateBytes, OutputDocumentFormat.DOCX); - FormatResumeResponse response = Client.formatResume(request); + FormatResumeResponse response = Client.formatter().formatResume(request); assertNotNull(response.Value.DocumentAsBase64String); }); diff --git a/src/test/java/com/textkernel/tx/integration/GeocodingTests.java b/src/test/java/com/textkernel/tx/integration/GeocodingTests.java index 733d1d86f..089a6e696 100644 --- a/src/test/java/com/textkernel/tx/integration/GeocodingTests.java +++ b/src/test/java/com/textkernel/tx/integration/GeocodingTests.java @@ -8,7 +8,7 @@ import com.textkernel.tx.TestBase; import com.textkernel.tx.exceptions.TxException; import com.textkernel.tx.models.api.geocoding.Address; -import com.textkernel.tx.models.api.indexes.IndexSingleDocumentInfo; +import com.textkernel.tx.models.api.indexes.IndexingOptionsGeneric; import com.textkernel.tx.models.matching.IndexType; import org.junit.jupiter.api.Test; @@ -19,21 +19,21 @@ public class GeocodingTests extends TestBase { @Test public void testResumeNoAddress() { assertThrows(TxException.class, () -> { - Client.geocode(TestParsedResume, GeocodeCredentials); + Client.geocoder().geocode(TestParsedResume, GeocodeCredentials); }); assertThrows(TxException.class, () -> { - Client.geocode(TestParsedResume, null); + Client.geocoder().geocode(TestParsedResume, null); }); assertThrows(TxException.class, () -> { - Client.geocode(TestParsedResume, new Address(), GeocodeCredentials); + Client.geocoder().geocode(TestParsedResume, new Address(), GeocodeCredentials); }); assertThrows(TxException.class, () -> { Address addr = new Address(); addr.CountryCode = "US"; - Client.geocode(TestParsedResume, addr, GeocodeCredentials); + Client.geocoder().geocode(TestParsedResume, addr, GeocodeCredentials); }); assertDoesNotThrow(() -> { @@ -41,32 +41,32 @@ public void testResumeNoAddress() { addr.CountryCode = "US"; addr.Municipality = "Dallas"; addr.Region = "TX"; - Client.geocode(TestParsedResume, addr, GeocodeCredentials); + Client.geocoder().geocode(TestParsedResume, addr, GeocodeCredentials); }); assertDoesNotThrow(() -> { - Client.geocode(TestParsedResumeWithAddress, GeocodeCredentials); + Client.geocoder().geocode(TestParsedResumeWithAddress, GeocodeCredentials); }); } @Test public void testJobNoAddress() { assertThrows(TxException.class, () -> { - Client.geocode(TestParsedJob, GeocodeCredentials); + Client.geocoder().geocode(TestParsedJob, GeocodeCredentials); }); assertThrows(TxException.class, () -> { - Client.geocode(TestParsedJob, null, GeocodeCredentials); + Client.geocoder().geocode(TestParsedJob, null, GeocodeCredentials); }); assertThrows(TxException.class, () -> { - Client.geocode(TestParsedJob, new Address(), GeocodeCredentials); + Client.geocoder().geocode(TestParsedJob, new Address(), GeocodeCredentials); }); assertThrows(TxException.class, () -> { Address addr = new Address(); addr.CountryCode = "US"; - Client.geocode(TestParsedJob, addr, GeocodeCredentials); + Client.geocoder().geocode(TestParsedJob, addr, GeocodeCredentials); }); assertDoesNotThrow(() -> { @@ -74,11 +74,11 @@ public void testJobNoAddress() { addr.CountryCode = "US"; addr.Municipality = "Dallas"; addr.Region = "TX"; - Client.geocode(TestParsedJob, addr, GeocodeCredentials); + Client.geocoder().geocode(TestParsedJob, addr, GeocodeCredentials); }); assertDoesNotThrow(() -> { - Client.geocode(TestParsedJobWithAddress, GeocodeCredentials); + Client.geocoder().geocode(TestParsedJobWithAddress, GeocodeCredentials); }); } @@ -88,38 +88,38 @@ public void testResumeGeocodeIndex() throws TxException { String documentId = "1"; try { - Client.createIndex(IndexType.Resume, indexId); + Client.searchMatchV1().createIndex(IndexType.Resume, indexId); // missing indexing options assertThrows(TxException.class, () -> { - Client.geocodeAndIndex(TestParsedResumeWithAddress, null, false, GeocodeCredentials); + Client.geocoder().geocodeAndIndex(TestParsedResumeWithAddress, null, false, GeocodeCredentials); }); // empty indexing options - IndexSingleDocumentInfo indexingOptions = new IndexSingleDocumentInfo(); + IndexingOptionsGeneric indexingOptions = new IndexingOptionsGeneric("", "", null); assertThrows(TxException.class, () -> { - Client.geocodeAndIndex(TestParsedResumeWithAddress, indexingOptions, false, GeocodeCredentials); + Client.geocoder().geocodeAndIndex(TestParsedResumeWithAddress, indexingOptions, false, GeocodeCredentials); }); // missing documentid indexingOptions.IndexId = indexId; assertThrows(TxException.class, () -> { - Client.geocodeAndIndex(TestParsedResumeWithAddress, indexingOptions, false, GeocodeCredentials); + Client.geocoder().geocodeAndIndex(TestParsedResumeWithAddress, indexingOptions, false, GeocodeCredentials); }); indexingOptions.DocumentId = documentId; // not enough data points to index assertThrows(TxException.class, () -> { - Client.geocodeAndIndex(TestParsedResume, indexingOptions, false, GeocodeCredentials); + Client.geocoder().geocodeAndIndex(TestParsedResume, indexingOptions, false, GeocodeCredentials); }); assertDoesNotThrow(() -> { - Client.geocodeAndIndex(TestParsedResumeWithAddress, indexingOptions, false, GeocodeCredentials); + Client.geocoder().geocodeAndIndex(TestParsedResumeWithAddress, indexingOptions, false, GeocodeCredentials); }); assertDoesNotThrow(() -> { - Client.getResume(indexId, documentId); + Client.searchMatchV1().getResume(indexId, documentId); }); } finally { @@ -133,38 +133,38 @@ public void testJobGeocodeIndex() throws TxException { String documentId = "1"; try { - Client.createIndex(IndexType.Job, indexId); + Client.searchMatchV1().createIndex(IndexType.Job, indexId); // missing indexing options assertThrows(TxException.class, () -> { - Client.geocodeAndIndex(TestParsedJobWithAddress, null, false, GeocodeCredentials); + Client.geocoder().geocodeAndIndex(TestParsedJobWithAddress, null, false, GeocodeCredentials); }); // empty indexing options - IndexSingleDocumentInfo indexingOptions = new IndexSingleDocumentInfo(); + IndexingOptionsGeneric indexingOptions = new IndexingOptionsGeneric("", "", null); assertThrows(TxException.class, () -> { - Client.geocodeAndIndex(TestParsedJobWithAddress, indexingOptions, false, GeocodeCredentials); + Client.geocoder().geocodeAndIndex(TestParsedJobWithAddress, indexingOptions, false, GeocodeCredentials); }); // missing documentid indexingOptions.IndexId = indexId; assertThrows(TxException.class, () -> { - Client.geocodeAndIndex(TestParsedJobWithAddress, indexingOptions, false, GeocodeCredentials); + Client.geocoder().geocodeAndIndex(TestParsedJobWithAddress, indexingOptions, false, GeocodeCredentials); }); indexingOptions.DocumentId = documentId; // not enough data points to index assertThrows(TxException.class, () -> { - Client.geocodeAndIndex(TestParsedJob, indexingOptions, false, GeocodeCredentials); + Client.geocoder().geocodeAndIndex(TestParsedJob, indexingOptions, false, GeocodeCredentials); }); assertDoesNotThrow(() -> { - Client.geocodeAndIndex(TestParsedJobWithAddress, indexingOptions, false, GeocodeCredentials); + Client.geocoder().geocodeAndIndex(TestParsedJobWithAddress, indexingOptions, false, GeocodeCredentials); }); assertDoesNotThrow(() -> { - Client.getJob(indexId, documentId); + Client.searchMatchV1().getJob(indexId, documentId); }); } finally { diff --git a/src/test/java/com/textkernel/tx/integration/IndexTests.java b/src/test/java/com/textkernel/tx/integration/IndexTests.java index 5061d07ab..928d0b961 100644 --- a/src/test/java/com/textkernel/tx/integration/IndexTests.java +++ b/src/test/java/com/textkernel/tx/integration/IndexTests.java @@ -37,7 +37,7 @@ private boolean doesIndexExist(String indexName) { List indexes = null; try { - indexes = Client.getAllIndexes().Value; + indexes = Client.searchMatchV1().getAllIndexes().Value; } catch (TxException e) { return false; @@ -58,11 +58,11 @@ private static Stream provideBadIndexNames() { @MethodSource("provideBadIndexNames") public void testCreateIndexBadInput(String indexName) { assertThrows(IllegalArgumentException.class, () -> { - Client.createIndex(IndexType.Job, indexName); + Client.searchMatchV1().createIndex(IndexType.Job, indexName); }); assertThrows(IllegalArgumentException.class, () -> { - Client.createIndex(IndexType.Resume, indexName); + Client.searchMatchV1().createIndex(IndexType.Resume, indexName); }); } @@ -71,7 +71,7 @@ public void testCreateIndexBadInput(String indexName) { @MethodSource("provideBadIndexNames") public void testdeleteIndexBadInput(String indexName) { assertThrows(IllegalArgumentException.class, () -> { - Client.deleteIndex(indexName); + Client.searchMatchV1().deleteIndex(indexName); }); } @@ -82,19 +82,19 @@ public void testIndexLifecycle(IndexType indexType) { try { // verify index doesn't exist - Client.getAllIndexes(); + Client.searchMatchV1().getAllIndexes(); assertFalse(doesIndexExist(indexName)); // create index assertDoesNotThrow(() -> { - Client.createIndex(indexType, indexName); + Client.searchMatchV1().createIndex(indexType, indexName); }); delayForIndexSync(); // create index already exists TxException txException = assertThrows(TxException.class, () -> { - Client.createIndex(indexType, indexName); + Client.searchMatchV1().createIndex(indexType, indexName); }); assertEquals(TxErrorCodes.DuplicateAsset, txException.TxErrorCode); @@ -104,7 +104,7 @@ public void testIndexLifecycle(IndexType indexType) { // delete the index assertDoesNotThrow(() -> { - Client.deleteIndex(indexName); + Client.searchMatchV1().deleteIndex(indexName); }); delayForIndexSync(); @@ -114,7 +114,7 @@ public void testIndexLifecycle(IndexType indexType) { // try to delete an index that doesn't exist txException = assertThrows(TxException.class, () -> { - Client.deleteIndex(indexName); + Client.searchMatchV1().deleteIndex(indexName); }); assertEquals(TxErrorCodes.DataNotFound, txException.TxErrorCode); } catch (TxException e) { @@ -131,40 +131,40 @@ public void testResumeLifeCycle() throws TxException { try { // verify can't retrieve a document that doesn't exist TxException txException = assertThrows(TxException.class, () -> { - Client.getResume(resumeIndexId, documentId); + Client.searchMatchV1().getResume(resumeIndexId, documentId); }); assertEquals(TxErrorCodes.DataNotFound, TxErrorCodes.DataNotFound); // verify can't add document to an index that doesn't exist txException = assertThrows(TxException.class, () -> { - Client.indexDocument(TestParsedResume, resumeIndexId, documentId, null); + Client.searchMatchV1().indexDocument(TestParsedResume, resumeIndexId, documentId, null); }); assertEquals(TxErrorCodes.DataNotFound, TxErrorCodes.DataNotFound); // create the index - Client.createIndex(IndexType.Resume, resumeIndexId); + Client.searchMatchV1().createIndex(IndexType.Resume, resumeIndexId); delayForIndexSync(); // verify document still doesn't exist txException = assertThrows(TxException.class, () -> { - Client.getResume(resumeIndexId, documentId); + Client.searchMatchV1().getResume(resumeIndexId, documentId); }); assertEquals(TxErrorCodes.DataNotFound, TxErrorCodes.DataNotFound); // add resume to index - Client.indexDocument(TestParsedResume, resumeIndexId, documentId, null); + Client.searchMatchV1().indexDocument(TestParsedResume, resumeIndexId, documentId, null); delayForIndexSync(); // confirm you can now retrieve the resume - Client.getResume(resumeIndexId, documentId); + Client.searchMatchV1().getResume(resumeIndexId, documentId); // add v2 skills resume to index - Client.indexDocument(TestParsedResumeV2, resumeIndexId, documentId, null); + Client.searchMatchV1().indexDocument(TestParsedResumeV2, resumeIndexId, documentId, null); delayForIndexSync(); // confirm you can now retrieve the resume - Client.getResume(resumeIndexId, documentId); + Client.searchMatchV1().getResume(resumeIndexId, documentId); // confirm the resume shows up in searches List indexesToQuery = new ArrayList<>(); @@ -174,7 +174,7 @@ public void testResumeLifeCycle() throws TxException { filterCriteria.DocumentIds = new ArrayList<>(); filterCriteria.DocumentIds.add(documentId); - SearchResponseValue searchResponse = Client.search(indexesToQuery, filterCriteria, null, null).Value; + SearchResponseValue searchResponse = Client.searchMatchV1().search(indexesToQuery, filterCriteria, null, null).Value; assertEquals(1, searchResponse.TotalCount); assertEquals(1, searchResponse.CurrentCount); assertEquals(documentId, searchResponse.Matches.get(0).Id); @@ -182,43 +182,43 @@ public void testResumeLifeCycle() throws TxException { // update the resume List userDefinedTags = new ArrayList<>(); userDefinedTags.add("userDefinedTag1"); - Client.updateResumeUserDefinedTags(resumeIndexId, documentId, + Client.searchMatchV1().updateResumeUserDefinedTags(resumeIndexId, documentId, userDefinedTags, UserDefinedTagsMethod.Overwrite); delayForIndexSync(); // verify those updates have taken effect filterCriteria.UserDefinedTags = userDefinedTags; - searchResponse = Client.search(indexesToQuery, filterCriteria, null, null).Value; + searchResponse = Client.searchMatchV1().search(indexesToQuery, filterCriteria, null, null).Value; assertEquals(1, searchResponse.TotalCount); assertEquals(1, searchResponse.CurrentCount); assertEquals(documentId, searchResponse.Matches.get(0).Id); // confirm you can retrieve the tags - ParsedResume resume = Client.getResume(resumeIndexId, documentId).Value; + ParsedResume resume = Client.searchMatchV1().getResume(resumeIndexId, documentId).Value; assertEquals(1, resume.UserDefinedTags.size()); assertEquals(userDefinedTags.get(0), resume.UserDefinedTags.get(0)); // delete the document - Client.deleteDocument(resumeIndexId, documentId); + Client.searchMatchV1().deleteDocument(resumeIndexId, documentId); delayForIndexSync(); // verify can't retrieve a document that doesn't exist txException = assertThrows(TxException.class, () -> { - Client.getResume(resumeIndexId, documentId); + Client.searchMatchV1().getResume(resumeIndexId, documentId); }); assertEquals(TxErrorCodes.DataNotFound, txException.TxErrorCode); txException = assertThrows(TxException.class, () -> { - Client.deleteDocument(resumeIndexId, documentId); + Client.searchMatchV1().deleteDocument(resumeIndexId, documentId); }); assertEquals(TxErrorCodes.DataNotFound, txException.TxErrorCode); - Client.deleteIndex(resumeIndexId); + Client.searchMatchV1().deleteIndex(resumeIndexId); delayForIndexSync(); txException = assertThrows(TxException.class, () -> { - Client.deleteDocument(resumeIndexId, documentId); + Client.searchMatchV1().deleteDocument(resumeIndexId, documentId); }); assertEquals(TxErrorCodes.DataNotFound, TxErrorCodes.DataNotFound); } @@ -234,32 +234,32 @@ public void testJobLifeCycle() { try { // verify can't retrieve a document that doesn't exist assertThrows(TxException.class, () -> { - Client.getJob(jobIndexId, documentId); + Client.searchMatchV1().getJob(jobIndexId, documentId); }); assertEquals(TxErrorCodes.DataNotFound, TxErrorCodes.DataNotFound); // verify can't add document to an index that doesn't exist assertThrows(TxException.class, () -> { - Client.indexDocument(TestParsedJob, jobIndexId, documentId, null); + Client.searchMatchV1().indexDocument(TestParsedJob, jobIndexId, documentId, null); }); assertEquals(TxErrorCodes.DataNotFound, TxErrorCodes.DataNotFound); // create the index - Client.createIndex(IndexType.Job, jobIndexId); + Client.searchMatchV1().createIndex(IndexType.Job, jobIndexId); delayForIndexSync(); // verify document still doesn't exist assertThrows(TxException.class, () -> { - Client.getJob(jobIndexId, documentId); + Client.searchMatchV1().getJob(jobIndexId, documentId); }); assertEquals(TxErrorCodes.DataNotFound, TxErrorCodes.DataNotFound); // add resume to index - Client.indexDocument(TestParsedJob, jobIndexId, documentId, null); + Client.searchMatchV1().indexDocument(TestParsedJob, jobIndexId, documentId, null); delayForIndexSync(); // confirm you can now retrieve the resume - Client.getJob(jobIndexId, documentId); + Client.searchMatchV1().getJob(jobIndexId, documentId); // confirm the resume shows up in searches List indexesToQuery = new ArrayList<>(); @@ -269,7 +269,7 @@ public void testJobLifeCycle() { filterCriteria.DocumentIds = new ArrayList<>(); filterCriteria.DocumentIds.add(documentId); - SearchResponseValue searchResponse = Client.search(indexesToQuery, filterCriteria, null, null).Value; + SearchResponseValue searchResponse = Client.searchMatchV1().search(indexesToQuery, filterCriteria, null, null).Value; assertEquals(1, searchResponse.TotalCount); assertEquals(1, searchResponse.CurrentCount); assertEquals(documentId, searchResponse.Matches.get(0).Id); @@ -277,43 +277,43 @@ public void testJobLifeCycle() { // update the resume List userDefinedTags = new ArrayList<>(); userDefinedTags.add("userDefinedTag1"); - Client.updateJobUserDefinedTags(jobIndexId, documentId, + Client.searchMatchV1().updateJobUserDefinedTags(jobIndexId, documentId, userDefinedTags, UserDefinedTagsMethod.Overwrite); delayForIndexSync(); // verify those updates have taken effect filterCriteria.UserDefinedTags = userDefinedTags; - searchResponse = Client.search(indexesToQuery, filterCriteria, null, null).Value; + searchResponse = Client.searchMatchV1().search(indexesToQuery, filterCriteria, null, null).Value; assertEquals(1, searchResponse.TotalCount); assertEquals(1, searchResponse.CurrentCount); assertEquals(documentId, searchResponse.Matches.get(0).Id); // confirm you can retrieve the tags - ParsedJob job = Client.getJob(jobIndexId, documentId).Value; + ParsedJob job = Client.searchMatchV1().getJob(jobIndexId, documentId).Value; assertEquals(1, job.UserDefinedTags.size()); assertEquals(userDefinedTags.get(0), job.UserDefinedTags.get(0)); // delete the document - Client.deleteDocument(jobIndexId, documentId); + Client.searchMatchV1().deleteDocument(jobIndexId, documentId); delayForIndexSync(); // verify can't retrieve a document that doesn't exist assertThrows(TxException.class, () -> { - Client.getJob(jobIndexId, documentId); + Client.searchMatchV1().getJob(jobIndexId, documentId); }); assertEquals(TxErrorCodes.DataNotFound, TxErrorCodes.DataNotFound); assertThrows(TxException.class, () -> { - Client.deleteDocument(jobIndexId, documentId); + Client.searchMatchV1().deleteDocument(jobIndexId, documentId); }); assertEquals(TxErrorCodes.DataNotFound, TxErrorCodes.DataNotFound); - Client.deleteIndex(jobIndexId); + Client.searchMatchV1().deleteIndex(jobIndexId); delayForIndexSync(); assertThrows(TxException.class, () -> { - Client.deleteDocument(jobIndexId, documentId); + Client.searchMatchV1().deleteDocument(jobIndexId, documentId); }); assertEquals(TxErrorCodes.DataNotFound, TxErrorCodes.DataNotFound); } diff --git a/src/test/java/com/textkernel/tx/integration/MatchV2Tests.java b/src/test/java/com/textkernel/tx/integration/MatchV2Tests.java new file mode 100644 index 000000000..2805b9679 --- /dev/null +++ b/src/test/java/com/textkernel/tx/integration/MatchV2Tests.java @@ -0,0 +1,162 @@ +package com.textkernel.tx.integration; + +import static org.junit.jupiter.api.Assertions.assertDoesNotThrow; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNotEquals; +import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.junit.jupiter.api.Assertions.assertTrue; + +import java.io.IOException; +import java.util.Arrays; +import java.util.UUID; +import java.util.stream.Stream; + +import org.junit.jupiter.api.AfterAll; +import org.junit.jupiter.api.BeforeAll; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.Arguments; +import org.junit.jupiter.params.provider.MethodSource; + +import com.textkernel.tx.TestBase; +import com.textkernel.tx.exceptions.TxException; +import com.textkernel.tx.models.Document; +import com.textkernel.tx.models.api.indexes.IndexingOptionsGeneric; +import com.textkernel.tx.models.api.matchV2.MatchV2Environment; +import com.textkernel.tx.models.api.matchV2.autocomplete.AutocompleteCandidatesField; +import com.textkernel.tx.models.api.matchV2.autocomplete.AutocompleteJobsField; +import com.textkernel.tx.models.api.matchV2.autocomplete.AutocompleteResponse; +import com.textkernel.tx.models.api.matchV2.documents.DocumentSource; +import com.textkernel.tx.models.api.matchV2.documents.DocumentType; +import com.textkernel.tx.models.api.matchV2.querying.Options; +import com.textkernel.tx.models.api.matchV2.querying.SearchQuery; +import com.textkernel.tx.models.api.matchV2.querying.results.ResultItem; +import com.textkernel.tx.models.api.matchV2.querying.results.SearchResult; +import com.textkernel.tx.models.api.parsing.ParseOptions; +import com.textkernel.tx.models.api.parsing.ParseRequest; +import com.textkernel.tx.models.api.parsing.ParseResumeResponse; + +public class MatchV2Tests extends TestBase { + + private static final String _documentId = "1"; + + @BeforeAll + static void setup() throws TxException { + // add a document to each index + ClientDESv2.searchMatchV2().addJob(_documentId, TestParsedJobTech, null, null); + ClientDESv2.searchMatchV2().addCandidate(_documentId, TestParsedResume, null, false, null); + delayForIndexSync(5); + } + + @AfterAll + static void done() throws TxException { + ClientDESv2.searchMatchV2().deleteCandidates(Arrays.asList(_documentId)); + ClientDESv2.searchMatchV2().deleteJobs(Arrays.asList(_documentId)); + } + + private static Stream provideSearchTerms() { + return Stream.of( + Arguments.of("Developer"), + Arguments.of("VB6") + ); + } + + @ParameterizedTest + @MethodSource("provideSearchTerms") + public void testSearch(String validSearchTerm) { + assertThrows(TxException.class, () -> { + ClientDESv2.searchMatchV2().searchCandidates(null, null); + }); + + SearchQuery query = new SearchQuery(); + assertThrows(TxException.class, () -> { + ClientDESv2.searchMatchV2().searchCandidates(query, null); + }); + + Options opts = new Options(); + query.QueryString = validSearchTerm; + assertDoesNotThrow(() -> { + SearchResult response = ClientDESv2.searchMatchV2().searchCandidates(query, opts).Value; + assertNotEquals(0, response.MatchSize); + }); + + query.QueryString = "ThisIsATermThatIsntInTheDocument"; + assertDoesNotThrow(() -> { + SearchResult response = ClientDESv2.searchMatchV2().searchCandidates(query, opts).Value; + assertEquals(0, response.MatchSize); + }); + } + + @Test + public void testParseAndUpload() throws TxException, IOException { + Document document = getTestFileAsDocument("resume.docx"); + String docId = UUID.randomUUID().toString(); + + ParseOptions options = new ParseOptions(); + options.IndexingOptions = new IndexingOptionsGeneric(MatchV2Environment.PROD, docId, null, null); + + ParseResumeResponse parseResponse = ClientDESv2.parser().parseResume(new ParseRequest(document, options)); + assertTrue(parseResponse.Value.IndexingResponse.isSuccess()); + delayForIndexSync(5); + + Options opts = new Options(); + SearchQuery query = new SearchQuery(); + query.QueryString = "Developer"; + + assertDoesNotThrow(() -> { + SearchResult response = ClientDESv2.searchMatchV2().searchCandidates(query, opts).Value; + assertNotEquals(0, response.MatchSize); + boolean foundDocId = false; + for (ResultItem item : response.ResultItems) { + foundDocId |= item.DocID.equals(docId); + } + assertTrue(foundDocId); + }); + + ClientDESv2.searchMatchV2().deleteCandidates(Arrays.asList(docId)); + delayForIndexSync(5); + } + + @Test + public void testMatch() throws TxException { + assertThrows(TxException.class, () -> { + ClientDESv2.searchMatchV2().matchJobs(null, null, null); + }); + + Options options = new Options(); + assertThrows(TxException.class, () -> { + ClientDESv2.searchMatchV2().matchJobs(null, options, null); + }); + + DocumentSource docSrc = new DocumentSource(); + docSrc.Id = "fake-doc-id"; + + assertThrows(TxException.class, () -> { + ClientDESv2.searchMatchV2().matchJobs(docSrc, options, null); + }); + + docSrc.Id = _documentId; + docSrc.Type = DocumentType.vacancy; + + assertDoesNotThrow(() -> { + ClientDESv2.searchMatchV2().matchJobs(docSrc, options, null); + }); + + assertDoesNotThrow(() -> { + ClientDESv2.searchMatchV2().matchCandidates(docSrc, options, null); + }); + } + + @Test + public void testAutocomplete() throws TxException { + assertDoesNotThrow(() -> { + AutocompleteResponse response = ClientDESv2.searchMatchV2().autocompleteJobs(AutocompleteJobsField.Location, "York"); + assertHasItems(response.Value.Return); + }); + + assertDoesNotThrow(() -> { + AutocompleteResponse response = ClientDESv2.searchMatchV2().autocompleteCandidates(AutocompleteCandidatesField.AllJobTitles, "Softwa"); + assertHasItems(response.Value.Return); + }); + } +} diff --git a/src/test/java/com/textkernel/tx/integration/ParsingTests.java b/src/test/java/com/textkernel/tx/integration/ParsingTests.java index 1a96af237..064b0c79a 100644 --- a/src/test/java/com/textkernel/tx/integration/ParsingTests.java +++ b/src/test/java/com/textkernel/tx/integration/ParsingTests.java @@ -14,7 +14,7 @@ import com.textkernel.tx.models.api.dataenrichment.professions.ProfessionNormalizationVersions; import com.textkernel.tx.models.api.geocoding.GeocodeOptions; import com.textkernel.tx.models.api.geocoding.GeocodeProvider; -import com.textkernel.tx.models.api.indexes.IndexSingleDocumentInfo; +import com.textkernel.tx.models.api.indexes.IndexingOptionsGeneric; import com.textkernel.tx.models.api.parsing.*; import static org.junit.jupiter.api.Assertions.*; @@ -51,19 +51,19 @@ private static Stream provideBadDocuments() { public void testParseBadInput(Document doc, Class classOfExpectedException) { assertThrows(classOfExpectedException, () -> { ParseRequest request = new ParseRequest(doc, null); - Client.parseResume(request); + Client.parser().parseResume(request); }); assertThrows(classOfExpectedException, () -> { ParseRequest request = new ParseRequest(doc, null); - Client.parseJob(request); + Client.parser().parseJob(request); }); } @Test public void testLargeDocumentParse() { TxException e = assertThrows(TxException.class, () -> { - Client.parseResume(new ParseRequest(new Document(new byte[40_000_000], LocalDate.now()), null)); + Client.parser().parseResume(new ParseRequest(new Document(new byte[40_000_000], LocalDate.now()), null)); }); String expected = "Request body was too large"; @@ -78,7 +78,7 @@ public void testBullets() throws Exception assertDoesNotThrow(() -> { ParseOptions opts = new ParseOptions(); opts.Configuration = "OutputFormat.CreateBullets = true"; - responseAtomic.set(Client.parseResume(new ParseRequest(TestData.Resume, opts)).Value); + responseAtomic.set(Client.parser().parseResume(new ParseRequest(TestData.Resume, opts)).Value); }); ParseResumeResponseValue response = responseAtomic.get(); @@ -105,7 +105,7 @@ public void verifyParseResumeSuccess() throws Exception opts.OutputHtml = true; opts.OutputPdf = true; opts.OutputRtf = true; - responseAtomic.set(Client.parseResume(new ParseRequest(TestData.Resume, opts)).Value); + responseAtomic.set(Client.parser().parseResume(new ParseRequest(TestData.Resume, opts)).Value); }); ParseResumeResponseValue response = responseAtomic.get(); @@ -131,7 +131,7 @@ public void verifyParseResumeGeocodeError() throws Exception opts.GeocodeOptions.IncludeGeocoding = true; opts.GeocodeOptions.Provider= GeocodeProvider.Google; - Client.parseResume(new ParseRequest(TestData.Resume, opts)); + Client.parser().parseResume(new ParseRequest(TestData.Resume, opts)); }); assertTrue(!e.Response.Value.GeocodeResponse.isSuccess()); @@ -154,7 +154,7 @@ public void verifyparseJobSuccess() throws Exception opts.OutputHtml = true; opts.OutputPdf = true; opts.OutputRtf = true; - responseAtomic.set(Client.parseJob(new ParseRequest(TestData.JobOrder, opts)).Value); + responseAtomic.set(Client.parser().parseJob(new ParseRequest(TestData.JobOrder, opts)).Value); }); ParseJobResponseValue response = responseAtomic.get(); @@ -178,15 +178,14 @@ public void testParseResumeGeocodeIndex() throws TxException { GeocodeOptions geocodeOptions = new GeocodeOptions(); geocodeOptions.IncludeGeocoding = true; - IndexSingleDocumentInfo indexingOptions = new IndexSingleDocumentInfo(); - indexingOptions.IndexId = indexId; + IndexingOptionsGeneric indexingOptions = new IndexingOptionsGeneric(documentId, indexId, null); // since there isn't an address this will throw an exception assertThrows(TxGeocodeResumeException.class, () -> { ParseRequest request = new ParseRequest(TestData.Resume, null); request.GeocodeOptions = geocodeOptions; request.IndexingOptions = indexingOptions; - Client.parseResume(request); + Client.parser().parseResume(request); }); @@ -195,13 +194,13 @@ public void testParseResumeGeocodeIndex() throws TxException { ParseRequest request = new ParseRequest(TestData.ResumeWithAddress, null); request.GeocodeOptions = geocodeOptions; request.IndexingOptions = indexingOptions; - Client.parseResume(request); + Client.parser().parseResume(request); }); try { // set the document id and create the index indexingOptions.DocumentId = documentId; - Client.createIndex(IndexType.Resume, indexId); + Client.searchMatchV1().createIndex(IndexType.Resume, indexId); delayForIndexSync(); // confirm you can parse/geocode/index @@ -209,12 +208,12 @@ public void testParseResumeGeocodeIndex() throws TxException { ParseRequest request = new ParseRequest(TestData.ResumeWithAddress, null); request.GeocodeOptions = geocodeOptions; request.IndexingOptions = indexingOptions; - Client.parseResume(request); + Client.parser().parseResume(request); }); // verify the resume exists in the index delayForIndexSync(); - Client.getResume(indexId, documentId); + Client.searchMatchV1().getResume(indexId, documentId); } catch (TxException e) { throw e; } finally { @@ -228,7 +227,7 @@ public void testResumeToFromJson() throws IOException { String tempFile2 = UUID.randomUUID().toString(); try { - ParseResumeResponse response = Client.parseResume(new ParseRequest(TestData.Resume, null)); + ParseResumeResponse response = Client.parser().parseResume(new ParseRequest(TestData.Resume, null)); String unformatted = response.Value.ResumeData.toJson(false); String formatted = response.Value.ResumeData.toJson(true); @@ -269,7 +268,7 @@ public void testJobToFromJson() throws IOException { String tempFile2 = UUID.randomUUID().toString(); try { - ParseJobResponse response = Client.parseJob(new ParseRequest(TestData.JobOrder, null)); + ParseJobResponse response = Client.parser().parseJob(new ParseRequest(TestData.JobOrder, null)); String unformatted = response.Value.JobData.toJson(false); String formatted = response.Value.JobData.toJson(true); @@ -312,15 +311,14 @@ public void testParseJobGeocodeIndex() throws TxException { GeocodeOptions geocodeOptions = new GeocodeOptions(); geocodeOptions.IncludeGeocoding = true; - IndexSingleDocumentInfo indexingOptions = new IndexSingleDocumentInfo(); - indexingOptions.IndexId = indexId; - + IndexingOptionsGeneric indexingOptions = new IndexingOptionsGeneric(documentId, indexId, null); + // since there isn't an address this will throw an exception assertThrows(TxGeocodeJobException.class, () -> { ParseRequest request = new ParseRequest(TestData.JobOrder, null); request.GeocodeOptions = geocodeOptions; request.IndexingOptions = indexingOptions; - Client.parseJob(request); + Client.parser().parseJob(request); }); // confirm you can geocode but indexing fails @@ -328,13 +326,13 @@ public void testParseJobGeocodeIndex() throws TxException { ParseRequest request = new ParseRequest(TestData.JobOrderWithAddress, null); request.GeocodeOptions = geocodeOptions; request.IndexingOptions = indexingOptions; - Client.parseJob(request); + Client.parser().parseJob(request); }); try { // set the document id and create the index indexingOptions.DocumentId = documentId; - Client.createIndex(IndexType.Job, indexId); + Client.searchMatchV1().createIndex(IndexType.Job, indexId); delayForIndexSync(); // confirm you can parse/geocode/index @@ -342,12 +340,12 @@ public void testParseJobGeocodeIndex() throws TxException { ParseRequest request = new ParseRequest(TestData.JobOrderWithAddress, null); request.GeocodeOptions = geocodeOptions; request.IndexingOptions = indexingOptions; - Client.parseJob(request); + Client.parser().parseJob(request); }); // verify the resume exists in the index delayForIndexSync(); - Client.getJob(indexId, documentId); + Client.searchMatchV1().getJob(indexId, documentId); } catch (TxException e) { throw e; } finally { @@ -357,7 +355,7 @@ public void testParseJobGeocodeIndex() throws TxException { @Test public void testSkillsData() throws TxException { - ParseResumeResponseValue response = Client.parseResume(new ParseRequest(TestData.Resume, null)).Value; + ParseResumeResponseValue response = Client.parser().parseResume(new ParseRequest(TestData.Resume, null)).Value; assertEquals(response.ResumeData.SkillsData.get(0).Taxonomies.get(0).SubTaxonomies.get(0).Skills.get(0).MonthsExperience.Value, 12); assertEquals(response.ResumeData.SkillsData.get(0).Taxonomies.get(0).SubTaxonomies.get(0).Skills.get(0).LastUsed.Value.toString(), "2018-07-01"); @@ -367,7 +365,7 @@ public void testSkillsData() throws TxException { @Test public void testPersonalInfo() throws TxException { - ParseResumeResponseValue response = Client.parseResume(new ParseRequest(TestData.ResumePersonalInformation, null)).Value; + ParseResumeResponseValue response = Client.parser().parseResume(new ParseRequest(TestData.ResumePersonalInformation, null)).Value; assertNotNull(response.ResumeData.PersonalAttributes.Birthplace); assertNotNull(response.ResumeData.PersonalAttributes.DateOfBirth); @@ -384,7 +382,7 @@ public void testPersonalInfo() throws TxException { @Test public void testResumeQuality() throws TxException, IOException { Document document = getTestFileAsDocument("resume.docx"); - ParseResumeResponseValue response = Client.parseResume(new ParseRequest(document, null)).Value; + ParseResumeResponseValue response = Client.parser().parseResume(new ParseRequest(document, null)).Value; assertHasItems(response.ResumeData.ResumeMetadata.ResumeQuality); assertNotNull(response.ResumeData.ResumeMetadata.ResumeQuality.get(0).Level); @@ -402,7 +400,7 @@ public void testResumeQuality() throws TxException, IOException { @Test public void testGeneralOutput() throws Exception { Document document = getTestFileAsDocument("resume.docx"); - ParseResumeResponse response = Client.parseResume(new ParseRequest(document, null)); + ParseResumeResponse response = Client.parser().parseResume(new ParseRequest(document, null)); assertTrue(response.Info.isSuccess()); @@ -554,7 +552,7 @@ public void TestV2SkillsRaw() throws Exception { ParseOptions options = new ParseOptions(); options.SkillsSettings = new SkillsSettings(); options.SkillsSettings.TaxonomyVersion = "v2"; - ParseResumeResponse response = Client.parseResume(new ParseRequest(document, options)); + ParseResumeResponse response = Client.parser().parseResume(new ParseRequest(document, options)); assertTrue(response.Info.isSuccess()); assertNotNull(response.Value.ResumeData.Skills.Raw); @@ -571,7 +569,7 @@ public void TestV2SkillsNormalized() throws Exception { options.SkillsSettings = new SkillsSettings(); options.SkillsSettings.TaxonomyVersion = "v2"; options.SkillsSettings.Normalize = true; - ParseResumeResponse response = Client.parseResume(new ParseRequest(document, options)); + ParseResumeResponse response = Client.parser().parseResume(new ParseRequest(document, options)); assertTrue(response.Info.isSuccess()); @@ -597,13 +595,13 @@ public void TestProfessionNormalization() throws Exception { ParseOptions options = new ParseOptions(); options.ProfessionsSettings = new ProfessionsSettings(); options.ProfessionsSettings.Normalize = true; - ParseResumeResponse response = Client.parseResume(new ParseRequest(document, options)); + ParseResumeResponse response = Client.parser().parseResume(new ParseRequest(document, options)); assertTrue(response.Info.isSuccess()); assertNotNull(response.Value.ResumeData.EmploymentHistory.Positions.get(0).NormalizedProfession); options.ProfessionsSettings.Normalize = true; - response = Client.parseResume(new ParseRequest(document, options)); + response = Client.parser().parseResume(new ParseRequest(document, options)); assertTrue(response.Info.isSuccess()); assertTrue(response.Value.ProfessionNormalizationResponse.isSuccess()); @@ -628,7 +626,7 @@ public void TestONET2019ProfessionNormalization() throws Exception { ParseOptions options = new ParseOptions(); options.ProfessionsSettings = new ProfessionsSettings(); options.ProfessionsSettings.Normalize = true; - ParseResumeResponse response = Client.parseResume(new ParseRequest(document, options)); + ParseResumeResponse response = Client.parser().parseResume(new ParseRequest(document, options)); assertTrue(response.Info.isSuccess()); assertNotNull(response.Value.ResumeData.EmploymentHistory.Positions.get(0).NormalizedProfession); @@ -637,7 +635,7 @@ public void TestONET2019ProfessionNormalization() throws Exception { options.ProfessionsSettings.Version = new ProfessionNormalizationVersions(); options.ProfessionsSettings.Version.ONET = ONETVersion.ONET2019; - response = Client.parseResume(new ParseRequest(document, options)); + response = Client.parser().parseResume(new ParseRequest(document, options)); assertTrue(response.Info.isSuccess()); assertTrue(response.Value.ProfessionNormalizationResponse.isSuccess()); @@ -662,7 +660,7 @@ public void TestJobOrderV2SkillsRaw() throws Exception { ParseOptions options = new ParseOptions(); options.SkillsSettings = new SkillsSettings(); options.SkillsSettings.TaxonomyVersion = "v2"; - ParseJobResponse response = Client.parseJob(new ParseRequest(TestData.JobOrder, options)); + ParseJobResponse response = Client.parser().parseJob(new ParseRequest(TestData.JobOrder, options)); assertTrue(response.Info.isSuccess()); assertNotNull(response.Value.JobData.Skills.Raw); @@ -678,7 +676,7 @@ public void TestJobOrderV2SkillsNormalized() throws Exception { options.SkillsSettings.TaxonomyVersion = "v2"; options.SkillsSettings.Normalize = true; - ParseJobResponse response = Client.parseJob(new ParseRequest(TestData.JobOrder, options)); + ParseJobResponse response = Client.parser().parseJob(new ParseRequest(TestData.JobOrder, options)); assertTrue(response.Info.isSuccess()); assertNotNull(response.Value.JobData.Skills.Raw); @@ -701,13 +699,13 @@ public void TestJobOrderProfessionNormalization() throws Exception { ParseOptions options = new ParseOptions(); options.ProfessionsSettings = new ProfessionsSettings(); options.ProfessionsSettings.Normalize = false; - ParseJobResponse response = Client.parseJob(new ParseRequest(TestData.JobOrder, options)); + ParseJobResponse response = Client.parser().parseJob(new ParseRequest(TestData.JobOrder, options)); assertTrue(response.Info.isSuccess()); assertNull(response.Value.JobData.JobTitles.NormalizedProfession); options.ProfessionsSettings.Normalize = true; - response = Client.parseJob(new ParseRequest(TestData.JobOrder, options)); + response = Client.parser().parseJob(new ParseRequest(TestData.JobOrder, options)); assertTrue(response.Info.isSuccess()); assertTrue(response.Value.ProfessionNormalizationResponse.isSuccess()); @@ -725,7 +723,7 @@ public void TestLLMParse() throws Exception { Document document = getTestFileAsDocument("resume.docx"); ParseOptions options = new ParseOptions(); options.UseLLMParser = true; - ParseResumeResponse response = Client.parseResume(new ParseRequest(document, options)); + ParseResumeResponse response = Client.parser().parseResume(new ParseRequest(document, options)); assertTrue(response.Info.isSuccess()); assertNotNull(response.Value.ResumeData.ContactInformation.CandidateName.GivenName); @@ -742,7 +740,7 @@ public void TestFlexRequests() throws Exception { prompt.DataType = FlexRequestDataType.Text; prompt.Identifier = "YearsLeadership"; options.FlexRequests.add(prompt); - ParseResumeResponse response = Client.parseResume(new ParseRequest(document, options)); + ParseResumeResponse response = Client.parser().parseResume(new ParseRequest(document, options)); assertTrue(response.Info.isSuccess()); assertNotNull(response.Value.FlexResponse);