> For the complete documentation index, see [llms.txt](https://docs.borndigital.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.borndigital.ai/digital-agent/tools-reference/names-and-companies.md).

# Names & companies

Names of people and companies, gender, titles.

Names of people and companies, gender, titles. How to add a tool and use its result is described in [Tools & smart functions](https://docs.borndigital.ai/digital-agent/tools-reference.md).

| Tool                      | Technical name              | What it does                                                                                                                             | Languages                      |
| ------------------------- | --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ |
| Company extractor         | `company`                   | Extract company names from user input using named-entity matching.                                                                       | sk, cs, en                     |
| Company ICO extractor     | `ico`                       | Return the company identification number (ICO) from the user’s utterance if valid (Czech, Slovak, or Polish).                            | cs, pl, sk                     |
| Full name                 | `full_name`                 | Extract full name from the last utterance.                                                                                               | cs, sk, pl, de, en, ro, hu     |
| Full name and gender      | `full_name_and_gender`      | Extract full name and its gender from the last utterance.                                                                                | cs, sk, pl, de, en, hu         |
| Full name from input data | `full_name_from_input_data` | Extract full name and optionally its gender from utterance using User Data Table.                                                        | cs, sk, pl, de, en, nl, fr, ro |
| Full name in nominative   | `full_name_extract_replace` | Extract full name in Nominative from the last utterance.                                                                                 | pl                             |
| Job pronunciation         | `pronounce_job`             | Return the phonetic pronunciation of a provided job name in the specified language (supports Czech).                                     | cs                             |
| Military rank extractor   | `military_rank`             | Return the military rank name in nominative case from the user’s utterance; support options to include character indices or all matches. | cs, sk                         |

## Company extractor

Technical name: `company`

Extract company names from user input using named-entity matching.

* Languages: sk, cs, en.

| Parameter    | Name           | Required | Default | Description                                                                        |
| ------------ | -------------- | -------- | ------- | ---------------------------------------------------------------------------------- |
| Custom input | `custom_input` | no       |         | Provide text to extract company names from instead of using the last user message. |

**Example input:** The company is Doxato s.r.o.

**Example output:**

```
['Doxato s.r.o.']
```

## Company ICO extractor

Technical name: `ico`

Return the company identification number (ICO) from the user’s utterance if valid (Czech, Slovak, or Polish).

* Languages: cs, pl, sk.

| Parameter    | Name           | Required | Default | Description                                                                  |
| ------------ | -------------- | -------- | ------- | ---------------------------------------------------------------------------- |
| Custom input | `custom_input` | no       |         | Override the user input with a custom string to extract the company ID from. |

**Example input:** My company ID is 47114983, can you verify it?

**Example output:**

```
47114983
```

## Full name

Technical name: `full_name`

Extract full name from the last utterance.

* Languages: cs, sk, pl, de, en, ro, hu.

| Parameter                                                         | Name             | Required | Default | Description                                                                                                         |
| ----------------------------------------------------------------- | ---------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------- |
| Complete name                                                     | `complete`       | no       | `True`  | If set to False, extractor will return list of detected names and surnames.                                         |
| Retry on fail                                                     | `retry_on_fail`  | no       | `False` | If set to True, extractor will retry on preprocessed tokens if fails on raw utterance.                              |
| Custom input                                                      | `custom_input`   | no       |         | Custom input defined by the user from the flow. If set then it will be used as input instead of the last utterance. |
| Return index of start and end of a name and surname in utterance. | `return_indices` | no       | `False` | If set to True, extractor will return entities with indices.                                                        |

**Example input:** Jan Veselý prošel Prahou

**Example output:**

```
{'name': 'Jan', 'surname': 'Veselý'}
```

## Full name and gender

Technical name: `full_name_and_gender`

Extract full name and its gender from the last utterance.

* Languages: cs, sk, pl, de, en, hu.

| Parameter     | Name           | Required | Default | Description                                                                                                         |
| ------------- | -------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------- |
| Complete name | `complete`     | no       | `True`  | If set to False, extractor will return list of detected names and surnames (if found)                               |
| Custom input  | `custom_input` | no       |         | Custom input defined by the user from the flow. If set then it will be used as input instead of the last utterance. |

**Example input:** Jan Veselý prošel Prahou

**Example output:**

```
{'gender': 'M', 'name': 'Jan', 'surname': 'Veselý'}
```

## Full name from input data

Technical name: `full_name_from_input_data`

Extract full name and optionally its gender from utterance using User Data Table.

* Can also be used in expressions as `full_name_from_input_data()`.
* Languages: cs, sk, pl, de, en, nl, fr, ro.

| Parameter             | Name                    | Required | Default | Description                                                                                                         |
| --------------------- | ----------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------- |
| Input data name       | `input_data_name`       | yes      |         | Name of the input data table, where the database of names/surnames is stored.                                       |
| Lookup column name    | `lookup_column_name`    | yes      |         | Name of the column, where the list of potential names is stored.                                                    |
| Lookup column surname | `lookup_column_surname` | yes      |         | Name of the column, where the list of potential surnames is stored.                                                 |
| Lookup column gender  | `lookup_column_gender`  | no       |         | Name of the column, where the gender information for names is stored.                                               |
| Complete name         | `complete`              | no       | `True`  | If set to False, extractor will return list of detected surnames and names instead of full name.                    |
| Custom input          | `custom_input`          | no       |         | Custom input defined by the user from the flow. If set then it will be used as input instead of the last utterance. |

**Example input:** Jan Veselý prošel Prahou

**Example output:**

```
{'gender': 'M', 'name': 'Jan', 'surname': 'Veselý'}
```

## Full name in nominative

Technical name: `full_name_extract_replace`

Extract full name in Nominative from the last utterance.

* Languages: pl.

| Parameter          | Name           | Required | Default | Description                                                                                                         |
| ------------------ | -------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------- |
| Complete name      | `complete`     | no       | `True`  | If set to False, extractor will return list of detected names and surnames.                                         |
| Name gender switch | `gender`       | no       | `False` | If set to True, extractor will also return detected name gender.                                                    |
| Custom input       | `custom_input` | no       |         | Custom input defined by the user from the flow. If set then it will be used as input instead of the last utterance. |

**Example input:** vidim Jana Veseleho, prošel Prahou

**Example output:**

```
{'gender': 'M', 'name': 'Jan', 'surname': 'Veselý'}
```

## Job pronunciation

Technical name: `pronounce_job`

Return the phonetic pronunciation of a provided job name in the specified language (supports Czech).

* Can also be used in expressions as `pronounce_job()`.
* Languages: cs.

| Parameter | Name       | Required | Default | Description                                 |
| --------- | ---------- | -------- | ------- | ------------------------------------------- |
| Job name  | `job_name` | yes      |         | Job name to get phonetic pronunciation for. |

**Example input:** This function does not use the user input utterance.

**Example output:**

```
bekgraund
```

## Military rank extractor

Technical name: `military_rank`

Return the military rank name in nominative case from the user’s utterance; support options to include character indices or all matches.

* Languages: cs, sk.

| Parameter       | Name              | Required | Default | Description                                                                                                          |
| --------------- | ----------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------- |
| Get indices     | `get_indices`     | no       | `False` | When on, return the rank together with the position of the match in the text (start, end), instead of only the rank. |
| Get all indices | `get_all_indices` | no       | `False` | When on, return all matching ranks with their character indices.                                                     |

**Example input:** Chci mluvit s plukovníkem Petrem Drsným

**Example output:**

```
plukovník
```
