Get the tags

​

Poll until finished is true.

Returns 404 when the id does not exist, belongs to a different app, or was created under a different tag set.

Reading the result

{
  "taxonomies": [
    {
      "taxonomy": "iptc",
      "themes": [
        {
          "code": "medtop:20000350",
          "label": "economy, business and finance",
          "confidence": 0.91,
          "model_agreement": "3/3"
        },
        {
          "code": "medtop:20000385",
          "label": "market and exchange",
          "confidence": 0.64,
          "model_agreement": "2/3"
        }
      ]
    }
  ],
  "entities": [
    {
      "name": "Federal Reserve",
      "kind": "organization",
      "relevance": 0.9,
      "role": "primary",
      "model_agreement": "3/3"
    }
  ],
  "keywords": [
    {
      "keyword": "interest rates",
      "relevance": 0.85,
      "model_agreement": "3/3"
    }
  ]
}
  • themes are ranked per taxonomy. The first entry is the best category.
  • confidence is the mean over the models that agreed.
  • model_agreement is the vote. It is the better signal for an automatic cut-off than confidence alone.
  • entities with "role": "primary" are what the article is about. Use them for topic pages and related-content links.
  • keywords never repeat an entity — Miso removes the overlap.
Path Parameters
  • tag_set
    Type: string
    required

    Must match the tag set used to create it.

  • tagging_id
    Type: string Format: uuid
    required

    The id returned when you submitted the document.

Responses
  • application/json
Request Example for get/v1/ask/tagging/{tag_set}/{tagging_id}
curl 'https://api.askmiso.com/v1/ask/tagging/{tag_set}/123e4567-e89b-12d3-a456-426614174000?api_key=YOUR_SECRET_TOKEN'

{
  "message": "success",
  "data": {
    "tag_set": "iptc_iab",
    "stage": "finished",
    "finished": true,
    "finish_reason": "success",
    "tags": {
      "tag_set": "iptc_iab",
      "taxonomies": [
        {
          "taxonomy": "iptc",
          "themes": [
            {
              "code": "medtop:20000350",
              "label": "economy, business and finance",
              "confidence": 0.91,
              "model_agreement": "3/3"
            }
          ]
        },
        {
          "taxonomy": "iab",
          "themes": [
            {
              "code": "432",
              "label": "Personal Finance",
              "confidence": 0.78,
              "model_agreement": "2/3"
            }
          ]
        }
      ],
      "entities": [
        {
          "name": "Federal Reserve",
          "kind": "organization",
          "relevance": 0.9,
          "role": "primary",
          "model_agreement": "3/3"
        }
      ],
      "keywords": [
        {
          "keyword": "interest rates",
          "relevance": 0.85,
          "model_agreement": "3/3"
        }
      ]
    }
  }
}

The tags for the document.