botbuilder-dialogs package

클래스

ChoiceFactory	선택 항목 목록이 포함된 '메시지' 작업의 서식을 지정하는 데 도움이 되는 유틸리티 함수 집합입니다.
ComponentDialog	다른 자식 대화 상자가 포함된 대화 상자의 기본 클래스입니다.
Configurable	구성 가능한 모든 클래스에 대한 기본 클래스입니다.
Dialog	모든 대화 상자의 핵심 동작을 정의합니다.
DialogContainer	대화 상자 집합에 대한 컨테이너입니다.
DialogContext	현재 대화 상자의 컨텍스트는 특정 DialogSet관련됩니다.
DialogContextError	대화 스택을 포함하여 추가 대화 컨텍스트를 포함하는 오류입니다.
DialogEvents	대화 상자의 "수명 주기"에 관련된 이벤트를 나타냅니다.
DialogManager	대화 시스템을 실행하는 클래스입니다.
DialogSet	모두 서로 호출할 수 있는 대화 상자의 관련 집합입니다.
DialogTurnStateConstants	대화 상자 턴 상태 상수 정의
DialogsBotComponent	봇 대화 상자의 봇 구성 요소입니다.
DialogsComponentRegistration	시스템 등록 기능에서 대화 상자 구성 요소를 사용할 수 있도록 합니다.
DialogPath	사용 가능한 대화 상자의 경로를 정의합니다.
DialogStateManager	DialogStateManager는 메모리 범위 및 경로 확인자를 관리합니다.
AliasPathResolver	maps 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 maps "class" -> dc.activeDialog.properties
ConversationMemoryScope	현재 대화로 범위가 지정된 메모리입니다.
DialogClassMemoryScope	DialogClassMemoryScope maps "dialogClass" -> dc.parent.activeDialog.properties
DialogContextMemoryScope	DialogContextMemoryScope 'dialogcontext' -> 속성을 매핑합니다.
DialogMemoryScope	DialogMemoryScope maps "dialog" -> dc.parent.activeDialog.state || dc.activeDialog.state
MemoryScope	모든 메모리 범위에 대한 추상 기본 클래스입니다.
SettingsMemoryScope	SettingsMemoryScope maps "settings" -> dc.context.turnState['settings']
ThisMemoryScope	ThisMemoryScope maps "this" -> dc.activeDialog.state
TurnMemoryScope	TurnMemoryScope는 현재 턴으로 범위가 지정된 메모리를 나타냅니다.
UserMemoryScope	현재 사용자로 범위가 지정된 메모리입니다.
ThisPath	활성 대화 상자에 전달된 경로를 정의합니다.
TurnPath	avaiable 턴에 대한 경로를 정의합니다.
ActivityPrompt	활동이 수신될 때까지 기다립니다.
AttachmentPrompt	이미지와 같은 첨부 파일을 업로드하라는 메시지를 사용자에게 표시합니다.
ChoicePrompt	선택 항목 목록에서 선택하라는 메시지를 사용자에게 표시합니다.
ConfirmPrompt	사용자에게 "예" 또는 "아니요" 응답을 사용하여 확인하라는 메시지를 표시합니다.
DateTimePrompt	날짜/시간 식을 입력하라는 메시지를 사용자에게 표시합니다.
NumberPrompt	사용자에게 숫자를 입력하라는 메시지를 표시합니다.
OAuthPrompt	Bot Frameworks SSO(Single Sign On) 서비스를 사용하여 로그인하도록 사용자에게 요청하는 새 프롬프트를 만듭니다.
Prompt	모든 프롬프트에 대한 기본 클래스입니다.
PromptCultureModels	확인 및 선택 프롬프트에서 현재 지원되는 문화권 모델에 대한 클래스 컨테이너입니다.
TextPrompt	사용자에게 텍스트를 입력하라는 메시지를 표시합니다.
Recognizer	Recognizer 기본 클래스입니다.
SkillDialog	기술에 대한 원격 호출을 래핑할 수 있는 특수 대화 상자입니다.
WaterfallDialog	폭포는 사용자에게 일련의 질문을 표시하도록 최적화된 대화 상자입니다.
WaterfallStepContext	컨텍스트 개체가 WaterfallStep전달됩니다.

인터페이스

BeginSkillDialogOptions	SkillDialog에 대한 대화 상자 인수가 있는 클래스입니다.
ChoiceFactoryOptions	선택 목록의 서식을 조정하는 데 사용되는 추가 옵션입니다.
Choice	선택 항목을 사용자에게 렌더링하거나 사용자가 선택한 항목을 인식하는 데 사용할 수 있는 선택 항목의 인스턴스입니다.
FindChoicesOptions	findChoices()수행되는 인식을 제어하는 옵션입니다.
FoundChoice	findChoices()반환된 결과입니다.
FindValuesOptions	사용자 발언에서 선택 항목을 인식하는 방법을 제어하는 데 사용되는 기본 검색 옵션입니다.
FoundValue	INTERNAL: findValues()반환된 원시 검색 결과입니다.
SortedValue	내부: 정렬할 수 있고 원본 배열 내에서 원래 위치를 참조할 수 있는 값입니다. findChoices() 함수는 전달된 선택 항목을 개별 SortedValue 인스턴스로 확장하고 findValues()전달합니다. 각 개별 Choice 검색해야 하는 여러 동의어가 발생할 수 있으므로 이 데이터 구조를 통해 각 동의어를 검색할 값으로 전달하면서 값이 제공된 선택 항목의 인덱스를 유지 관리할 수 있습니다.
ModelResult	recognizeChoices()같은 엔터티 인식기에서 반환된 외부 결과입니다.
Token	TokenizerFunction반환된 개별 토큰입니다.
Converter	변환기는 개체를 한 형식에서 다른 형식으로 변환합니다.
DialogConfiguration
DialogEvent
DialogInstance	스택에 있는 대화 상자의 인스턴스에 대한 상태 정보를 포함합니다.
DialogTurnResult	하나 이상의 대화 상자를 시작, 계속 또는 조작하려는 대화 컨텍스트의 시도 결과를 나타냅니다.
DialogState	대화 상자 상태, 대화 상자 스택의 상태에 대한 정보, 특정 DialogSet포함됩니다.
DialogManagerConfiguration
DialogManagerResult
DialogDependencies
ComponentMemoryScopes	메모리 범위를 열거하기 위한 인터페이스입니다.
ComponentPathResolvers	경로 확인자를 선언하기 위한 인터페이스입니다.
DialogStateManagerConfiguration
PathResolver	Copyright (c) Microsoft Corporation. 모든 권한이 예약되어 있습니다. MIT 라이선스에 따라 라이선스가 부여되었습니다.
ChoiceDefaultsChoicePrompt
ChoiceDefaultsConfirmPrompt
DateTimeResolution	DateTimePrompt반환된 결과입니다.
OAuthPromptSettings	OAuthPrompt 인스턴스를 구성하는 데 사용되는 설정입니다.
PromptOptions	모든 프롬프트에서 지원하는 기본 구성 옵션입니다.
PromptRecognizerResult	프롬프트 인식기 함수에서 반환된 결과입니다.
PromptValidatorContext	사용자 지정 PromptValidator전달되는 상황별 정보입니다.
PromptCultureModel
RecognizerConfiguration
SkillDialogOptions
TemplateInterface	T에 데이터를 바인딩하기 위한 템플릿 인터페이스를 정의합니다.
WaterfallStepInfo	WaterfallStepContext 생성자에 전달되는 값입니다.

형식 별칭

TokenizerFunction	recognizeChoices(), findChoices()또는 findValues()전달할 수 있는 대체 단어 분리기에 대한 서명입니다. 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	대화 컨텍스트가 하나 이상의 대화 상자를 시작, 계속 또는 조작하려고 시도한 후 대화 상자 스택의 상태를 나타냅니다. 참조 DialogContext 대화
ListStyle	ConfirmPrompt 대한 ChoicePrompt 또는 예/아니요 옵션에 대한 선택이 사용자에게 표시되는 방식을 제어합니다.

함수

findChoices(string, string | Choice[], FindChoicesOptions)	발화에서 선택 항목을 인식하기 위한 중간 수준 검색 함수입니다.
findValues(string, SortedValue[], FindValuesOptions)	내부: 발화 내에서 값 집합을 검색하는 하위 수준 함수입니다. findChoices() 및 recognizeChoices() 같은 상위 수준 함수는 이 함수 위에 계층화됩니다. 대부분의 경우 상위 수준 함수 중 하나를 호출하는 것이 더 쉽지만 이 함수에는 선택 인식을 구동하는 유사 항목 검색 알고리즘이 포함되어 있습니다.
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)	ComponentRegistration ComponentMemoryScopes 있는지 확인합니다.
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

(선택 사항) 수행되는 검색을 조정하는 데 사용되는 옵션입니다.

반환

ModelResult<FoundChoice>[]

가장 관련성이 가장 큰 항목을 기준으로 정렬된 찾은 선택 항목 목록입니다.

설명

이 함수는 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)

내부: 발화 내에서 값 집합을 검색하는 하위 수준 함수입니다. findChoices() 및 recognizeChoices() 같은 상위 수준 함수는 이 함수 위에 계층화됩니다. 대부분의 경우 상위 수준 함수 중 하나를 호출하는 것이 더 쉽지만 이 함수에는 선택 인식을 구동하는 유사 항목 검색 알고리즘이 포함되어 있습니다.

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

매개 변수

utterance

string

검색할 텍스트 또는 사용자 발언입니다.

values

SortedValue[]

검색할 값 목록입니다.

options

FindValuesOptions

(선택 사항) 수행되는 검색을 조정하는 데 사용되는 옵션입니다.

반환

ModelResult<FoundValue>[]

찾은 값의 목록입니다.

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

(선택 사항) 수행되는 검색을 조정하는 데 사용되는 옵션입니다.

반환

ModelResult<FoundChoice>[]

가장 관련성이 가장 큰 항목을 기준으로 정렬된 찾은 선택 항목 목록입니다.

설명

이는 findChoices() 함수 위에 계층화되고 사용자가 인덱스로 선택을 지정할 수 있도록 논리를 추가합니다(choice[0]선택하기 위해 "하나"라고 말할 수 있습니다) 또는 서수 위치(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) - 현재 사용자와의 대화 전환입니다.

반환

DialogContext

활성 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>

대화 상자 턴 결과로 해결되는 약속입니다.

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

True이면 EoC를 보내고, 그렇지 않으면 false입니다.

isComponentMemoryScopes(unknown)

ComponentRegistration ComponentMemoryScopes 있는지 확인합니다.

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

settings

OAuthPromptSettings

tokenExchangeRequest

TokenExchangeRequest

반환

Promise<TokenResponse>

getSignInResource(TurnContext, OAuthPromptSettings)

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

매개 변수

context

TurnContext

settings

OAuthPromptSettings

반환

Promise<SignInUrlResponse>

getUserToken(TurnContext, OAuthPromptSettings, string)

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

매개 변수

context

TurnContext

settings

OAuthPromptSettings

magicCode

string

반환

Promise<TokenResponse>

signOutUser(TurnContext, OAuthPromptSettings)

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

매개 변수

context

TurnContext

settings

OAuthPromptSettings

반환

Promise<void>