botbuilder-core package

참조

클래스

ActivityFactory	ActivityFactory는 텍스트를 생성한 다음 chatdown과 같은 간단한 markdown 의미 체계를 사용하여 활동을 만듭니다.
ActivityHandler	봇에 대한 이벤트 내보내기 활동 처리기입니다. ActivityHandlerBase를 확장합니다.
ActivityHandlerBase	봇에 대한 이벤트 내보내기 활동 처리기의 핵심 동작을 정의합니다.
AutoSaveStateMiddleware	턴이 끝날 때 상태 변경 내용을 자동으로 저장하는 미들웨어입니다.
BotAdapter	봇을 서비스 엔드포인트에 연결할 수 있는 봇 어댑터의 핵심 동작을 정의합니다.
BotComponent	서비스, 사용자 지정 작업, 메모리 범위 및 어댑터의 등록을 허용하는 BotComponent의 정의입니다. 시스템에서 구성 요소를 사용할 수 있도록 하려면 BotComponent에서 파생하고 서비스를 등록하여 기능을 추가합니다. 그런 다음 이러한 구성 요소는 필요한 시스템에서 적절한 장소에서 사용됩니다. Composer를 사용하는 경우 구성 요소가 구성에 등록된 한 configureServices는 봇 런타임에 의해 구성 요소에서 자동으로 호출됩니다.
BotState	프레임워크 상태 지원 범위에 대한 기본 클래스입니다.
BotStatePropertyAccessor	`BotState` 인터페이스의 특정 구현입니다`StatePropertyAccessor`.
BotStateSet	단일 단위로 병렬로 로드하거나 저장해야 하는 플러그 인 컬렉션 `BotState` 입니다. 이 클래스의 구현은 을 참조하세요 `AutoSaveStateMiddleware` .
NullTelemetryClient	BotTelemetryClient를 구현하는 null 봇 원격 분석 클라이언트입니다.
BrowserLocalStorage	브라우저 로컬 스토리지를 사용하는 스토리지 공급자입니다.
BrowserSessionStorage	브라우저 세션 스토리지를 사용하는 스토리지 공급자입니다.
CardFactory	봇이 반환할 수 있는 다양한 카드 형식의 서식을 지정하는 메서드를 제공합니다.
CloudAdapterBase	Bot Framework 프로토콜을 구현하고 퍼블릭 및 프라이빗의 서로 다른 클라우드 환경에서 호스트할 수 있는 어댑터입니다.
ComponentRegistration	ComponentRegistration은 구성 요소에서 자산을 검색하기 위한 서명 클래스입니다.
ConfigurationBotFrameworkAuthentication	인증 값 또는 구성 인스턴스를 사용하여 개체에서 BotFrameworkAuthentication 인스턴스를 만듭니다.
ConfigurationServiceClientCredentialFactory	ConfigurationServiceClientCredentialFactoryOptions 또는 Configuration 인스턴스를 사용하여 AppId 및 앱 암호로 ServiceClientCredentials를 빌드하는 ServiceClientCredentialsFactory
ConversationState	봇의 대화 상태를 스토리지에 읽고 씁니다.
InvokeException	호출 응답 오류에 대한 사용자 지정 예외입니다.
MemoryStorage	봇에 대한 메모리 기반 스토리지 공급자입니다.
MemoryTranscriptStore	메모리 대본 저장소는 맵의 휘발성 메모리에 대본을 저장합니다.
MessageFactory	봇이 반환할 수 있는 다양한 메시지 형식의 서식을 지원하는 유틸리티 함수 집합입니다.
MiddlewareSet	플러그 인 집합 `Middleware` 입니다.
PrivateConversationState	봇의 PrivateConversation 상태를 스토리지에 읽고 씁니다.
QueueStorage	이후 처리를 위해 활동을 큐에 넣기 위한 기본 클래스입니다.
RegisterClassMiddleware	개체를 추가하거나 현재 턴 컨텍스트에 서비스를 등록하기 위한 미들웨어입니다.
ShowTypingMiddleware	각 메시지에 대해 입력 표시기를 자동으로 보내는 미들웨어입니다.
SkillConversationIdFactory	ConversationReference 인스턴스를 저장하고 검색하는 SkillConversationIdFactory입니다.
SkillConversationIdFactoryBase	기술 대화를 위한 고유한 대화 ID를 만드는 데 사용되는 팩터리의 메서드를 정의합니다.
SkypeMentionNormalizeMiddleware	미들웨어는 예상 값을 준수하지 않으므로 Skype에서 멘션 엔터티를 패치합니다. 멘션이 사용되는 경우 Skype와 상호 작용하는 봇은 이 미들웨어를 사용해야 합니다.
StringUtils	문자열 유틸리티 메서드를 포함하는 도우미 클래스입니다.
TelemetryConstants	BotTelemetryClient 개체와 함께 사용할 공통 속성의 이름을 정의합니다.
TelemetryLoggerMiddleware	수신, 발신, 업데이트 또는 삭제된 활동 메시지를 로깅하기 위한 미들웨어입니다. botTelemetryClient 인터페이스를 사용합니다.
TestAdapter	단위 테스트에 사용되는 테스트 어댑터입니다. 이 어댑터는 사용자로부터 봇으로 메시지를 보내는 시뮬레이션에 사용할 수 있습니다.
TestFlow	에 대한 `TestAdapter` 지원 클래스를 사용하면 테스트 시퀀스를 간단하게 생성할 수 있습니다.
ConsoleTranscriptLogger	ConsoleTranscriptLogger 는 콘솔 출력에 활동을 씁니다.
TranscriptLoggerMiddleware	들어오는 활동과 나가는 활동을 TranscriptStore에 기록합니다.
TurnContext	봇의 전환에 대한 컨텍스트를 제공합니다.
TurnContextStateCollection	TurnContext의 일부로 턴의 수명 동안 유지되는 값입니다.
UserState	봇의 사용자 상태를 읽고 스토리지에 씁니다.

인터페이스

CachedBotState	인스턴스에 의해 컨텍스트 개체에서 캐시된 상태 정보입니다 `BotState` .
StatePropertyAccessor	BotState 개체에서 만든 상태 속성에 액세스하는 메서드를 정의합니다.
BotPageViewTelemetryClient
BotTelemetryClient
TelemetryDependency
TelemetryEvent
TelemetryException
TelemetryPageView
TelemetryTrace
CoreAppCredentials	CoreAppCredentials
CoreWebResource	에서 "WebResource"를 나타내는 내부 인터페이스 @azure/ms-rest-js
ExtendedUserTokenProvider	BotAdapters용 사용자 토큰 OAuth Single Sign-On 및 토큰 Exchange API에 대한 인터페이스
IntentScore	점수와 의도에 대한 추가 정보.
Middleware	개체 기반 미들웨어에 의해 구현되는 인터페이스입니다.
PropertyManager	속성 접근자를 팩터링할 수 있는 클래스에 의해 구현되는 인터페이스입니다.
RecognizerResult	인식기에서 반환되는 값입니다.
BotFrameworkSkill	BotFrameworkHttpProtocol 기반 기술 엔드포인트에 대한 등록입니다.
SkillConversationIdFactoryOptions
SkillConversationReference
Storage	일반 이전 JSON 개체를 저장하고 검색하는 스토리지 공급자에 대한 인터페이스입니다.
StoreItem	선택적 eTag를 사용하여 Storage에 저장된 개체입니다.
StoreItems	명명된 `StoreItem` 개체의 맵입니다.
PagedResult	결과 페이지입니다.
TranscriptInfo	저장된 대본에 대한 메타데이터입니다.
TranscriptLogger	대본 로거는 재현을 위한 대화 활동을 저장합니다.
TranscriptStore	대본 로거는 재현을 위한 대화 활동을 저장합니다.
IUserTokenProvider	BotAdapters용 사용자 토큰 OAuth API에 대한 인터페이스
TokenPollingSettings	토큰 폴링에 대한 세부 정보를 제공합니다.

형식 별칭

BotHandler	ActivityHandler 개체에 사용할 봇 활동 이벤트 처리기를 설명합니다.
ConfigurationBotFrameworkAuthenticationOptions	ConfigurationBotFrameworkAuthentication 인스턴스를 구성하는 데 사용되는 설정을 포함합니다.
ConfigurationServiceClientCredentialFactoryOptions	ConfigurationServiceClientCredentialFactory 인스턴스를 구성하는 데 사용되는 설정을 포함합니다.
MiddlewareHandler	함수 기반 미들웨어에 의해 구현된 서명입니다. `type MiddlewareHandler = (context: TurnContext, next: () => Promise<void>) => Promise<void>;`
StorageKeyFactory	스토리지 키를 계산하기 위한 콜백입니다. `type StorageKeyFactory = (context: TurnContext) => Promise<string>;`
TestActivityInspector	를 사용하여 `TestAdapter`테스트 중인 봇에서 반환하는 개별 활동을 검사하는 데 사용할 수 있는 함수에 대한 서명입니다. `type TestActivityInspector = (activity: Partial<Activity>, description: string) => void;`
DeleteActivityHandler	현재 턴에 대한 삭제 작업 이벤트에 참여할 수 있는 처리기입니다.
SendActivitiesHandler	현재 턴에 대한 송신 활동 이벤트에 참여할 수 있는 처리기입니다.
UpdateActivityHandler	현재 턴에 대한 업데이트 작업 이벤트에 참여할 수 있는 처리기입니다.

열거형

Severity

이벤트의 심각도 수준을 정의합니다.

함수

useBotState(BotAdapter, BotState[])	어댑터에 미들웨어를 추가하여 턴 컨텍스트에서 하나 이상의 BotState 개체를 등록합니다. 미들웨어는 각 턴의 시작 부분에 있는 턴 컨텍스트에서 상태 개체를 등록합니다.
assertBotComponent(unknown, unknown[])
telemetryTrackDialogView(BotTelemetryClient, string, [key: string]: any, [key: string]: number)	BotPageViewTelemetryClient가 구현된 경우 BotTelemetryClient에서 trackPageView 메서드를 사용하여 DialogView를 기록합니다. 또는 TrackTrace를 통해 정보를 로그아웃합니다.
createBotFrameworkAuthenticationFromConfiguration(Configuration, ServiceClientCredentialsFactory, AuthenticationConfiguration, (input: RequestInfo, init?: RequestInit) => Promise<Response>, ConnectorClientOptions)	ConfigurationBotFrameworkAuthentication 클래스의 새 인스턴스를 만듭니다.
createServiceClientCredentialFactoryFromConfiguration(Configuration)	ConfigurationServiceClientCredentialFactory 클래스의 새 인스턴스를 만듭니다.
assertStoreItems(unknown, unknown[])
calculateChangeHash(StoreItem)	의 변경 해시를 계산하는 유틸리티 함수입니다 `StoreItem`.

함수 세부 정보

useBotState(BotAdapter, BotState[])

어댑터에 미들웨어를 추가하여 턴 컨텍스트에서 하나 이상의 BotState 개체를 등록합니다. 미들웨어는 각 턴의 시작 부분에 있는 턴 컨텍스트에서 상태 개체를 등록합니다.

function useBotState(botAdapter: BotAdapter, botStates: BotState[]): BotAdapter

매개 변수

botAdapter: BotAdapter

상태 개체를 등록할 어댑터입니다.

botStates: BotState[]

등록할 상태 개체입니다.

반환

BotAdapter

업데이트된 어댑터입니다.

assertBotComponent(unknown, unknown[])

경고

이 API는 이제 사용되지 않습니다.

Use BotComponent.z.parse() instead.

function assertBotComponent(val: unknown, _args: unknown[]): asserts

매개 변수

val: unknown

_args: unknown[]

반환

asserts

telemetryTrackDialogView(BotTelemetryClient, string, [key: string]: any, [key: string]: number)

BotPageViewTelemetryClient가 구현된 경우 BotTelemetryClient에서 trackPageView 메서드를 사용하여 DialogView를 기록합니다. 또는 TrackTrace를 통해 정보를 로그아웃합니다.

function telemetryTrackDialogView(telemetryClient: BotTelemetryClient, dialogName: string, properties?: [key: string]: any, metrics?: [key: string]: number)

매개 변수

telemetryClient: BotTelemetryClient

BotTelemetryClient를 구현하는 TelemetryClient입니다.

dialogName: string

항목/시작을 기록할 대화 상자의 이름입니다.

properties: [key: string]: any

이벤트를 검색하고 분류하는 데 사용할 수 있는 명명된 문자열 값입니다.

metrics: [key: string]: number

이 이벤트와 관련된 측정값입니다.

createBotFrameworkAuthenticationFromConfiguration(Configuration, ServiceClientCredentialsFactory, AuthenticationConfiguration, (input: RequestInfo, init?: RequestInit) => Promise<Response>, ConnectorClientOptions)

ConfigurationBotFrameworkAuthentication 클래스의 새 인스턴스를 만듭니다.

function createBotFrameworkAuthenticationFromConfiguration(configuration: Configuration, credentialsFactory?: ServiceClientCredentialsFactory, authConfiguration?: AuthenticationConfiguration, botFrameworkClientFetch?: (input: RequestInfo, init?: RequestInit) => Promise<Response>, connectorClientOptions?: ConnectorClientOptions): BotFrameworkAuthentication

매개 변수

configuration: Configuration

구성 인스턴스입니다.

credentialsFactory: ServiceClientCredentialsFactory

ServiceClientCredentialsFactory 인스턴스입니다.

authConfiguration: AuthenticationConfiguration

Configuration 개체입니다.

botFrameworkClientFetch: (input: RequestInfo, init?: RequestInit) => Promise<Response>

BotFrameworkClient에서 사용할 사용자 지정 Fetch 구현입니다.

connectorClientOptions: ConnectorClientOptions

ConnectorClientOptions 개체입니다.

반환

BotFrameworkAuthentication

ConfigurationBotFrameworkAuthentication 인스턴스입니다.

설명

생성자에 제공된 Configuration 인스턴스에는 ConfigurationBotFrameworkAuthenticationOptions 의 속성을 키로 사용하여 루트에서 사용할 수 있는 원하는 인증 값이 있어야 합니다.

createServiceClientCredentialFactoryFromConfiguration(Configuration)

ConfigurationServiceClientCredentialFactory 클래스의 새 인스턴스를 만듭니다.

function createServiceClientCredentialFactoryFromConfiguration(configuration: Configuration): ConfigurationServiceClientCredentialFactory

매개 변수

configuration: Configuration

구성 인스턴스입니다.

반환

ConfigurationServiceClientCredentialFactory

ConfigurationServiceClientCredentialFactory 인스턴스입니다.

설명

생성자에 제공된 Configuration 인스턴스에는 ConfigurationServiceClientCredentialFactoryOptions 의 속성을 키로 사용하여 루트에서 사용할 수 있는 원하는 인증 값이 있어야 합니다.

assertStoreItems(unknown, unknown[])

경고

이 API는 이제 사용되지 않습니다.

Use zod.record(zod.unknown()) instead.

function assertStoreItems(val: unknown, _args: unknown[]): asserts

매개 변수

val: unknown

_args: unknown[]

반환

asserts

calculateChangeHash(StoreItem)

의 변경 해시를 계산하는 유틸리티 함수입니다 StoreItem.

function calculateChangeHash(item: StoreItem): string

매개 변수

item: StoreItem

변경 해시를 계산할 항목입니다.

반환

string

해시 문자열 변경

설명

이 예제에서는 읽은 개체에 대한 변경 해시를 계산한 다음 수정된 경우에만 다시 씁니다.

// Calculate state objects initial hash
const hash = calculateChangeHash(state);

// Process the received activity
await processActivity(context, state);

// Save state if changed
if (calculateChangeHash(state) !== hash) {
   await storage.write({ 'botState': state });
}

다음을 통해 공유

botbuilder-core package

클래스

인터페이스

형식 별칭

열거형

함수

함수 세부 정보

useBotState(BotAdapter, BotState[])

매개 변수

반환

assertBotComponent(unknown, unknown[])

매개 변수

반환

telemetryTrackDialogView(BotTelemetryClient, string, [key: string]: any, [key: string]: number)

매개 변수

createBotFrameworkAuthenticationFromConfiguration(Configuration, ServiceClientCredentialsFactory, AuthenticationConfiguration, (input: RequestInfo, init?: RequestInit) => Promise<Response>, ConnectorClientOptions)

매개 변수

반환

설명

createServiceClientCredentialFactoryFromConfiguration(Configuration)

매개 변수

반환

설명

assertStoreItems(unknown, unknown[])

매개 변수

반환

calculateChangeHash(StoreItem)

매개 변수

반환

설명

추가 리소스