Classify

Overview

The classify tool converts raw user text into canonical taxonomy IDs for classifiable dimensions. It helps agents convert terms such as occupations, skills, companies, locations, industries, schools, benefits, and education programs into IDs that analysis tools can use.

Common Use Cases

Use classify tool to answer questions such as:

Use CaseExample
Occupation normalizationWhat is the canonical SOC ID for software developers?
Skill normalizationWhat is the canonical skill ID for Python?
Location normalizationWhat is the canonical city ID for Seattle?
Agent normalizationConvert user language into canonical IDs before analysis.
Filter constructionBuild valid filters for classifiable dimensions.
Ranking setupSelect the correct taxonomy level for top rank dimensions.

Supported Datasets

classify returns results for the specified dimension. Supported concepts and taxonomy values differ across dimensions.

NameDimensions
Job Postingbenefit, occupation_lot, postings_education_level
Profileeducation_program_cip, education_school, industry_naics, location_us_area, occupation_onet, occupation_soc, profiles_education_level, skill
Job Posting & Profilecompany, location_us_city

The identifiers returned by classify can be used in supported filters and ranking requests across datasets, depending on the selected dimension and tool.

Inputs

The tool accepts the following objects.

InputDescription
dimensionClassifiable dimension name.
levelNumeric taxonomy level for the selected dimension.
valueSearch string to classify.

Use dimension, level, and value together to find the taxonomy identifier for a specific concept. For detailed information on taxonomy levels, see Taxonomies.

Example Request

{
  "dimension": "occupation_soc",
  "level": 4,
  "value": "software developers"
}

Outputs

The response returns one or more matching taxonomy concepts.

OutputDescription
results.idCanonical taxonomy ID.
results.nameCanonical concept name.
results.levelTaxonomy level.
results.confidenceOptional confidence value where available.

The returned identifier can be used in supported filters and ranking dimensions.

Example Response

{
  "results": [
    {
      "id": "231715",
      "name": "Software Developers",
      "level": 4,
      "confidence": 0.98
    }
  ]
}

Did this page help you?