botbuilder-ai package

Classes

CustomQuestionAnswering	Query a Custom Question Answering knowledge base for answers and provide feedbacks.
LuisAdaptivePredictionOptionsConverter	Converts optional parameters for a LUIS prediction request.
LuisAdaptiveRecognizer	Class that represents an adaptive LUIS recognizer.
LuisBotComponent	LUIS @see cref="BotComponent" definition.
LuisComponentRegistration	Define component assets for Luis.
LuisRecognizer	Recognize intents in a user utterance using a configured LUIS model.
LuisRecognizerInternal	Abstract class for Luis Recognizer.
LuisRecognizerV2	Recognize intents in a user utterance using a configured LUIS model.
LuisRecognizerV3	Recognize intents in a user utterance using a configured LUIS model.
LuisTelemetryConstants	The BotTelemetryClient event and property names that logged by default.
QnACardBuilder	Provides methods to create activities containing hero cards for showing active learning or multi-turn prompt options for the QnAMakerDialog.
QnAMaker	Query a QnA Maker knowledge base for answers and provide feedbacks.
QnAMakerBotComponent	Class which contains registration of components for QnAMaker.
QnAMakerComponentRegistration	Define component assets for QnAMaker.
QnAMakerDialog	A dialog that supports multi-step and adaptive-learning QnA Maker services.
QnAMakerRecognizer	A recognizer which uses QnAMaker KB to recognize intents.
QnATelemetryConstants	The BotTelemetryClient event, property and metric names that logged by default.
ActiveLearningUtils	Generate Answer api utils class.
BindToActivity	Creates a new template to send the user based on the activity.
GenerateAnswerUtils	Generate Answer api utils class.
HttpRequestUtils	Http request utils class.
LanguageServiceUtils	Utilities for using Query Knowledge Base and Add Active Learning feedback APIs of language service.
TrainUtils	Generate Answer api utils class.

Interfaces

QnAMakerClient	Client to access a QnA Maker knowledge base.
QnAMakerTelemetryClient	Interface for adding telemetry logging capabilities to QnAMaker.
DateTimeSpec	The date time recognizer can recognize a wide variety of time expressions.
ExternalEntity	Defines a user predicted entity that extends an already existing one.
GeographyV2	Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT License.
InstanceData	Strongly typed information corresponding to a LUIS $instance value.
IntentData	Strongly typed information corresponding to a LUIS intent.
ListElement	Defines a sub-list to append to an existing list entity.
LuisAdaptivePredictionOptions	Optional parameters for a LUIS prediction request.
LuisAdaptivePredictionOptionsConfiguration
LuisAdaptiveRecognizerConfiguration
LuisApplication	Description of a LUIS application used for initializing a LuisRecognizer.
LuisPredictionOptions	Options per LUIS prediction.
LuisRecognizerOptions
LuisRecognizerOptionsV2
LuisRecognizerOptionsV3
LuisRecognizerTelemetryClient
NumberWithUnits	Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT License.
OrdinalV2	Position in a sequence relative to another position.
QnAMakerDialogConfiguration
QnAMakerDialogOptions	Options for QnAMakerDialog.
QnAMakerDialogResponseOptions	QnAMakerDialog response options.
QnAMakerRecognizerConfiguration
AnswerSpanResponse	Precise Answer, which is part of Answer returned by GenerateAnswer call to the QnA Maker Service.
FeedbackRecord	Defines active learning feedback record.
FeedbackRecords	Defines array of active learning feedback records.
Filters	Defines query filters comprising of metadata and sources
KnowledgeBaseAnswer	KnowledgeBaseAnswer - KB answer to the user query
KnowledgeBaseAnswerSpan	KnowledgeBaseAnswerSpan - precise answer format
KnowledgeBaseAnswers	KnowledgeBaseAnswers - query knowledgebases response format
MetadataFilter	Defines metadata filters and corresponding logical operation.
QnARequestContext	The context associated with QnA. Used to mark if the current prompt is relevant with a previous question or not.
QnAResponseContext	The context associated with QnA. Used to mark if the qna response has related prompts.
QnAMakerEndpoint	Defines an endpoint used to connect to a QnA Maker Knowledge base.
QnAMakerMetadata	Metadata associated with the answer.
QnAMakerOptions	Additional settings used to configure a QnAMaker instance.
QnAMakerPrompt	QnAMaker Prompt Object.
QnAMakerResult	An individual answer returned by a call to the QnA Maker Service.
QnAMakerResults	An object returned by a call to the QnA Maker Service.
QnAMakerTraceInfo	Trace info that we collect and emit from a QnA Maker query

Type Aliases

window
DynamicList	Defines an extension for a list entity.
QnASuggestionsActivityFactory	Returns an activity with active learning suggestions. Important: The activity returned should relay the noMatchesText as an option to the end user.

Enums

GeographyV2Type
Anchor	Anchor for relative position in a sequence.
JoinOperator	Join Operator for Strict Filters.
RankerTypes	Enumeration of types of ranking.
ServiceType	Enumeration of types of services.

Functions

validateDynamicList(DynamicList)	Validate the DynamicList object, throw if validation fails.
validateExternalEntity(ExternalEntity)	Validate the ExternalEntity object, throw if validation fails.
getFetch()	Gets the fetch library.
validateListElement(ListElement)	Validate the ListElement object, throw if validation fails.
isLuisRecognizerOptionsV2(unknown)	Validates if the options provided are valid LuisRecognizerOptionsV2.
isLuisRecognizerOptionsV3(unknown)	Validates if the options provided are valid LuisRecognizerOptionsV3.

Function Details

validateDynamicList(DynamicList)

Validate the DynamicList object, throw if validation fails.

function validateDynamicList(dynamicList: DynamicList)

Parameters

dynamicList

DynamicList

The DynamicList object to be validated.

validateExternalEntity(ExternalEntity)

Validate the ExternalEntity object, throw if validation fails.

function validateExternalEntity(entity: ExternalEntity)

Parameters

entity

ExternalEntity

The ExternalEntity object to be validated.

getFetch()

Gets the fetch library.

function getFetch(): any

Returns

any

The fetch library.

validateListElement(ListElement)

Validate the ListElement object, throw if validation fails.

function validateListElement(element: ListElement)

Parameters

element

ListElement

The ListElement object to be validated.

isLuisRecognizerOptionsV2(unknown)

Validates if the options provided are valid LuisRecognizerOptionsV2.

function isLuisRecognizerOptionsV2(options: unknown): boolean

Parameters

options

unknown

options to type test

Returns

boolean

A boolean value that indicates param options is a LuisRecognizerOptionsV2.

isLuisRecognizerOptionsV3(unknown)

Validates if the options provided are valid LuisRecognizerOptionsV3.

function isLuisRecognizerOptionsV3(options: unknown): boolean

Parameters

options

unknown

options to type test

Returns

boolean

A boolean value that indicates param options is a LuisRecognizerOptionsV3.