The EY Strategy Edge Tagger API takes in a company record and classifies it into one or more tags in the EY taxonomy.
https://edgetagger.diffbot.com/v1/tag?
| Argument | Description |
|---|---|
| uuid | The UUID for the input company, if known. |
| id | The Diffbot entity ID for the input company, if known. |
| name | Name of the input organization. Required field. |
| description | Free text description of the company. |
| url | Homepage URL of the company. |
| location | Street address of the company. Partial location string ok. |
| gicsSector | GICS Sector used to categorize the company (Global Industry Classification Standard). |
| options | comma separated list to set specific options. Possible values: enhance indicating whether or not to use Diffbot Knowledge Graph for augmenting the input data moreTags indicating whether or not the model has to search for more specific categories by matching keywords |
| taxonomies | comma separated list describing the taxonomies the model has to predict. Possible values: cpr use the Consumer Products & Retail (CPR) taxonomy amm use the Advanced Manufacturing & Mobility (AMM) taxonomy nrg use the Energy (NRG) taxonomy fso use the Financial Services (FSO) taxonomy bm use the Business Model (BM) taxonomy esg use the Sustainability (ESG) taxonomy ai use the Artificial Intelligence (AI) taxonomy tmt use the Technology (TMT) taxonomy
|
https://edgetagger.diffbot.com/v1/tag?&name=Samsung&options=enhance,moreTags&taxonomies=cpr
The API response is a JSON object containing the output of the keyword model (keyword_model) and the machine learning model (ml_model).
{
"keyword_model": {
"version": "20240416",
"tags": {
"Business Model": [
{
"score": 0.8490113,
"level_0": "Business Model",
"level_1": "Distributor"
}
],
"Category": [
{
"score": 0.8811223,
"level_0": "Consumer Products & Retail",
"level_1": "Food products & retail",
"level_2": "Prepared & preserved foods"
},
{
"score": 0.801037,
"level_0": "Consumer Products & Retail",
"level_1": "Personal care goods",
"level_2": "Oral care"
}
],
"Sustainability": []
}
},
"ml_model": {
"version": "20240416",
"tags": {
"Business Model": [
{
"score": 0.94337654,
"level_0": "Business Model",
"level_1": "Manufacturer"
}
],
"Category": [
{
"score": 0.85643023,
"level_0": "Consumer Products & Retail",
"level_1": "Food products & retail"
},
{
"score": 0.8560694,
"level_0": "Consumer Products & Retail",
"level_1": "Personal care goods",
"level_2": "Beauty care"
}
],
"Sustainability": []
}
}
}
| Attribute | Description |
|---|---|
| Category | Array with all the EY categories predicted on the passed input for the provided taxonomy |
| Business Model | Array with all the Business model categories predicted on the passed input (currently only CPR). |
| Sustainability | Array with all the Sustainability categories predicted on the passed input. |
| level_0 | The top-most level of the EY taxonomy (L0) which is the name of the provided taxonomy |
| level_1 | The first level of an EY taxonomy (L1). This is also called in various places the EY Primary Sector. |
| level_2 | The second level of an EY taxonomy (L2). This is also referred to as the EY Primary Sub-sector. |
| level_3 | The third level of an EY taxonomy (L3). |
| score | This is a number between 0 and 1 that indicates the degree of confidence that the model has that the input company is in this category with 1.00 being the most confident. |