botbuilder-dialogs package

クラス

ChoiceFactory

選択肢の一覧を含む "メッセージ" アクティビティの書式設定を支援する一連のユーティリティ関数。

ComponentDialog

他の子ダイアログを含むダイアログの基本クラス。

Configurable

すべての構成可能なクラスの基底クラス。

Dialog

すべてのダイアログのコア動作を定義します。

DialogContainer

ダイアログのセットのコンテナー。

DialogContext

現在のダイアログのコンテキストは、特定の DialogSet に関して変わります。

DialogContextError

ダイアログ スタックを含む追加のダイアログ コンテキストを含むエラー。

DialogEvents

ダイアログの "ライフサイクル" に関連するイベントを表します。

DialogManager

ダイアログ システムを実行するクラス。

DialogSet

すべてのユーザーが相互に呼び出すことができる、関連するダイアログ のセット。

DialogTurnStateConstants

ダイアログ ターン状態定数を定義します。

DialogsBotComponent

ボット ダイアログのボット コンポーネント。

DialogsComponentRegistration

ダイアログ コンポーネントをシステム登録機能で使用できるようにします。

DialogPath

使用可能なダイアログのパスを定義します。

DialogStateManager

DialogStateManager は、メモリ スコープとパス リゾルバーを管理します。

AliasPathResolver

aliasXXX -> path.xxx ($foo => dialog.foo) をマップします。

AtAtPathResolver

マップ @@ => 配列 turn.recognized.entitites.xxx。

AtPathResolver

マップ @@ => turn.recognized.entitites.xxx[0]

DollarPathResolver

マップ $xxx => dialog.xxx

HashPathResolver

マップ #xxx => turn.recognized.intents.xxx

PercentPathResolver

マップ %xxx => class.xxx (別名 activeDialog.properties.xxx)

ScopePath

使用可能なスコープのパスを定義します。

BotStateMemoryScope

BotState に基づくメモリ スコープの基底クラス。

ClassMemoryScope

ClassMemoryScope マップ "class" -> dc.activeDialog.properties

ConversationMemoryScope

現在の会話をスコープとするメモリ。

DialogClassMemoryScope

DialogClassMemoryScope マップ "dialogClass" -> dc.parent.activeDialog.properties

DialogContextMemoryScope

DialogContextMemoryScope 'dialogcontext' -> プロパティをマップします。

DialogMemoryScope

DialogMemoryScope マップ "dialog" -> dc.parent.activeDialog.state || dc.activeDialog.state

MemoryScope

すべてのメモリ スコープの抽象基本クラス。

SettingsMemoryScope

SettingsMemoryScope maps "settings" -> dc.context.turnState['settings']

ThisMemoryScope

ThisMemoryScope は "this" -> dc.activeDialog.state をマップします

TurnMemoryScope

TurnMemoryScope は、現在のターンをスコープとするメモリを表します。

UserMemoryScope

現在のユーザーにスコープが設定されているメモリ。

ThisPath

アクティブなダイアログに渡されるパスを定義します。

TurnPath

許容ターンのパスを定義します。

ActivityPrompt

アクティビティの受信を待機します。

AttachmentPrompt

画像などの添付ファイルをアップロードするようにユーザーに求めます。

ChoicePrompt

選択肢の一覧から選択するようにユーザーに求めます。

ConfirmPrompt

"はい" または "いいえ" の応答で何かを確認するようにユーザーに求めます。

DateTimePrompt

datetime 式の入力をユーザーに求めます。

NumberPrompt

ユーザーに数値の入力を求めるメッセージを表示します。

OAuthPrompt

Bot Frameworks シングル サインオン (SSO) サービスを使用してサインインするようにユーザーに求める新しいプロンプトを作成します。

Prompt

すべてのプロンプトの基底クラス。

PromptCultureModels

確認および選択プロンプトで現在サポートされているカルチャ モデルのクラス コンテナー。

TextPrompt

ユーザーにテキストの入力を求めるメッセージを表示します。

Recognizer

Recognizer 基本クラス。

SkillDialog

スキルへのリモート呼び出しをラップできる特殊なダイアログ。

WaterfallDialog

ウォーターフォールは、一連の質問をユーザーに求めるダイアログです。

WaterfallStepContext

WaterfallStep渡されるコンテキスト オブジェクト。

インターフェイス

BeginSkillDialogOptions

SkillDialog のダイアログ引数を持つクラス。

ChoiceFactoryOptions

選択肢リストの書式設定を調整するために使用される追加のオプション。

Choice

ユーザーに選択肢を表示したり、ユーザーが選択した内容を認識したりするために使用できる選択肢のインスタンス。

FindChoicesOptions

によって実行される認識を制御する findChoices()オプション。

FoundChoice

によって findChoices()返される結果。

FindValuesOptions

ユーザーの発話での選択肢の認識方法を制御するために使用される基本的な検索オプション。

FoundValue

INTERNAL: によって findValues()返される生の検索結果。

SortedValue

INTERNAL: 並べ替え可能で、ソース配列内の元の位置を参照できる値。 関数は findChoices() 、渡された選択肢を個々 SortedValue のインスタンスに展開し、 に findValues()渡します。 各個人 Choice は、検索する必要がある複数のシノニムになる可能性があるため、このデータ構造では、各シノニムを検索する値として渡すことができます。同時に、その値の取得元の選択のインデックスを維持できます。

ModelResult

のような recognizeChoices()エンティティ認識エンジンによって返される外側の結果。

Token

によって返される個々の TokenizerFunctionトークン。

Converter

コンバーターは、ある型から別の型にオブジェクトを変換します。

DialogConfiguration
DialogEvent
DialogInstance

スタック上のダイアログのインスタンスの状態情報を格納します。

DialogTurnResult

ダイアログ コンテキストが 1 つ以上のダイアログを開始、続行、または操作しようとした結果を表します。

DialogState

特定の DialogSet のダイアログ状態、ダイアログ スタックの状態に関する情報が含まれます。

DialogManagerConfiguration
DialogManagerResult
DialogDependencies
ComponentMemoryScopes

メモリ スコープを列挙するためのインターフェイス。

ComponentPathResolvers

パス リゾルバーを宣言するためのインターフェイス。

DialogStateManagerConfiguration
PathResolver

Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT License.

ChoiceDefaultsChoicePrompt
ChoiceDefaultsConfirmPrompt
DateTimeResolution

によって DateTimePrompt返される結果。

OAuthPromptSettings

インスタンスの構成に使用される OAuthPrompt 設定。

PromptOptions

すべてのプロンプトでサポートされる基本的な構成オプション。

PromptRecognizerResult

prompts recognizer 関数によって返される結果。

PromptValidatorContext

カスタム PromptValidatorに渡されるコンテキスト情報。

PromptCultureModel
RecognizerConfiguration
SkillDialogOptions
TemplateInterface

データを T にバインドするためのテンプレート インターフェイスを定義します。

WaterfallStepInfo

コンストラクターに WaterfallStepContext 渡される値。

型エイリアス

TokenizerFunction

、、または findValues()に渡すことができる代替ワード ブレーカーのrecognizeChoices()findChoices()署名。

type TokenizerFunction = (text: string, locale?: string) => Token[];
ConverterFactory
PromptValidator

カスタム プロンプト検証コントロールを提供するための関数シグネチャ。

type PromptValidator<T> = (prompt: PromptValidatorContext<T>) => Promise<boolean>;
WaterfallStep

個々のウォーターフォール ステップの関数シグネチャ。

type WaterfallStep<O extends object = {}> = (step: WaterfallStepContext<O>) => Promise<DialogTurnResult>;

列挙型

DialogReason

ダイアログ メソッドが呼び出される理由を示します。

DialogTurnStatus

ダイアログ コンテキストが 1 つ以上のダイアログの開始、続行、またはその他の操作を試みた後のダイアログ スタックの状態を表します。 参照

ListStyle

の オプションまたは yes/no オプションConfirmPromptの選択肢をChoicePromptユーザーに表示する方法を制御します。

関数

findChoices(string, string | Choice[], FindChoicesOptions)

発話内の選択肢を認識するための中間レベルの検索機能。

findValues(string, SortedValue[], FindValuesOptions)

INTERNAL: 発話内の値のセットを検索する低レベル関数。 や recognizeChoices() などのfindChoices()上位レベルの関数は、この関数の上に階層化されています。 ほとんどの場合、より高いレベルの関数の 1 つを呼び出す方が簡単ですが、この関数には選択認識を促進するあいまい検索アルゴリズムが含まれています。

recognizeChoices(string, string | Choice[], FindChoicesOptions)

ユーザーの発話内の選択肢を認識するための高レベル関数。

defaultTokenizer(string, string)

スペースと句読点を区切る単純なトークナイザー。

getActiveDialogContext(DialogContext)

DC スタックを再帰的にウォークアップして、アクティブな DC を見つけます。

internalRun(TurnContext, string, DialogContext, DialogStateManagerConfiguration)
isFromParentToSkill(TurnContext)

スキルがスキルの親として機能しているかどうかを判断します。

runDialog(Dialog, TurnContext, StatePropertyAccessor<DialogState>)

特定のコンテキストとアクセサーからダイアログを実行します。

shouldSendEndOfConversationToParent(TurnContext, DialogTurnResult)

親に EoC を送信する必要があるかどうかを判断するヘルパー。

isComponentMemoryScopes(unknown)

ComponentRegistrationComponentMemoryScopes かどうかを確認します。

isComponentPathResolvers(unknown)

ComponentRegistrationComponentPathResolvers かどうかを確認します。

createConnectorClient(TurnContext, string, ClaimsIdentity, string)
exchangeToken(TurnContext, OAuthPromptSettings, TokenExchangeRequest)
getSignInResource(TurnContext, OAuthPromptSettings)
getUserToken(TurnContext, OAuthPromptSettings, string)
signOutUser(TurnContext, OAuthPromptSettings)

関数の詳細

findChoices(string, string | Choice[], FindChoicesOptions)

発話内の選択肢を認識するための中間レベルの検索機能。

function findChoices(utterance: string, choices: string | Choice[], options?: FindChoicesOptions): ModelResult<FoundChoice>[]

パラメーター

utterance

string

検索対象のテキストまたはユーザーの発話。 受信した "メッセージ" アクティビティの場合は、 を使用 context.activity.textするだけです。

choices

string | Choice[]

検索対象の選択肢の一覧。

options
FindChoicesOptions

(省略可能) 実行される検索を調整するために使用されるオプション。

戻り値

最初に最も関連性の高い順に並べ替えられた、見つかった選択肢の一覧。

注釈

この関数は上 findValues() に重ねられ、実際の検索を実行するために を呼び出す findValues() 前に検索する必要があるすべてのシノニムを決定するだけです。 関数は recognizeChoices() 、この関数の上に階層化され、リスト内のインデックスまたは序数の位置によって選択を選択する機能を追加します。 この特定の関数を呼び出すことは、 によって recognizeChoices()インデックスと序数の位置認識が行われないようにする場合に便利です。

const { findChoices } = require('botbuilder-choices');

const choices = ['red', 'green', 'blue'];
const utterance = context.activity.text;
const results = findChoices(utterance, choices);
if (results.length == 1) {
    await context.sendActivity(`I like ${results[0].resolution.value} too!`);
} else if (results.length > 1) {
    const ambiguous = results.map((r) => r.resolution.value);
    await context.sendActivity(ChoiceFactory.forChannel(context, ambiguous, `Which one?`));
} else {
    await context.sendActivity(ChoiceFactory.forChannel(context, choices, `I didn't get that... Which color?`));
}

findValues(string, SortedValue[], FindValuesOptions)

INTERNAL: 発話内の値のセットを検索する低レベル関数。 や recognizeChoices() などのfindChoices()上位レベルの関数は、この関数の上に階層化されています。 ほとんどの場合、より高いレベルの関数の 1 つを呼び出す方が簡単ですが、この関数には選択認識を促進するあいまい検索アルゴリズムが含まれています。

function findValues(utterance: string, values: SortedValue[], options?: FindValuesOptions): ModelResult<FoundValue>[]

パラメーター

utterance

string

検索対象のテキストまたはユーザーの発話。

values

SortedValue[]

検索対象の値の一覧。

options
FindValuesOptions

(省略可能) 実行される検索を調整するために使用されるオプション。

戻り値

見つかった値の一覧。

recognizeChoices(string, string | Choice[], FindChoicesOptions)

ユーザーの発話内の選択肢を認識するための高レベル関数。

function recognizeChoices(utterance: string, choices: string | Choice[], options?: FindChoicesOptions): ModelResult<FoundChoice>[]

パラメーター

utterance

string

検索対象のテキストまたはユーザーの発話。 受信した "メッセージ" アクティビティの場合は、 を使用 context.activity.textするだけです。

choices

string | Choice[]

検索対象の選択肢の一覧。

options
FindChoicesOptions

(省略可能) 実行される検索を調整するために使用されるオプション。

戻り値

最初に最も関連性の高い順に並べ替えられた、見つかった選択肢の一覧。

注釈

これは関数の findChoices() 上に階層化され、ユーザーがインデックスで選択を指定できるようにするロジック (選択するには "1" と choice[0]言うことができます) または序数位置 (2 番目の位置を選択 choice[1]する場合があります) を追加します。ユーザーの発話は、次の順序で認識されます。

  • を使用して名前を指定 findChoices()します。
  • 1 の基づく序数の位置。
  • 1 のベースのインデックス位置。
const { recognizeChoices } = require('botbuilder-choices');

const choices = ['red', 'green', 'blue'];
const utterance = context.activity.text;
const results = recognizeChoices(utterance, choices);
if (results.length == 1) {
    await context.sendActivity(`I like ${results[0].resolution.value} too!`);
} else if (results.length > 1) {
    const ambiguous = results.map((r) => r.resolution.value);
    await context.sendActivity(ChoiceFactory.forChannel(context, ambiguous, `Which one?`));
} else {
    await context.sendActivity(ChoiceFactory.forChannel(context, choices, `I didn't get that... Which color?`));
}

defaultTokenizer(string, string)

スペースと句読点を区切る単純なトークナイザー。

function defaultTokenizer(text: string, _locale?: string): Token[]

パラメーター

text

string

入力テキスト。

_locale

string

省略可能。入力テキストのロケールを識別します。

戻り値

Token[]

トークンの一覧。

注釈

唯一の正規化は、トークンを小文字にすることです。 開発者は、このトークナイザーを独自の関数でラップして、 ステミングなどの追加の正規化を実行できます。

const { recognizeChoices, defaultTokenizer } = require('botbuilder-choices');
const stemmer = require('stemmer');

function customTokenizer(text, locale) {
   const tokens = defaultTokenizer(text, locale);
   tokens.forEach((t) => {
       t.normalized = stemmer(t.normalized);
   });
   return tokens;
}

const choices = ['red', 'green', 'blue'];
const utterance = context.activity.text;
const results = recognizeChoices(utterance, choices, { tokenizer: customTokenizer });

getActiveDialogContext(DialogContext)

DC スタックを再帰的にウォークアップして、アクティブな DC を見つけます。

function getActiveDialogContext(dialogContext: DialogContext): DialogContext

パラメーター

dialogContext
DialogContext

(xref:botbuilder-dialogs。DialogContext) を使用して、ユーザーとの会話の現在のターンを指定します。

戻り値

Active DialogContext

internalRun(TurnContext, string, DialogContext, DialogStateManagerConfiguration)

function internalRun(context: TurnContext, dialogId: string, dialogContext: DialogContext, dialogStateManagerConfiguration?: DialogStateManagerConfiguration): Promise<DialogTurnResult>

パラメーター

context

TurnContext

ターンの TurnContext

dialogId

string

ダイアログ ID。

dialogContext
DialogContext

会話の現在のターンの DialogContext

dialogStateManagerConfiguration
DialogStateManagerConfiguration

ダイアログ状態マネージャーの構成。

戻り値

Promise<DialogTurnResult>

ダイアログ ターンの結果に対する promise 解決。

isFromParentToSkill(TurnContext)

スキルがスキルの親として機能しているかどうかを判断します。

function isFromParentToSkill(context: TurnContext): boolean

パラメーター

context

TurnContext

(xref:botbuilder-core。ユーザーとの会話の現在のターンの TurnContext) オブジェクト。

戻り値

boolean

スキルがスキルの親として機能しているかどうかを表すブール値。

runDialog(Dialog, TurnContext, StatePropertyAccessor<DialogState>)

特定のコンテキストとアクセサーからダイアログを実行します。

function runDialog(dialog: Dialog, context: TurnContext, accessor: StatePropertyAccessor<DialogState>): Promise<void>

パラメーター

dialog
Dialog

実行する ダイアログ

context

TurnContext

(xref:botbuilder-core。ユーザーとの会話の現在のターンの TurnContext) オブジェクト。

accessor

StatePropertyAccessor<DialogState>

BotState オブジェクトで作成された状態プロパティにアクセスするための定義されたメソッド。

戻り値

Promise<void>

shouldSendEndOfConversationToParent(TurnContext, DialogTurnResult)

親に EoC を送信する必要があるかどうかを判断するヘルパー。

function shouldSendEndOfConversationToParent(context: TurnContext, turnResult: DialogTurnResult): boolean

パラメーター

context

TurnContext

ターンの TurnContext

turnResult
DialogTurnResult

ダイアログ ターンの結果。

戻り値

boolean

EoC を送信する場合は True、それ以外の場合は false。

isComponentMemoryScopes(unknown)

ComponentRegistrationComponentMemoryScopes かどうかを確認します。

function isComponentMemoryScopes(component: unknown): boolean

パラメーター

component

unknown

コンポーネントの登録。

戻り値

boolean

チェック結果を入力します。

isComponentPathResolvers(unknown)

ComponentRegistrationComponentPathResolvers かどうかを確認します。

function isComponentPathResolvers(component: unknown): boolean

パラメーター

component

unknown

コンポーネントの登録。

戻り値

boolean

チェック結果を入力します。

createConnectorClient(TurnContext, string, ClaimsIdentity, string)

function createConnectorClient(context: TurnContext, serviceUrl: string, claimsIdentity: ClaimsIdentity, audience: string): Promise<ConnectorClient>

パラメーター

context

TurnContext

serviceUrl

string

claimsIdentity

ClaimsIdentity

audience

string

戻り値

Promise<ConnectorClient>

exchangeToken(TurnContext, OAuthPromptSettings, TokenExchangeRequest)

function exchangeToken(context: TurnContext, settings: OAuthPromptSettings, tokenExchangeRequest: TokenExchangeRequest): Promise<TokenResponse>

パラメーター

context

TurnContext

tokenExchangeRequest

TokenExchangeRequest

戻り値

Promise<TokenResponse>

getSignInResource(TurnContext, OAuthPromptSettings)

function getSignInResource(context: TurnContext, settings: OAuthPromptSettings): Promise<SignInUrlResponse>

パラメーター

context

TurnContext

戻り値

Promise<SignInUrlResponse>

getUserToken(TurnContext, OAuthPromptSettings, string)

function getUserToken(context: TurnContext, settings: OAuthPromptSettings, magicCode: string): Promise<TokenResponse>

パラメーター

context

TurnContext

magicCode

string

戻り値

Promise<TokenResponse>

signOutUser(TurnContext, OAuthPromptSettings)

function signOutUser(context: TurnContext, settings: OAuthPromptSettings): Promise<void>

パラメーター

context

TurnContext

戻り値

Promise<void>