botbuilder-js/doc/botbuilder-ai

Bot Builder SDK - AI

Globals / botbuilder-ai

Module: botbuilder-ai

Index

References

• Anchor
• CustomQuestionAnswering
• DateTimeSpec
• DynamicList
• ExternalEntity
• GeographyV2
• GeographyV2Type
• InstanceData
• IntentData
• ListElement
• LuisAdaptiveRecognizer
• LuisAdaptiveRecognizerConfiguration
• LuisApplication
• LuisBotComponent
• LuisComponentRegistration
• LuisPredictionOptions
• LuisRecognizer
• LuisRecognizerOptions
• LuisRecognizerOptionsV2
• LuisRecognizerOptionsV3
• LuisRecognizerTelemetryClient
• LuisTelemetryConstants
• NumberWithUnits
• OrdinalV2
• QNAMAKER_TRACE_LABEL
• QNAMAKER_TRACE_NAME
• QNAMAKER_TRACE_TYPE
• QnACardBuilder
• QnAMaker
• QnAMakerBotComponent
• QnAMakerClient
• QnAMakerClientKey
• QnAMakerComponentRegistration
• QnAMakerDialog
• QnAMakerDialogOptions
• QnAMakerDialogResponseOptions
• QnAMakerRecognizer
• QnAMakerRecognizerConfiguration
• QnAMakerTelemetryClient
• QnASuggestionsActivityFactory
• validateDynamicList
• validateExternalEntity
• validateListElement

Enumerations

• Anchor
• GeographyV2Type
• ServiceType

Classes

• CustomQuestionAnswering
• LuisAdaptivePredictionOptionsConverter
• LuisAdaptiveRecognizer
• LuisComponentRegistration
• LuisRecognizer
• LuisTelemetryConstants
• QnACardBuilder
• QnAMaker
• QnAMakerComponentRegistration
• QnAMakerDialog

Interfaces

• DateTimeSpec
• DynamicList
• ExternalEntity
• Filters
• GeographyV2
• InstanceData
• IntentData
• ListElement
• LuisAdaptivePredictionOptions
• LuisAdaptivePredictionOptionsConfiguration
• LuisAdaptiveRecognizerConfiguration
• LuisApplication
• LuisPredictionOptions
• LuisRecognizerOptions
• LuisRecognizerOptionsV2
• LuisRecognizerOptionsV3
• LuisRecognizerTelemetryClient
• MetadataFilter
• NumberWithUnits
• OrdinalV2
• QnAMakerClient
• QnAMakerClient
• QnAMakerDialogConfiguration
• QnAMakerDialogOptions
• QnAMakerDialogResponseOptions
• QnAMakerTelemetryClient
• QnAMakerTelemetryClient

Type aliases

• DynamicList
• QnASuggestionsActivityFactory

Variables

• CQAClientKey
• QNAMAKER_TRACE_LABEL
• QNAMAKER_TRACE_NAME
• QNAMAKER_TRACE_TYPE
• QnAMakerClientKey

Functions

• validateDynamicList
• validateExternalEntity
• validateListElement

References

Anchor

Re-exports: Anchor

---

CustomQuestionAnswering

Re-exports: CustomQuestionAnswering

---

DateTimeSpec

Re-exports: DateTimeSpec

---

DynamicList

Re-exports: DynamicList

---

ExternalEntity

Re-exports: ExternalEntity

---

GeographyV2

Re-exports: GeographyV2

---

GeographyV2Type

Re-exports: GeographyV2Type

---

InstanceData

Re-exports: InstanceData

---

IntentData

Re-exports: IntentData

---

ListElement

Re-exports: ListElement

---

LuisAdaptiveRecognizer

Re-exports: LuisAdaptiveRecognizer

---

LuisAdaptiveRecognizerConfiguration

Re-exports: LuisAdaptiveRecognizerConfiguration

---

LuisApplication

Re-exports: LuisApplication

---

LuisBotComponent

Re-exports: LuisBotComponent

---

LuisComponentRegistration

Re-exports: LuisComponentRegistration

---

LuisPredictionOptions

Re-exports: LuisPredictionOptions

---

LuisRecognizer

Re-exports: LuisRecognizer

---

LuisRecognizerOptions

Re-exports: LuisRecognizerOptions

---

LuisRecognizerOptionsV2

Re-exports: LuisRecognizerOptionsV2

---

LuisRecognizerOptionsV3

Re-exports: LuisRecognizerOptionsV3

---

LuisRecognizerTelemetryClient

Re-exports: LuisRecognizerTelemetryClient

---

LuisTelemetryConstants

Re-exports: LuisTelemetryConstants

---

NumberWithUnits

Re-exports: NumberWithUnits

---

OrdinalV2

Re-exports: OrdinalV2

---

QNAMAKER_TRACE_LABEL

Re-exports: QNAMAKER_TRACE_LABEL

---

QNAMAKER_TRACE_NAME

Re-exports: QNAMAKER_TRACE_NAME

---

QNAMAKER_TRACE_TYPE

Re-exports: QNAMAKER_TRACE_TYPE

---

QnACardBuilder

Re-exports: QnACardBuilder

---

QnAMaker

Re-exports: QnAMaker

---

QnAMakerBotComponent

Re-exports: QnAMakerBotComponent

---

QnAMakerClient

Re-exports: QnAMakerClient

---

QnAMakerClientKey

Re-exports: QnAMakerClientKey

---

QnAMakerComponentRegistration

Re-exports: QnAMakerComponentRegistration

---

QnAMakerDialog

Re-exports: QnAMakerDialog

---

QnAMakerDialogOptions

Re-exports: QnAMakerDialogOptions

---

QnAMakerDialogResponseOptions

Re-exports: QnAMakerDialogResponseOptions

---

QnAMakerRecognizer

Re-exports: QnAMakerRecognizer

---

QnAMakerRecognizerConfiguration

Re-exports: QnAMakerRecognizerConfiguration

---

QnAMakerTelemetryClient

Re-exports: QnAMakerTelemetryClient

---

QnASuggestionsActivityFactory

Re-exports: QnASuggestionsActivityFactory

---

validateDynamicList

Re-exports: validateDynamicList

---

validateExternalEntity

Re-exports: validateExternalEntity

---

validateListElement

Re-exports: validateListElement

Type aliases

DynamicList

Ƭ DynamicList: { entity: string ; list: ListElement[] }

Defined in libraries/botbuilder-ai/lib/luisAdaptiveRecognizer.d.ts:17

Defines an extension for a list entity.

Type declaration:

Name	Type	Description
entity	string	The name of the list to extend.
list	ListElement[]	The lists to append on the extended list entity.

---

QnASuggestionsActivityFactory

Ƭ QnASuggestionsActivityFactory: (suggestionsList: string[], noMatchesText: string) => Partial<Activity>

Defined in libraries/botbuilder-ai/lib/qnaMakerDialog.d.ts:80

Returns an activity with active learning suggestions.

Important: The activity returned should relay the noMatchesText as an option to the end user.

param List of suggestions.

param If this text is received by the bot during a prompt.

Variables

CQAClientKey

• Const CQAClientKey: unique symbol

Defined in libraries/botbuilder-ai/lib/customQuestionAnswering.d.ts:13

Turn state key for QnAMakerClient.

---

QNAMAKER_TRACE_LABEL

• Const QNAMAKER_TRACE_LABEL: "QnAMaker Trace" = "QnAMaker Trace"

Defined in libraries/botbuilder-ai/lib/qnaMaker.d.ts:12

---

QNAMAKER_TRACE_NAME

• Const QNAMAKER_TRACE_NAME: "QnAMaker" = "QnAMaker"

Defined in libraries/botbuilder-ai/lib/qnaMaker.d.ts:11

---

QNAMAKER_TRACE_TYPE

• Const QNAMAKER_TRACE_TYPE: "https://www.qnamaker.ai/schemas/trace" = "https://www.qnamaker.ai/schemas/trace"

Defined in libraries/botbuilder-ai/lib/qnaMaker.d.ts:10

---

QnAMakerClientKey

• Const QnAMakerClientKey: unique symbol

Defined in libraries/botbuilder-ai/lib/qnaMaker.d.ts:16

Turn state key for QnAMakerClient.

Functions

validateDynamicList

▸ validateDynamicList(dynamicList: DynamicList): void

Defined in libraries/botbuilder-ai/lib/dynamicList.d.ts:27

Validate the DynamicList object, throw if validation fails.

Parameters:

Name	Type	Description
dynamicList	DynamicList	The DynamicList object to be validated.

Returns: void

---

validateExternalEntity

▸ validateExternalEntity(entity: ExternalEntity): void

Defined in libraries/botbuilder-ai/lib/externalEntity.d.ts:34

Validate the ExternalEntity object, throw if validation fails.

Parameters:

Name	Type	Description
entity	ExternalEntity	The ExternalEntity object to be validated.

Returns: void

---

validateListElement

▸ validateListElement(element: ListElement): void

Defined in libraries/botbuilder-ai/lib/listElement.d.ts:26

Validate the ListElement object, throw if validation fails.

Parameters:

Name	Type	Description
element	ListElement	The ListElement object to be validated.

Returns: void