Enrich events

During the conversation, various NLP processors are run according to your subscription. They emit annotation events that interpret and enrich the transcript.
Those annotations are anchored on the transcript timeline, so that:

  • they can also apply to non-speech sound,
  • you can rewrite the transcript according to the interpretation in order to improve readability, or to hide sensitive information.

The following events are currently available in English:

All events below are available in French, according to your subscription.

Confidence score

Please be aware that a confidence score of 0.8 or above is a rather very good one.

Number

A number such as an age for example.

Please note that to prevent a flood of events, no event will be triggered if the number is strictly inferior to 10, unless said in a series.

For example an Entity Number Found event would be fired for the square footage of the following sentence, but not for the number of rooms:

my house is 150 square meter big and has nine rooms

But on the other hand, All together lyrics by the Beatles would fire four events:

1 2 3 4 can I have a little more

{
"topic": "conversation:acme_corp@conference",
"event": "entity_number_found",
"payload": {
"annotation": {
"canonical": "22",
"original": "vingt-deux",
"value": 22.0
},
"confidence": 0.9,
"end": 1614174590554,
"lang": "fr",
"length": 960,
"speaker": "Alice",
"start": 1614174589594
},
"ref": null
}
  • canonical is the well-formatted, localized decimal form of the number
  • original is the transcript of the number
  • value is its value

Ordinal Number

A number representing position or rank.

Please note that to prevent a flood of events, no event will be triggered if the number is strictly inferior to 10th, unless said in a series.

Why, you ask?
First, that' because little ordinals can be used as adverbs, like in this paragraph.
Second, you don't want to mess with seconds (time).
Third, that might change if text2num is more clever and can do part of speech recognition.

For example an Entity Ordinal Found event would be fired for the mileage of the following sentence, but not for the runner position:

on the 14th kilometer of the marathon i was in third position

{
"topic": "conversation:acme_corp@conference",
"event": "entity_ordinal_found",
"payload": {
"annotation": {
"canonical": "22ème",
"original": "vingt-deuxième",
"value": 22.0
},
"confidence": 0.9,
"end": 1614174590554,
"lang": "fr",
"length": 960,
"speaker": "Alice",
"start": 1614174589594
},
"ref": null
}
  • canonical is the well-formatted, localized decimal form of the ordinal
  • original is the transcript of the ordinal
  • value is the rank of the ordinal

Location Delivery Point

This event is only available in French at the moment.

A unique geographical reference from which a consumer can draw or inject electricity in the French electricty network, Point de Livraison, also shortened to PDL. Made of 14 digits.

  "topic": "conversation:acme_corp@conference",
"event": "entity_location_delivery_point_found",
"payload": {
"annotation": {
"original": "un deux trois quatre cinq six sept huit neuf zéro un deux trois quatre",
},
"confidence": 0.9,
"end": 1614174590554,
"lang": "fr",
"length": 960,
"speaker": "Alice",
"start": 1614174589594
},
"ref": null
}

Credit Card Number

This event is only available in French at the moment.

A credit card number, that is to say the group of four four-digits numbers, XXXX XXXX XXXX XXXX. Not the three-digits card security code or the expiration date.

  "topic": "conversation:acme_corp@conference",
"event": "entity_credit_card_number_found",
"payload": {
"annotation": {
"original": "douze trente-quatre cinquante-six soixante-dix-huit quatre-vingt-dix douze trente-quatre cinquante-six",
},
"confidence": 0.9,
"end": 1614174590554,
"lang": "fr",
"length": 960,
"speaker": "Alice",
"start": 1614174589594
},
"ref": null
}

IBAN

This event is only available in French at the moment.

An International Bank Account Number. Does not fire for a BIC (Business Identifier Code).

French format is FRkk BBBB BGGG GGCC CCCC CCCC CKK, with B bank code, G account code, C account number, K check key.

  "topic": "conversation:acme_corp@conference",
"event": "entity_iban_found",
"payload": {
"annotation": {
"original": "f r douze trente-quatre cinquante-six soixante-dix-huit quatre-vingt-dix douze trente-quatre cinquante-six soixante-dix-huit quatre-vingt-dix douze un deux trois",
},
"confidence": 0.9,
"end": 1614174590554,
"lang": "fr",
"length": 960,
"speaker": "Alice",
"start": 1614174589594
},
"ref": null
}

Entity Telephone Number Found

This event is only available in French at the moment.

A phone number.

  "topic": "conversation:acme_corp@conference",
"event": "entity_telephone_number_found",
"payload": {
"annotation": {
"original": "zéro six onze vingt-deux trente-trois quarante-quatre",
},
"confidence": 0.9,
"end": 1614174590554,
"lang": "fr",
"length": 960,
"speaker": "Alice",
"start": 1614174589594
},
"ref": null
}

First Name

This event is only available in French at the moment.

First name, provided it is common enough.

  "topic": "conversation:acme_corp@conference",
"event": "entity_pers_firstname_found",
"payload": {
"annotation": {
"original": "jean-louis",
},
"confidence": 0.9,
"end": 1614174590554,
"lang": "fr",
"length": 960,
"speaker": "Alice",
"start": 1614174589594
},
"ref": null
}

Spelled First Name

This event is only available in French at the moment.

  "topic": "conversation:acme_corp@conference",
"event": "entity_pers_spelled_firstname_found",
"payload": {
"annotation": {
"original": "j e a n tiret l o u i s",
},
"confidence": 0.9,
"end": 1614174590554,
"lang": "fr",
"length": 960,
"speaker": "Alice",
"start": 1614174589594
},
"ref": null
}

Last Name

This event is only available in French at the moment.

A last name, provided it is common enough.

  "topic": "conversation:acme_corp@conference",
"event": "entity_pers_lastname_found",
"payload": {
"annotation": {
"original": "fournier",
},
"confidence": 0.9,
"end": 1614174590554,
"lang": "fr",
"length": 960,
"speaker": "Alice",
"start": 1614174589594
},
"ref": null
}

Last Name Spelled

This event is only available in French at the moment.

  "topic": "conversation:acme_corp@conference",
"event": "entity_pers_spelled_lastname_found",
"payload": {
"annotation": {
"original": "f o u r n i e r",
},
"confidence": 0.9,
"end": 1614174590554,
"lang": "fr",
"length": 960,
"speaker": "Alice",
"start": 1614174589594
},
"ref": null
}

Email

This event is only available in French at the moment.

  "topic": "conversation:acme_corp@conference",
"event": "entity_email_found",
"payload": {
"annotation": {
"original": "jean-louis point fournier arobase exemple point fr",
},
"confidence": 0.9,
"end": 1614174590554,
"lang": "fr",
"length": 960,
"speaker": "Alice",
"start": 1614174589594
},
"ref": null
}

Location, Street

This event is only available in French at the moment.

In case a street number is given, it will be included within time anchors.

  "topic": "conversation:acme_corp@conference",
"event": "entity_location_street_found",
"payload": {
"annotation": {
"original": "trente-trois rue de la mairie",
},
"confidence": 0.9,
"end": 1614174590554,
"lang": "fr",
"length": 960,
"speaker": "Alice",
"start": 1614174589594
},
"ref": null
}

Location, Postal Code

This event is only available in French at the moment.

  "topic": "conversation:acme_corp@conference",
"event": "entity_location_postal_code_found",
"payload": {
"annotation": {
"original": "soixante-quinze zéro zéro un",
},
"confidence": 0.9,
"end": 1614174590554,
"lang": "fr",
"length": 960,
"speaker": "Alice",
"start": 1614174589594
},
"ref": null
}

Location, City

This event is only available in French at the moment.

  "topic": "conversation:acme_corp@conference",
"event": "entity_location_city_found",
"payload": {
"annotation": {
"original": "paris",
},
"confidence": 0.9,
"end": 1614174590554,
"lang": "fr",
"length": 960,
"speaker": "Alice",
"start": 1614174589594
},
"ref": null
}

Location, Country

This event is only available in French at the moment.

  "topic": "conversation:acme_corp@conference",
"event": "entity_location_country_found",
"payload": {
"annotation": {
"original": "france",
},
"confidence": 1.0,
"end": 1614174590554,
"lang": "fr",
"length": 960,
"speaker": "Alice",
"start": 1614174589594
},
"ref": null
}

Location, Miscellaneous

This event is only available in French at the moment.

For example the floor number.

  "topic": "conversation:acme_corp@conference",
"event": "entity_location_misc_found",
"payload": {
"annotation": {
"original": "quatrième étage",
},
"confidence": 0.9,
"end": 1614174590554,
"lang": "fr",
"length": 960,
"speaker": "Alice",
"start": 1614174589594
},
"ref": null
}

Health, Organ

This event is only available in French at the moment.

  "topic": "conversation:acme_corp@conference",
"event": "entity_health_organ_found",
"payload": {
"annotation": {
"original": "intestin",
},
"confidence": 0.9,
"end": 1614174590554,
"lang": "fr",
"length": 960,
"speaker": "Alice",
"start": 1614174589594
},
"ref": null
}

Health, Disease

This event is only available in French at the moment.

  "topic": "conversation:acme_corp@conference",
"event": "entity_heath_disease_found",
"payload": {
"annotation": {
"original": "angine",
},
"confidence": 0.9,
"end": 1614174590554,
"lang": "fr",
"length": 960,
"speaker": "Alice",
"start": 1614174589594
},
"ref": null
}