LuisService class

Package:

botframework-config

Warning

This API is now deprecated.

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

Defines a LUIS service connection.

Extends

ConnectedService

Constructors

LuisService(ILuisService, ServiceTypes)

Creates a new LuisService instance.

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.
region	Region for luis.
subscriptionKey	Subscription key for using calling model api for predictions.
version	Version of the application.

Inherited Properties

id	Unique Id for the service.
name	Friendly name for the service.
type

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.

Inherited Methods

toJSON()

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

Constructor Details

LuisService(ILuisService, ServiceTypes)

Creates a new LuisService instance.

new LuisService(source?: ILuisService, serviceType?: ServiceTypes)

Parameters

source

ILuisService

(Optional) JSON based service definition.

serviceType

ServiceTypes

(Optional) type of service being defined.

Property Details

appId

Luis app ID.

appId: string

Property Value

string

authoringKey

Authoring key for using authoring api.

authoringKey: string

Property Value

string

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

region

Region for luis.

region: string

Property Value

string

subscriptionKey

Subscription key for using calling model api for predictions.

subscriptionKey: string

Property Value

string

version

Version of the application.

version: string

Property Value

string

Inherited Property Details

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

type

type?: ServiceTypes

Property Value

ServiceTypes

Inherited From ConnectedService.type

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.

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.

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 Method Details

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