Описание класса Nlu

Nlu
in

bot

components

nlu

Класс отвечающий за обработку естественной речи. Осуществляет поиск различных сущностей в тексте.

Class Nlu

T_FIO		'YANDEX.FIO'
T_GEO		'YANDEX.GEO'
T_DATETIME		'YANDEX.DATETIME'
T_NUMBER		'YANDEX.NUMBER'
T_INTENT_CONFIRM		'YANDEX.CONFIRM'
T_INTENT_REJECT		'YANDEX.REJECT'
T_INTENT_HELP		'YANDEX.HELP'
T_INTENT_REPEAT		'YANDEX.REPEAT'
$nlu	Массив с обработанным nlu.	array
__construct()	Nlu constructor.	mixed
serializeNlu()	Приводит nlu в пригодный для работы вид.	array\|null
setNlu()	Устанавливает данные	void
getData()	Получение обработанного nlu для определенного типа.	array\|null
getUserName()	Получение имени текущего пользователя.	array\|null
getFio()	Получение ФИО.	array
getGeo()	Получение местоположение.	array
getDateTime()	Получение даты и времени.	array
getNumber()	Получение числа.	array
isIntentConfirm()	Вернет true, если пользователь даёт согласие.	bool
isIntentReject()	Вернет true, если пользователь не даёт согласие.	bool
isIntentHelp()	Вернет true, если пользователь просит помощи.	bool
isIntentRepeat()	Вернет true, если пользователь просит повторить последний ответ навыка.	bool
getIntents()	Получение всех intents, как правило получены от Алисы. Все интенты сгенерированы в консоли разработчика.	array\|null
getIntent()	Получение пользовательских интентов. (Актуально для Алисы).	array\|null
getLink()	Получение всех ссылок в тексте.	array
getPhone()	Получение всех номеров телефона в тексте.	array
getEMail()	Получение всех e-mail в тексте.	array

T_FIO


        
        mixed
        $T_FIO
        = 'YANDEX.FIO'

T_GEO


        
        mixed
        $T_GEO
        = 'YANDEX.GEO'

T_DATETIME


        
        mixed
        $T_DATETIME
        = 'YANDEX.DATETIME'

T_NUMBER


        
        mixed
        $T_NUMBER
        = 'YANDEX.NUMBER'

T_INTENT_CONFIRM


        
        mixed
        $T_INTENT_CONFIRM
        = 'YANDEX.CONFIRM'

T_INTENT_REJECT


        
        mixed
        $T_INTENT_REJECT
        = 'YANDEX.REJECT'

T_INTENT_HELP


        
        mixed
        $T_INTENT_HELP
        = 'YANDEX.HELP'

T_INTENT_REPEAT


        
        mixed
        $T_INTENT_REPEAT
        = 'YANDEX.REPEAT'

$nlu

Массив с обработанным nlu.


        private
                array
        $nlu

__construct()

Nlu constructor.


        public
                                __construct(
                )
        : mixed

Return values

mixed

serializeNlu()

Приводит nlu в пригодный для работы вид.


        protected
                                serializeNlu(
                    
                            $nlu :
                array|null
                            
                )
        : array|null

Parameters

$nlu : array|null

Return values

array|null

setNlu()

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

Parameters

$nlu : array|null: Значение для nlu. В случае с Алисой передается в запросе. Для других типов инициируется самостоятельно.

getData()

Получение обработанного nlu для определенного типа.


        private
                                getData(
                    
                            $type :
                string
                            
                )
        : array|null

Parameters

$type : string: Тип данных.

Return values

array|null

getUserName()

Получение имени текущего пользователя.


        public
                                getUserName(
                )
        : array|null

Return values

array|null —

[ [

string username: Логин пользователя.
string first_name: Имя пользователя.
string last_name: Фамилия пользователя. ] ]

getFio()

Получение ФИО.


        public
                                getFio(
                )
        : array

Возвращается массив типа: ['status'=>bool, 'result'=>array]

'status' == true, если значение найдено. Иначе значений найти не удалось. 'result' представляет из себя массив типа [ [ "first_name" => Имя "patronymic_name" => Отчество "last_name" => Фамилия ] ]

Return values

array —

[

bool status
array result [
- string first_name
- string patronymic_name
- string last_name ] ]

getGeo()

Получение местоположение.


        public
                                getGeo(
                )
        : array

Возвращается массив типа: ['status'=>bool, 'result'=>array]

'status' == true, если значение найдено. Иначе значений найти не удалось. 'result' представляет из себя массив типа [ [ "country" => Страна "city" => Город "street" => Улица "house_number" => Номер дома "airport" => Название аэропорта ] ]

Return values

array —

[

bool status
array result [
- string country
- string city
- string street
- int house_number
- string airport ] ]

getDateTime()

Получение даты и времени.


        public
                                getDateTime(
                )
        : array

Возвращается массив типа: ['status'=>bool, 'result'=>array]

'status' == true, если значение найдено. Иначе значений найти не удалось. 'result' представляет из себя массив типа [ [ "year" => Точный год "year_is_relative" => Признак того, что в поле year указано относительное количество лет; "month" => Месяц "month_is_relative" => Признак того, что в поле month указано относительное количество месяцев "day" => День "day_is_relative" => Признак того, что в поле day указано относительное количество дней "hour" => Час "hour_is_relative" => Признак того, что в поле hour указано относительное количество часов "minute" => Минута "minute_is_relative" => Признак того, что в поле minute указано относительное количество минут. ] ]

Return values

array —

[

bool status
array result [
- int year
- bool year_is_relative
- int month
- bool month_is_relative
- int day
- bool day_is_relative
- int hour
- bool hour_is_relative
- int minute
- bool minute_is_relative ] ]

getNumber()

Получение числа.


        public
                                getNumber(
                )
        : array

Возвращается массив типа: ['status'=>bool,'result'=>array]

'status' == true, если значение найдено. Иначе значений найти не удалось. 'result' представляет из себя массив типа [ [ "integer" => Целое число "float" => Десятичная дробь ] ]

Return values

array —

[

bool status
array result [
- int integer or
- float float ] ]

isIntentConfirm()

Вернет true, если пользователь даёт согласие.


        public
                                isIntentConfirm(
                    
            [                $userCommand :
                string
                 = '' ]            
                )
        : bool

Parameters

$userCommand : string = '': Фраза пользователя. Если нет совпадения по интенту, то поиск согласия идет по тексту.

Return values

bool

isIntentReject()

Вернет true, если пользователь не даёт согласие.


        public
                                isIntentReject(
                    
            [                $userCommand :
                string
                 = '' ]            
                )
        : bool

Parameters

$userCommand : string = '': Фраза пользователя. Если нет совпадения по интенту, то поиск несогласия идет по тексту.

Return values

bool

isIntentHelp()

Вернет true, если пользователь просит помощи.


        public
                                isIntentHelp(
                )
        : bool

Return values

bool

isIntentRepeat()

Вернет true, если пользователь просит повторить последний ответ навыка.


        public
                                isIntentRepeat(
                )
        : bool

Return values

bool

getIntents()

Получение всех intents, как правило получены от Алисы. Все интенты сгенерированы в консоли разработчика.


        public
                                getIntents(
                )
        : array|null

Return values

array|null

getIntent()

Получение пользовательских интентов. (Актуально для Алисы).


        public
                                getIntent(
                    
                            $intentName :
                string
                            
                )
        : array|null

В случае успеха вернет массив типа: [['slots'=>array]] Slots зависит от переменных внутри slots в консоли разработчика(https://dialogs.yandex.ru/developer/skills//draft/settings/intents) И включает себя:

type: Тип (YANDEX.STRING)
value: Значение

Parameters

$intentName : string: Название intent`а

Return values

array|null —

[

array slots [
- string type
- array value ] ]

getLink()

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


        public
                        static        getLink(
                    
                            $query :
                string
                            
                )
        : array

Возвращает массив типа: ['status' => bool, 'result' => array]

Parameters

$query : string: Пользовательский запрос.

Return values

array —

[

bool status
array result ]

getPhone()

Получение всех номеров телефона в тексте.


        public
                        static        getPhone(
                    
                            $query :
                string
                            
                )
        : array

Возвращает массив типа: ['status' => bool, 'result' => array]

Parameters

$query : string: Пользовательский запрос.

Return values

array —

[

bool status
array result ]

getEMail()

Получение всех e-mail в тексте.


        public
                        static        getEMail(
                    
                            $query :
                string
                            
                )
        : array

Возвращает массив типа: ['status' => bool, 'result' => array]

Parameters

$query : string: Пользовательский запрос.

Return values

array —

[

bool status
array result ]

Nlu in bot components nlu

Table of Contents

Constants

T_FIO

T_GEO

T_DATETIME

T_NUMBER

T_INTENT_CONFIRM

T_INTENT_REJECT

T_INTENT_HELP

T_INTENT_REPEAT

Properties

$nlu

Methods

__construct()

Return values

serializeNlu()

Parameters

Return values

setNlu()

Parameters

Tags

getData()

Parameters

Tags

Return values

getUserName()

Tags

Return values

getFio()

Tags

Return values

getGeo()

Tags

Return values

getDateTime()

Tags

Return values

getNumber()

Tags

Return values

isIntentConfirm()

Parameters

Tags

Return values

isIntentReject()

Parameters

Tags

Return values

isIntentHelp()

Tags

Return values

isIntentRepeat()

Tags

Return values

getIntents()

Tags

Return values

getIntent()

Parameters

Tags

Return values

getLink()

Parameters

Tags

Return values

getPhone()

Parameters

Tags

Return values

getEMail()

Parameters

Tags

Return values

Search results

Nlu
in

bot

components

nlu