Normalize Skills🔗︎

HTTP Verb	Path
POST	/v10/skills/Normalize

Normalize the given skills to the most closely-related skills in the taxonomy.

Info

You can try this endpoint out at our Swagger page ( US Data Center | EU Data Center | AU Data Center )

Scope of use🔗︎

The purpose of this endpoint is to enrich data records using our Taxonomy. You may store the parts of the response that are relevant to individual data records - such as candidate or employee profiles - within these records. It is not permitted to cache, store, or utilize responses from this endpoint for the purpose of limiting request volume, or to create replicas or derivatives of the Service and the Taxonomy.

Request Body🔗︎

Skills 🔗︎ string required

Skills🔗︎

The list of skills to normalize (up to 50 skills, each skill may not exceed 100 characters).

Language 🔗︎ string required

Language🔗︎

The language of the given skills. Must be one of the supported ISO codes.

OutputLanguage 🔗︎ 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.

Sample JSON

{
  "Skills": [
    ""
  ],
  "Language": "",
  "OutputLanguage": ""
}

Response Body🔗︎

Info 🔗︎ object

Info🔗︎

Information explaining the outcome of the transaction.

Info properties

Code 🔗︎ string

Code🔗︎

Code	Description
`Success`	Successful transaction
`MissingParameter`	A required parameter wasn't provided
`InvalidParameter`	A parameter was incorrectly specified
`AuthenticationError`	An error occurred with the credentials provided

Message 🔗︎ string

Message🔗︎

This message further describes the code providing additional detail.

TransactionId 🔗︎ string

TransactionId🔗︎

The (GUID) id for a specific API transaction. Use this when contacting support@textkernel.com about issues.

EngineVersion 🔗︎ string

EngineVersion🔗︎

The version of the parsing/matching engine running under-the-hood.

ApiVersion 🔗︎ string

ApiVersion🔗︎

The version of the API.

TotalElapsedMilliseconds 🔗︎ integer

TotalElapsedMilliseconds🔗︎

How long the transaction took on Textkernel's server, in milliseconds. If the transaction takes longer to complete on the client side, that extra duration is solely network latency.

TransactionCost 🔗︎ decimal

TransactionCost🔗︎

How many credits the transaction costs.How many credits the transaction costs.

CustomerDetails 🔗︎ object

CustomerDetails🔗︎

Information about the customer who made the API call.

CustomerDetails properties

AccountId 🔗︎ string

AccountId🔗︎

The AccountId for the account.

Name 🔗︎ string

Name🔗︎

The customer name on the account.

IPAddress 🔗︎ string

IPAddress🔗︎

The client IP Address where the API call originated.

Region 🔗︎ string

Region🔗︎

The region for the account, also known as the 'Data Center'.

CreditsRemaining 🔗︎ decimal

CreditsRemaining🔗︎

The number of credits remaining to be used by the account.

CreditsUsed 🔗︎ decimal

CreditsUsed🔗︎

The number of credits used by the account.

MaximumConcurrentRequests 🔗︎ integer

MaximumConcurrentRequests🔗︎

The number of requests that can be made at one time. If using sub-accounts, this is the maximum number of concurent requests across all accounts, not just this single sub-account.

ExpirationDate 🔗︎ date

ExpirationDate🔗︎

The date that the current credits expire.

Value 🔗︎ object

Value🔗︎

Contains response data for the transaction.

Value properties

Skills 🔗︎ object[]

Skills🔗︎

An array of skills objects.

Skills properties

RawText 🔗︎ string

RawText🔗︎

The raw text that matched to a skill description in the provided language.

Type 🔗︎ string

Type🔗︎

Type of skill. Possible values are Professional, IT, Language, or Soft.

Id 🔗︎ string

Id🔗︎

The ID of the skill in the skills taxonomy.

Confidence 🔗︎ float

Confidence🔗︎

A value from [0 - 1] indicating the overall confidence that the input skill was normalized to the correct skill.

Description 🔗︎ string

Description🔗︎

The description of the normalized skill from the taxonomy in the desired language.

IsoCode 🔗︎ string

IsoCode🔗︎

The language ISO 639-1 code. This will only appear for language skills (Type = Language).

Sample JSON

{
  "Info": {
    "Code": "string",
    "Message": "string",
    "TransactionId": "string",
    "EngineVersion": "string",
    "ApiVersion": "string",
    "TotalElapsedMilliseconds": 0,
    "TransactionCost": 0,
    "CustomerDetails": {
      "AccountId": "string",
      "Name": "string",
      "IPAddress": "string",
      "Region": "string",
      "CreditsRemaining": 0,
      "CreditsUsed": 0,
      "ExpirationDate": "2021-12-31",
      "MaximumConcurrentRequests": 0
    }
  },
  "Value": {
    "Skills": [
      {
        "RawText": "string",
        "Type": "string",
        "Id": "string",
        "Confidence": 1.0,
        "Description": "string",
        "IsoCode": "string"
      }
    ]
  }
}