System Entities¶

System entities are generic entities that are part of the NLU and are available for applications.

The available system entities depend on the pipeline used. This section provides the complete list with descriptions. The developer should specify the desired entities during the agent configuration.

sys.all
sys.currency
sys.date-time
sys.duration
sys.email
sys.length
sys.number
sys.ordinal
sys.phone
sys.quantity
sys.temperature
sys.url
sys.volume

sys.all¶

If such an entity is added, it enables all system entities.

sys.currency¶

Recognizes currency units.

Input

{
  "text": "R$100,00"
}

Return

{
  "name":"sys.currency",
  "value":"100",
  "unit": "BRL",
  "text":"r$ 100,00",
  "start_pos":0,
  "end_pos":9,
  "score":1.0
}

sys.date-time¶

Recognizes dates and times.

Input

{
  "text": "30 de setembro de 2021"
}

Return

{
  "name":"sys.date-time",
  "value":"2021-09-30T00:00:00.000-03:00",
  "unit": "",
  "text":"30 de setembro de 2021",
  "start_pos":0,
  "end_pos":22,
  "score":1.0
}

sys.duration¶

Recognizes time durations.

Input

{
  "text": "3 minutos"
}

Return

{
  "name":"sys.duration",
  "value":"3",
  "unit":"minute",
  "text":"3 minutos",
  "start_pos":0,
  "end_pos":9,
  "score":1.0
}

sys.email¶

Recognizes email addresses.

Input

{
  "text": "meu e-mail é guest@cpqd.com.br"
}

Return

{
  "name":"sys.email",
  "value":"guest@cpqd.com.br",
  "unit":"",
  "text":"guest@cpqd.com.br",
  "start_pos":13,
  "end_pos":30,
  "score":1.0
}

sys.length¶

Recognizes length units.

Input

{
  "text": "100 metros"
}

Return

{
  "name":"sys.length",
  "value":"100",
  "unit": "metre",
  "text":"100 metros",
  "start_pos":0,
  "end_pos":10,
  "score":1.0
}

sys.number¶

Recognizes numbers

Input

{
  "text": "oitenta e sete"
}

Return

{
  "name":"sys.number",
  "value":"87",
  "unit":"",
  "text":"oitenta e sete",
  "start_pos":0,
  "end_pos":14,
  "score":1.0
}

sys.ordinal¶

Recognizes ordinal numbers.

Input

{
  "text": "décimo sétimo"
}

Return

{
  "name":"sys.ordinal",
  "value":"17",
  "unit":"",
  "text":"décimo sétimo",
  "start_pos":0,
  "end_pos":13,
  "score":1.0
}

sys.phone¶

Recognizes phone numbers.

Input

{
  "text": "O telefone do CPqD é (19) 3715-0000"
}

Return

{
  "name":"sys.phone",
  "value":"1937150000",
  "unit":"",
  "text":"19 3715-0000",
  "start_pos":21,
  "end_pos":33,
  "score":1.0
}

sys.quantity¶

Recognizes quantities

Input

{
  "text": "5 copos"
}

Return

{
  "name":"sys.quantity",
  "value":"5",
  "unit": "cup",
  "text":"5 copos",
  "start_pos":0,
  "end_pos":7,
  "score":1.0
}

sys.temperature¶

Recognizes temperatures.

Input

{
  "text": "57 graus celsius"
}

Return

{
  "name":"sys.temperature",
  "value":"57",
  "unit": "celsius",
  "text":"57 graus celsius",
  "start_pos":0,
  "end_pos":16,
  "score":1.0
}

sys.url¶

Recognizes website addresses.

Input

{
  "text": "https://www.cpqd.com.br"
}

Return

{
  "name":"sys.url",
  "value":"https://www.cpqd.com.br",
  "unit":"",
  "text":"https://www.cpqd.com.br",
  "start_pos":0,
  "end_pos":23,
  "score":1.0
}

sys.volume¶

Recognizes volume units.

Input

{
  "text": "100 litros"
}

Return

{
  "name":"sys.volume",
  "value":"100",
  "unit": "litre",
  "text":"100 litros",
  "start_pos":0,
  "end_pos":10,
  "score":1.0
}