DispatchService class

Package:

botframework-config

Warning

This API is now deprecated.

See https://aka.ms/bot-file-basics for more information.

Defines a dispatch service connection.

Extends

LuisService

Constructors

DispatchService(IDispatchService)

Creates a new DispatchService instance.

Properties

serviceIds

Service IDs that the dispatch model will dispatch across.

Inherited Properties

appId	Luis app ID.
authoringKey	Authoring key for using authoring api.
customEndpoint	URL for a custom endpoint. This should only be used when the LUIS deployed via a container. If a value is set, then the GetEndpoint() method will return the value for Custom Endpoint.
id	Unique Id for the service.
name	Friendly name for the service.
region	Region for luis.
subscriptionKey	Subscription key for using calling model api for predictions.
type
version	Version of the application.

Inherited Methods

decrypt(string, (value: string, secret: string) => string)	Decrypt properties on this service.
encrypt(string, (value: string, secret: string) => string)	Encrypt properties on this service.
getEndpoint()	Get endpoint for the luis service. If a customEndpoint is set then this is returned otherwise the endpoint is automatically generated based on the region set.
toJSON()	Creates a JSON based version of the model for saving to disk.

Constructor Details

DispatchService(IDispatchService)

Creates a new DispatchService instance.

new DispatchService(source?: IDispatchService)

Parameters

source

IDispatchService

(Optional) JSON based service definition.

Property Details

serviceIds

Service IDs that the dispatch model will dispatch across.

serviceIds: string[]

Property Value

string[]

Inherited Property Details

appId

Luis app ID.

appId: string

Property Value

string

Inherited From LuisService.appId

authoringKey

Authoring key for using authoring api.

authoringKey: string

Property Value

string

Inherited From LuisService.authoringKey

customEndpoint

URL for a custom endpoint. This should only be used when the LUIS deployed via a container. If a value is set, then the GetEndpoint() method will return the value for Custom Endpoint.

customEndpoint: string

Property Value

string

Inherited From LuisService.customEndpoint

id

Unique Id for the service.

id: string

Property Value

string

Inherited From ConnectedService.id

name

Friendly name for the service.

name: string

Property Value

string

Inherited From ConnectedService.name

region

Region for luis.

region: string

Property Value

string

Inherited From LuisService.region

subscriptionKey

Subscription key for using calling model api for predictions.

subscriptionKey: string

Property Value

string

Inherited From LuisService.subscriptionKey

type

type?: ServiceTypes

Property Value

ServiceTypes

Inherited From ConnectedService.type

version

Version of the application.

version: string

Property Value

string

Inherited From LuisService.version

Inherited Method Details

decrypt(string, (value: string, secret: string) => string)

Decrypt properties on this service.

function decrypt(secret: string, decryptString: (value: string, secret: string) => string)

Parameters

secret

string

Secret to use to decrypt.

decryptString

(value: string, secret: string) => string

Function called to decrypt an individual value.

Inherited From LuisService.decrypt

encrypt(string, (value: string, secret: string) => string)

Encrypt properties on this service.

function encrypt(secret: string, encryptString: (value: string, secret: string) => string)

Parameters

secret

string

Secret to use to encrypt.

encryptString

(value: string, secret: string) => string

Function called to encrypt an individual value.

Inherited From LuisService.encrypt

getEndpoint()

Get endpoint for the luis service. If a customEndpoint is set then this is returned otherwise the endpoint is automatically generated based on the region set.

function getEndpoint(): string

Returns

string

The URL for this service.

Inherited From LuisService.getEndpoint

toJSON()

Creates a JSON based version of the model for saving to disk.

function toJSON(): IConnectedService

Returns

IConnectedService

An IConnectedService JSON.

Inherited From ConnectedService.toJSON