Skip to content

Custom utterances

Azimuth has limited support for "custom utterances", i.e. utterances not part of the initial dataset.

Azimuth offers support through API routes accessible locally at http://localhost:8091/docs#/Custom%20Utterances%20v1.

Data augmentation

To augment a list of utterances, you can follow these intructions:

from pprint import pprint

import requests

utterances = ["welcome to Azimuth",
              "Don't forget to star our repo!"]

response = requests.get("http://localhost:8091/custom_utterances/perturbed_utterances",
                        params={"utterances": utterances}).json()
pprint([r["perturbedUtterance"] for r in response])

>>> [ 'pls welcome to Azimuth',
      'please welcome to Azimuth',
      ...,
      'Do not forget to star our repo!'
      ]

Saliency

If a pipeline allows it, you can get saliency of a custom utterance by doing the following:

from pprint import pprint

import requests

utterances = ["welcome to Azimuth",
              "Don't forget to star our repo!"]

response = requests.get("http://localhost:8091/custom_utterances/saliency",
                        params={"utterances": utterances, "pipeline_index": 0}).json()
pprint(response)

>>> [{'saliency': [0.08587087690830231,
                    ...
                   ],
      'tokens': ['[CLS]', 'welcome', 'to', 'az', '##im', '##uth', '[SEP]']},
      ...
     ]