Page tree
Skip to end of metadata
Go to start of metadata

Помогает человеку быстро ввести ФИО на веб-форме или в приложении.

Что умеет:

✔️ Подсказывает ФИО одной строкой или отдельно фамилию, имя, отчество.

✔️ Исправляет клавиатурную раскладку («fynjy» → «Антон»).

✔️ Определяет пол.

Не умеет:

❌ Автоматически (без участия человека) обработать ФИО из базы или файла.

❌ Транслитерировать (Juliia Somova → Юлия Сомова).

❌ Склонять по падежам (кого? кому? кем?).

Подсказки не подходят для автоматической обработки ФИО. Они предлагают варианты, но не гарантируют, что угадали правильно. Поэтому окончательное решение всегда должен принимать человек.

Запрос

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{ "query": "Виктор Иван" }' \
  http://ВАШ_СЕРВЕР:ПОРТ/suggestions/api/4_1/rs/suggest/fio

Заголовки

ЗаголовокОписание
Content-Type

Тип данных в запросе: application/json или application/xml

Accept
Тип данных в ответе: application/json или application/xml
Authorization

API-ключ в формате: Token ВАШ_КЛЮЧ

Только для пользователей подсказок DaData.ru

Параметры

ПараметрОбязательный?Описание
queryдаЗапрос, для которого нужно получить подсказки
count
нет
Количество возвращаемых подсказок (по умолчанию — 10, максимум — 20).
partsнетПодсказки по части ФИО
genderнетПол (UNKNOWN / MALE / FEMALE)

Ответ

Возвращается список объектов ФИО:

ПолеТип данных

Описание

valuestring(1000)ФИО одной строкой
unrestricted_valuestring(1000)= value
data.surnamestring(100)Фамилия
data.namestring(100)Имя

data.patronymic

string(100)Отчество
data.genderstring(10)

Пол

  • FEMALE;
  • MALE;
  • UNKNOWN  — не удалось однозначно определить.
data.qcstring(10)Код качества
  • 0 - если все части ФИО найдены в справочниках.
  • 1 - если в ФИО есть часть не из справочника
data.source
Не заполняется

Примеры

Запрос:

{
  "query": "Виктор Иван",
  "count": 7
} 

Ответ:

{
    "suggestions": [
        {
            "value": "Иванов Виктор",
            "unrestricted_value": "Иванов Виктор",
            "data": {
                "surname": "Иванов",
                "name": "Виктор",
                "patronymic": null,
                "gender": "MALE"
            }
        },
        {
            "value": "Иванченко Виктор",
            "unrestricted_value": "Иванченко Виктор",
            "data": {
                "surname": "Иванченко",
                "name": "Виктор",
                "patronymic": null,
                "gender": "MALE"
            }
        },
        {
            "value": "Виктор Иванович",
            "unrestricted_value": "Виктор Иванович",
            "data": {
                "surname": null,
                "name": "Виктор",
                "patronymic": "Иванович",
                "gender": "MALE"
            }
        }
    ]
}

Запрос:

<req>
    <query>Виктор Иван</query>
    <count>7</count>
</req>

Ответ:

<SuggestResponse>
    <suggestions>
        <value>Иванов Виктор</value>
        <unrestricted_value>Иванов Виктор</unrestricted_value>
        <data>
            <surname>Иванов</surname>
            <name>Виктор</name>
            <patronymic/>
            <gender>MALE</gender>
        </data>
    </suggestions>
    <suggestions>
        <value>Иванченко Виктор</value>
        <unrestricted_value>Иванченко Виктор</unrestricted_value>
        <data>
            <surname>Иванченко</surname>
            <name>Виктор</name>
            <patronymic/>
            <gender>MALE</gender>
        </data>
    </suggestions>
    <suggestions>
        <value>Виктор Иванович</value>
        <unrestricted_value>Виктор Иванович</unrestricted_value>
        <data>
            <surname/>
            <name>Виктор</name>
            <patronymic>Иванович</patronymic>
            <gender>MALE</gender>
        </data>
    </suggestions>
</SuggestResponse>
  • No labels