Поделиться через

BotFrameworkConfig class

  • Ссылка
Пакет:
microsoft-cognitiveservices-speech-sdk

Класс, определяющий конфигурации для объекта соединителя службы диалогов для использования серверной части Bot Framework.

Extends

DialogServiceConfigImpl

Конструкторы

BotFrameworkConfig()

Создает экземпляр BotFrameworkConfig.

Свойства

applicationId

Задает соответствующий идентификатор серверного приложения.
DialogTypes
outputFormat
properties

Предоставляет доступ к пользовательским свойствам.
speechRecognitionLanguage

Возвращает язык распознавания речи.

Методы

fromAuthorizationToken(string, string, string)

Создает экземпляр конфигурации платформы бота для указанного маркера авторизации и региона. Примечание. Вызывающий объект должен убедиться, что маркер авторизации действителен. До истечения срока действия маркера авторизации вызывающий объект должен обновить его, задав свойство authorizationToken в соответствующем экземпляре DialogServiceConnector, созданном с помощью этой конфигурации. Содержимое объектов конфигурации копируется при создании соединителей, поэтому установка authorizationToken в DialogServiceConnector не приведет к обновлению маркера авторизации исходной конфигурации. Создайте новый экземпляр конфигурации или задайте свойство SpeechServiceAuthorization_Token, чтобы обновить существующий экземпляр, если он будет использоваться для создания дополнительных dialogServiceConnectors.
fromEndpoint(URL, string)

Создает экземпляр BotFrameworkConfig. Этот метод предназначен только для пользователей, использующих нестандартную конечную точку службы или параметры. Примечание. Параметры запроса, указанные в URL-адресе конечной точки, не изменяются, даже если они задаются другими API. Примечание. Чтобы использовать маркер авторизации с fromEndpoint, передайте пустую строку в subscriptionKey в методе fromEndpoint, а затем задайте authorizationToken="token" в созданном экземпляре BotFrameworkConfig для использования маркера авторизации. Примечание. Добавлено в версии 1.15.0.
fromHost(string | URL, string, string)

Создает экземпляр BotFrameworkConfig. Этот метод предназначен только для пользователей, использующих узел службы, отличный от узла службы по умолчанию. Предполагается стандартный путь к ресурсу. Для служб с нестандартным путем к ресурсам или вообще без него используйте fromEndpoint. Примечание. Параметры запроса не разрешены в URI узла и должны задаваться другими API. Примечание. Чтобы использовать маркер авторизации с fromHost, используйте fromHost(URL) и задайте свойство AuthorizationToken для созданного экземпляра BotFrameworkConfig. Примечание. Добавлено в версии 1.15.0.
fromSubscription(string, string, string)

Создает экземпляр конфигурации платформы бота с предоставленными сведениями о подписке.

Наследуемые методы

close()

Удалите связанные ресурсы.
getProperty(string | PropertyId, string)

Задает именованное свойство в качестве значения
setProperty(string | PropertyId, string)

Задает именованное свойство в качестве значения
setProxy(string, number, string, string)

Задает конфигурацию прокси-сервера. Применимо только в Node.js средах. Добавлено в версии 1.4.0.
setServiceProperty(string, string, UriQueryParameter)

Сведения о конструкторе

BotFrameworkConfig()

Создает экземпляр BotFrameworkConfig.

new BotFrameworkConfig()

Сведения о свойстве

applicationId

Задает соответствующий идентификатор серверного приложения.

void applicationId

Значение свойства

void

DialogTypes 

static { BotFramework: string, CustomCommands: string } DialogTypes

Значение свойства

{ BotFramework: string, CustomCommands: string }

outputFormat 

OutputFormat outputFormat

Значение свойства

OutputFormat

properties

Предоставляет доступ к пользовательским свойствам.

PropertyCollection properties

Значение свойства

PropertyCollection

Свойства.

speechRecognitionLanguage

Возвращает язык распознавания речи.

string speechRecognitionLanguage

Значение свойства

string

Сведения о методе

fromAuthorizationToken(string, string, string)

Создает экземпляр конфигурации платформы бота для указанного маркера авторизации и региона. Примечание. Вызывающий объект должен убедиться, что маркер авторизации действителен. До истечения срока действия маркера авторизации вызывающий объект должен обновить его, задав свойство authorizationToken в соответствующем экземпляре DialogServiceConnector, созданном с помощью этой конфигурации. Содержимое объектов конфигурации копируется при создании соединителей, поэтому установка authorizationToken в DialogServiceConnector не приведет к обновлению маркера авторизации исходной конфигурации. Создайте новый экземпляр конфигурации или задайте свойство SpeechServiceAuthorization_Token, чтобы обновить существующий экземпляр, если он будет использоваться для создания дополнительных dialogServiceConnectors.

static function fromAuthorizationToken(authorizationToken: string, region: string, botId?: string): BotFrameworkConfig

Параметры

authorizationToken

string

Маркер авторизации, связанный с ботом

region

string

Имя региона (см. страницу региона).

botId

string

Необязательный элемент. Идентификатор для использования определенного бота в группе ресурсов Azure. Эквивалент имени ресурса.

Возвращаемое значение

BotFrameworkConfig

Новый экземпляр конфигурации платформы ботов.

fromEndpoint(URL, string)

Создает экземпляр BotFrameworkConfig. Этот метод предназначен только для пользователей, использующих нестандартную конечную точку службы или параметры. Примечание. Параметры запроса, указанные в URL-адресе конечной точки, не изменяются, даже если они задаются другими API. Примечание. Чтобы использовать маркер авторизации с fromEndpoint, передайте пустую строку в subscriptionKey в методе fromEndpoint, а затем задайте authorizationToken="token" в созданном экземпляре BotFrameworkConfig для использования маркера авторизации. Примечание. Добавлено в версии 1.15.0.

static function fromEndpoint(endpoint: URL, subscriptionKey?: string): BotFrameworkConfig

Параметры

endpoint

URL

Конечная точка службы для подключения.

subscriptionKey

string

Ключ подписки. Если ключ подписки не указан, необходимо задать маркер авторизации.

Возвращаемое значение

BotFrameworkConfig
  • Новый экземпляр конфигурации платформы бота, использующий предоставленную конечную точку.

fromHost(string | URL, string, string)

Создает экземпляр BotFrameworkConfig. Этот метод предназначен только для пользователей, использующих узел службы, отличный от узла службы по умолчанию. Предполагается стандартный путь к ресурсу. Для служб с нестандартным путем к ресурсам или вообще без него используйте fromEndpoint. Примечание. Параметры запроса не разрешены в URI узла и должны задаваться другими API. Примечание. Чтобы использовать маркер авторизации с fromHost, используйте fromHost(URL) и задайте свойство AuthorizationToken для созданного экземпляра BotFrameworkConfig. Примечание. Добавлено в версии 1.15.0.

static function fromHost(host: string | URL, subscriptionKey?: string, botId?: string): BotFrameworkConfig

Параметры

host

string | URL

Если указан URL-адрес, будет использоваться полный узел с протоколом (например, wss://your.host.com:1234). Если указана строка, она будет внедрена в wss://{host}.convai.speech.azure.us.

subscriptionKey

string

Ключ подписки. Если ключ подписки не указан, необходимо задать маркер авторизации.

botId

string

Необязательный элемент. Идентификатор для использования определенного бота в группе ресурсов Azure. Эквивалент имени ресурса.

Возвращаемое значение

BotFrameworkConfig

Новый экземпляр конфигурации платформы ботов.

fromSubscription(string, string, string)

Создает экземпляр конфигурации платформы бота с предоставленными сведениями о подписке.

static function fromSubscription(subscription: string, region: string, botId?: string): BotFrameworkConfig

Параметры

subscription

string

Ключ подписки, связанный с ботом

region

string

Имя региона (см. страницу региона).

botId

string

Необязательный элемент. Идентификатор для использования определенного бота в группе ресурсов Azure. Эквивалент имени ресурса.

Возвращаемое значение

BotFrameworkConfig

Новый экземпляр конфигурации платформы ботов.

Сведения о наследуемом методе

close()

Удалите связанные ресурсы.

function close()

Наследуется от DialogServiceConfigImpl.close

getProperty(string | PropertyId, string)

Задает именованное свойство в качестве значения

function getProperty(name: string | PropertyId, def?: string): string

Параметры

name

string | PropertyId

Возвращаемое свойство.

def

string

Значение по умолчанию, возвращаемое в случае, если свойство неизвестно.

Возвращаемое значение

string

Текущее значение (по умолчанию) заданного свойства.

Наследуется от DialogServiceConfigImpl.getProperty

setProperty(string | PropertyId, string)

Задает именованное свойство в качестве значения

function setProperty(name: string | PropertyId, value: string)

Параметры

name

string | PropertyId

Задаваемое свойство.

value

string

Значение.

Наследуется от DialogServiceConfigImpl.setProperty

setProxy(string, number, string, string)

Задает конфигурацию прокси-сервера. Применимо только в Node.js средах. Добавлено в версии 1.4.0.

function setProxy(proxyHostName: string, proxyPort: number, proxyUserName?: string, proxyPassword?: string)

Параметры

proxyHostName

string

Имя узла прокси-сервера без схемы протокола (http://)

proxyPort

number

Номер порта прокси-сервера.

proxyUserName

string

Имя пользователя прокси-сервера.

proxyPassword

string

Пароль прокси-сервера.

Наследуется от DialogServiceConfigImpl.setProxy

setServiceProperty(string, string, UriQueryParameter) 

function setServiceProperty(name: string, value: string, channel: UriQueryParameter)

Параметры

name

string

value

string

channel
UriQueryParameter

Наследуется от DialogServiceConfigImpl.setServiceProperty