Class Nlu

constructor

• new Nlu(): Nlu

  Конструктор класса Nlu. Инициализирует пустой объект NLU. Кэш данных в конструкторе не аллоцируется — он создаётся лениво при первом извлечении сущности (приватный метод #getCache).

  Returns Nlu

Static ReadonlyT_DATETIME

const dateTime = nlu.getDateTime();
if (dateTime.status) {
    const date = dateTime.result?.[0];

    // Абсолютная дата
    if (date?.year && date.month && date.day) {
        console.log(`Дата: ${date.day}.${date.month}.${date.year}`);
    }

    // Время
    if (date?.hour !== undefined) {
        console.log(`Время: ${date.hour}:${date.minute || '00'}`);
    }

    // Относительная дата
    if (date?.day_is_relative) {
        console.log(`Через ${date.day} дней`);
    }
}
Copy

Static ReadonlyT_FIO

const fio = nlu.getFio();
if (fio.status) {
    console.log(fio.result?.[0]?.first_name); // "Иван"
}
Copy

Static ReadonlyT_GEO

const geo = nlu.getGeo();
if (geo.status) {
    const location = geo.result?.[0];
    console.log('Страна:', location.country);
    console.log('Город:', location.city);
    console.log('Улица:', location.street);
    console.log('Номер дома:', location.house_number);
    console.log('Аэропорт:', location.airport);
}
Copy

Static ReadonlyT_INTENT_CONFIRM

// Проверка на согласие (интент + текстовый фолбэк)
if (nlu.isIntentConfirm('да, конечно')) {
    console.log('Пользователь согласился');
}
Copy

Static ReadonlyT_INTENT_HELP

if (nlu.isIntentHelp()) {
    console.log('Пользователь запросил помощь');
}
Copy

Static ReadonlyT_INTENT_REJECT

// Проверка на отказ (интент + текстовый фолбэк)
if (nlu.isIntentReject('нет, спасибо')) {
    console.log('Пользователь отказался');
}
Copy

Static ReadonlyT_INTENT_REPEAT

if (nlu.isIntentRepeat()) {
    console.log('Пользователь просит повторить');
}
Copy

Static ReadonlyT_NUMBER

const numbers = nlu.getNumber();
if (numbers.status) {
    numbers.result.forEach(number => {
        // Проверка на целое число
        if (Number.isInteger(number)) {
            console.log(`Целое число: ${number}`);
        }
        // Проверка на дробное число
        else if (number % 1 !== 0) {
            console.log(`Дробное число: ${number}`);
        }
    });
}
Copy

getDateTime

• getDateTime(): INluResult<INluDateTime[]>

  Получает дату и время из сущностей NLU (entities), заполненных платформой. На чат-платформах без NLU результат будет пуст (status=false).

  Returns INluResult<INluDateTime[]>

  Результат поиска даты и времени

  Example

  const dateTime = nlu.getDateTime();
  if (dateTime.status) {
      const dt = dateTime.result?.[0];
      if (dt?.year) console.log('Год:', dt.year);
      if (dt?.month) console.log('Месяц:', dt.month);
      if (dt?.day) console.log('День:', dt.day);
      if (dt?.hour !== undefined) console.log('Час:', dt.hour);
      if (dt?.minute !== undefined) console.log('Минуты:', dt.minute);
      if (dt?.day_is_relative) console.log('Относительный день:', dt.day);
  }
  Copy

getFio

• getFio(): INluResult<INluFIO[]>

  Получает ФИО из сущностей NLU (entities), заполненных платформой. На чат-платформах без NLU результат будет пуст (status=false).

  Returns INluResult<INluFIO[]>

  Результат поиска ФИО

  Example

  const fio = nlu.getFio();
  if (fio.status) {
      const person = fio.result?.[0];
      console.log('Имя:', person?.first_name);
      console.log('Фамилия:', person?.last_name);
      console.log('Отчество:', person?.patronymic_name);
  }
  Copy

getGeo

• getGeo(): INluResult<INluGeo[]>

  Получает геолокацию из сущностей NLU (entities), заполненных платформой. На чат-платформах без NLU результат будет пуст (status=false).

  Returns INluResult<INluGeo[]>

  Результат поиска геолокации

  Example

  const geo = nlu.getGeo();
  if (geo.status) {
      const location = geo.result?.[0];
      console.log('Страна:', location?.country);
      console.log('Город:', location?.city);
      console.log('Улица:', location?.street);
      console.log('Номер дома:', location?.house_number);
      console.log('Аэропорт:', location?.airport);
  }
  Copy

getIntent

• getIntent(intentName: string): INluIntent | null

  Получает конкретный интент по имени.

  Parameters

  • intentName: string

    Имя интента

  Returns INluIntent | null

  Интент или null

  Example

  const intent = nlu.getIntent('YANDEX.CONFIRM');
  if (intent) {
      console.log(intent.slots); // { ... }
  }
  Copy

getIntents

• getIntents(): INluIntents | null

  Получает все интенты из текста.

  Returns INluIntents | null

  Объект с интентами или null

  Example

  const intents = nlu.getIntents();
  if (intents) {
      // Проверка наличия конкретного интента
      if (intents['YANDEX.CONFIRM']) {
          console.log('Найден интент согласия');
      }
      if (intents['YANDEX.HELP']) {
          console.log('Найден интент помощи');
      }
      // Получение слотов интента
      const helpIntent = intents['YANDEX.HELP'];
      if (helpIntent && helpIntent.slots) {
          console.log('Слоты интента:', helpIntent.slots);
      }
  }
  Copy

getNluValue

• getNluValue(): INlu

  Возвращает объект nlu, который был обработан платформой, либо заполнен из плагина

  Returns INlu

  Объект данных NLU (entities, intents, thisUser, tokens)

  Example

  const nlu = this.nlu.getNluValue();
  if (nlu.thisUser) {
      console.log('Отправитель:', nlu.thisUser.username);
  }
  Copy

getNumber

• getNumber(): INluResult<number[]>

  Получает числа из сущностей NLU (entities), заполненных платформой. На чат-платформах без NLU результат будет пуст (status=false).

  Returns INluResult<number[]>

  Результат поиска чисел

  Example

  const number = nlu.getNumber();
  if (number.status) {
      const value = number.result?.[0];
      console.log('Число:', value);
      // Проверка типа числа
      if (value !== undefined && Number.isInteger(value)) {
          console.log('Целое число');
      } else {
          console.log('Дробное число');
      }
  }
  Copy

getUserName

• getUserName(): INluThisUser | null

  Получает информацию о текущем пользователе.

  Returns INluThisUser | null

  Информация о пользователе или null

  Example

  const user = nlu.getUserName();
  if (user) {
      console.log('Имя пользователя:', user.first_name);
      console.log('Фамилия пользователя:', user.last_name);
      console.log('Username:', user.username);
  }
  Copy

isIntentConfirm

• isIntentConfirm(userCommand?: string): boolean

  Проверяет наличие интента согласия в тексте.

  Если интент YANDEX.CONFIRM не найден в NLU и передан текст, он дополнительно проверяется через Text.isSayTrue («да», «конечно» и т.п.).

  Parameters

  • OptionaluserCommand: string = ''

    Текст для проверки

  Returns boolean

  true если найден интент согласия

  Example

  if (nlu.isIntentConfirm('да, согласен')) {
      console.log('Пользователь согласился');
  }
  Copy

isIntentHelp

• isIntentHelp(): boolean

  Проверяет интент помощи в nlu.intents (YANDEX.HELP от платформы). Текстового фолбэка нет — в отличие от confirm/reject, без интента метод вернёт false.

  Returns boolean

  true если найден интент помощи

  Example

  if (nlu.isIntentHelp()) {
      console.log('Пользователь запросил помощь');
  }
  Copy

isIntentReject

• isIntentReject(userCommand?: string): boolean

  Проверяет наличие интента отказа в тексте.

  Если интент YANDEX.REJECT не найден в NLU и передан текст, он дополнительно проверяется через Text.isSayFalse («нет», «не хочу» и т.п.).

  Parameters

  • OptionaluserCommand: string = ''

    Текст для проверки

  Returns boolean

  true если найден интент отказа

  Example

  if (nlu.isIntentReject('нет, не хочу')) {
      console.log('Пользователь отказался');
  }
  Copy

isIntentRepeat

• isIntentRepeat(): boolean

  Проверяет интент повтора в nlu.intents (YANDEX.REPEAT от платформы). Текстового фолбэка нет — в отличие от confirm/reject, без интента метод вернёт false.

  Returns boolean

  true если найден интент повтора

  Example

  if (nlu.isIntentRepeat()) {
      console.log('Пользователь просит повторить');
  }
  Copy

setNlu

• setNlu(nlu: INlu, isClearCache?: boolean): void

  Устанавливает данные NLU.

  Кэш извлечённых сущностей очищается только при isClearCache = true — без этого повторный вызов с новыми данными продолжит возвращать закэшированные результаты по старым данным.

  Parameters

  • nlu: INlu

    Данные NLU для обработки

  • OptionalisClearCache: boolean = false

    Флаг, говорящий о том, что нужно сбросить кэш

  Returns void

  Example

  nlu.setNlu({
      entities: [
          {
              type: 'YANDEX.FIO',
              value: { first_name: 'Иван', last_name: 'Иванов' }
          }
      ]
  });
  Copy

StaticgetEMail

• getEMail(query: string): INluResult<string[] | null>

  Извлекает email адреса из текста.

  Parameters

  • query: string

    Текст для поиска

  Returns INluResult<string[] | null>

  Результат поиска email

  Example

  const emails = Nlu.getEMail('Напишите на email@example.com или support@test.ru');
  if (emails.status) {
      emails.result.forEach(email => {
          console.log('Найден email:', email);
      });
  }
  Copy

StaticgetLink

• getLink(query: string): INluResult<string[] | null>

  Извлекает ссылки из текста.

  Parameters

  • query: string

    Текст для поиска

  Returns INluResult<string[] | null>

  Результат поиска ссылок

  Example

  const links = Nlu.getLink('Посетите http://localhost');
  if (links.status) {
      links.result.forEach(link => {
          console.log('Найдена ссылка:', link);
      });
  }
  Copy

StaticgetPhone

• getPhone(query: string): INluResult<string[] | null>

  Извлекает телефонные номера из текста.

  Parameters

  • query: string

    Текст для поиска

  Returns INluResult<string[] | null>

  Результат поиска телефонов

  Example

  const phones = Nlu.getPhone('Позвоните по номеру +7 (999) 123-45-67 или 8-800-555-35-35');
  if (phones.status) {
      phones.result.forEach(phone => {
          console.log('Найден телефон:', phone);
      });
  }
  Copy