QnaMakerService class

Package:

botframework-config

Warning

This API is now deprecated.

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

Defines a QnA Maker service connection.

Extends

ConnectedService

Constructors

QnaMakerService(IQnAService)

Creates a new QnaMakerService instance.

Properties

endpointKey	Endpoint Key for querying the kb.
hostname	hostname for private service endpoint Example: https://myqna.azurewebsites.net.
kbId	Knowledge base id.
subscriptionKey	Subscription key for calling admin api.

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.

Inherited Methods

toJSON()

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

Constructor Details

QnaMakerService(IQnAService)

Creates a new QnaMakerService instance.

new QnaMakerService(source?: IQnAService)

Parameters

source

IQnAService

(Optional) JSON based service definition.

Property Details

endpointKey

Endpoint Key for querying the kb.

endpointKey: string

Property Value

string

hostname

hostname for private service endpoint Example: https://myqna.azurewebsites.net.

hostname: string

Property Value

string

kbId

Knowledge base id.

kbId: string

Property Value

string

subscriptionKey

Subscription key for calling admin api.

subscriptionKey: 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.

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