Freigeben über


BeginSkill class

Beginnen Sie eine Fähigkeit.

Extends

SkillDialog

Konstruktoren

BeginSkill(SkillDialogOptions)

Erstellt eine neue "BeginSkillDialog"-Instanz.

Eigenschaften

$kind
activity

Vorlage für die Aktivität.

activityProcessed

Wert, der angibt, ob das neue Dialogfeld die Aktivität verarbeiten soll.

allowInterruptions

Die Unterbrechungsrichtlinie.

botId

Die Microsoft App-ID, die die Fähigkeit aufruft.

connectionName

Wahlfrei. Der OAuth-Verbindungsname für den übergeordneten Bot.

disabled

Optionaler Ausdruck, der "true" ist, deaktiviert diese Aktion.

resultProperty

Optionaler Eigenschaftspfad zum Speichern des Dialogfeldergebnisses.

skillAppId

Die Microsoft App-ID für die Fähigkeiten.

skillEndpoint

Der /api/messages Endpunkt für die Qualifikation.

skillHostEndpoint

Die Rückruf-URL für den Qualifikationshost.

Geerbte Eigenschaften

EndOfTurn

Ruft ein Standardmäßiges End-of-Turn-Ergebnis ab.

id
telemetryClient

Methoden

beginDialog(DialogContext, BeginSkillDialogOptions)

Wird aufgerufen, wenn das Dialogfeld gestartet und in den Dialogstapel verschoben wird.

continueDialog(DialogContext)

Wird aufgerufen, wenn das Dialog-fortgesetzt wird, wobei es sich um das aktive Dialogfeld handelt und der Benutzer mit einer neuen Aktivität antwortet.

endDialog(TurnContext, DialogInstance, DialogReason)

Wird aufgerufen, wenn das Dialogfeld beendet wird.

getConverter(Object)
repromptDialog(TurnContext, DialogInstance)

Wird aufgerufen, wenn der Dialog den Benutzer erneut zur Eingabe auffordern soll.

resumeDialog(DialogContext, DialogReason, any)

Wird aufgerufen, wenn ein untergeordnetes Dialog seine Drehung abgeschlossen hat, und gibt das Steuerelement zu diesem Dialogfeld zurück.

Geerbte Methoden

configure(Record<string, unknown>)

Fluent-Methode zum Konfigurieren des Objekts.

getVersion()

Eine codierte Zeichenfolge zur Unterstützung der Erkennung von Bot-Änderungen bei der erneuten Bereitstellung.

onDialogEvent(DialogContext, DialogEvent)

Wird aufgerufen, wenn ein Ereignis mit DialogContext.emitEvent()ausgelöst wurde, entweder durch das aktuelle Dialogfeld oder ein Dialogfeld, das das aktuelle Dialogfeld gestartet hat.

Details zum Konstruktor

BeginSkill(SkillDialogOptions)

Erstellt eine neue "BeginSkillDialog"-Instanz.

new BeginSkill(options?: SkillDialogOptions)

Parameter

options

SkillDialogOptions

Optionale Optionen zum Konfigurieren des Qualifikationsdialogfelds.

Details zur Eigenschaft

$kind

static $kind: string

Eigenschaftswert

string

activity

Vorlage für die Aktivität.

activity: TemplateInterface<Partial<Activity>, DialogStateManager>

Eigenschaftswert

TemplateInterface<Partial<Activity>, DialogStateManager>

activityProcessed

Wert, der angibt, ob das neue Dialogfeld die Aktivität verarbeiten soll.

activityProcessed: BoolExpression

Eigenschaftswert

BoolExpression

Hinweise

Der Standardwert ist "true", was bedeutet, dass das neue Dialogfeld nicht die Aktivität betrachten sollte. Sie können dies auf "false" festlegen, um die Aktivität an das neue Dialogfeld zu verteilen.

allowInterruptions

Die Unterbrechungsrichtlinie.

allowInterruptions: BoolExpression

Eigenschaftswert

BoolExpression

botId

Die Microsoft App-ID, die die Fähigkeit aufruft.

botId: StringExpression

Eigenschaftswert

StringExpression

Hinweise

Defauls auf einen Wert von =settings.MicrosoftAppId, der die Bots-ID aus den Einstellungen abruft.

connectionName

Wahlfrei. Der OAuth-Verbindungsname für den übergeordneten Bot.

connectionName: StringExpression

Eigenschaftswert

StringExpression

disabled

Optionaler Ausdruck, der "true" ist, deaktiviert diese Aktion.

disabled?: BoolExpression

Eigenschaftswert

BoolExpression

resultProperty

Optionaler Eigenschaftspfad zum Speichern des Dialogfeldergebnisses.

resultProperty?: StringExpression

Eigenschaftswert

StringExpression

skillAppId

Die Microsoft App-ID für die Fähigkeiten.

skillAppId: StringExpression

Eigenschaftswert

StringExpression

skillEndpoint

Der /api/messages Endpunkt für die Qualifikation.

skillEndpoint: StringExpression

Eigenschaftswert

StringExpression

skillHostEndpoint

Die Rückruf-URL für den Qualifikationshost.

skillHostEndpoint: StringExpression

Eigenschaftswert

StringExpression

Hinweise

Defauls auf einen Wert von =settings.SkillHostEndpoint, der den Endpunkt aus den Einstellungen abruft.

Geerbte Eigenschaftsdetails

EndOfTurn

Ruft ein Standardmäßiges End-of-Turn-Ergebnis ab.

static EndOfTurn: DialogTurnResult

Eigenschaftswert

DialogTurnResult

Hinweise

Dieses Ergebnis gibt an, dass ein Dialogfeld (oder ein logischer Schritt innerhalb eines Dialogfelds) die Verarbeitung für die aktuelle Drehung abgeschlossen hat, noch aktiv ist und auf weitere Eingaben wartet.

von Dialog.EndOfTurn geerbt

id

id: string

Eigenschaftswert

string

geerbt von Dialog.id

telemetryClient

telemetryClient: BotTelemetryClient

Eigenschaftswert

BotTelemetryClient

Geerbt von Dialog.telemetryClient

Details zur Methode

beginDialog(DialogContext, BeginSkillDialogOptions)

Wird aufgerufen, wenn das Dialogfeld gestartet und in den Dialogstapel verschoben wird.

function beginDialog(dc: DialogContext, options?: BeginSkillDialogOptions): Promise<DialogTurnResult>

Parameter

dc

DialogContext

Die DialogContext- für die aktuelle Unterhaltungswende.

options

BeginSkillDialogOptions

Wahlfrei. Anfängliche Informationen, die an das Dialogfeld übergeben werden sollen.

Gibt zurück

Promise<DialogTurnResult>

Eine Promise, die den asynchronen Vorgang darstellt.

continueDialog(DialogContext)

Wird aufgerufen, wenn das Dialog-fortgesetzt wird, wobei es sich um das aktive Dialogfeld handelt und der Benutzer mit einer neuen Aktivität antwortet.

function continueDialog(dc: DialogContext): Promise<DialogTurnResult>

Parameter

dc

DialogContext

Die DialogContext- für die aktuelle Unterhaltungswende.

Gibt zurück

Promise<DialogTurnResult>

Eine Promise, die den asynchronen Vorgang darstellt.

endDialog(TurnContext, DialogInstance, DialogReason)

Wird aufgerufen, wenn das Dialogfeld beendet wird.

function endDialog(turnContext: TurnContext, instance: DialogInstance, reason: DialogReason): Promise<void>

Parameter

turnContext

TurnContext

(xref:botbuilder-core. TurnContext), das Kontextobjekt für diese Drehung.

instance

DialogInstance

(xref:botbuilder-dialogs. DialogInstance), Statusinformationen, die der Instanz dieses Dialogfelds im Dialogstapel zugeordnet sind.

reason

DialogReason

(xref:botbuilder-dialogs. DialogReason), Grund, warum das Dialogfeld beendet wurde.

Gibt zurück

Promise<void>

Eine Promise, die den asynchronen Vorgang darstellt.

getConverter(Object)

function getConverter(property: Object): Converter | ConverterFactory

Parameter

property

Object

Der Schlüssel der Konfiguration der bedingten Auswahl.

Gibt zurück

Converter | ConverterFactory

Der Konverter für die Selektorkonfiguration.

repromptDialog(TurnContext, DialogInstance)

Wird aufgerufen, wenn der Dialog den Benutzer erneut zur Eingabe auffordern soll.

function repromptDialog(turnContext: TurnContext, instance: DialogInstance): Promise<void>

Parameter

turnContext

TurnContext

(xref:botbuilder-core. TurnContext), das Kontextobjekt für diese Drehung.

instance

DialogInstance

(xref:botbuilder-dialogs. DialogInstance), Statusinformationen für dieses Dialogfeld.

Gibt zurück

Promise<void>

Eine Promise, die den asynchronen Vorgang darstellt.

resumeDialog(DialogContext, DialogReason, any)

Wird aufgerufen, wenn ein untergeordnetes Dialog seine Drehung abgeschlossen hat, und gibt das Steuerelement zu diesem Dialogfeld zurück.

function resumeDialog(dc: DialogContext, reason: DialogReason, result?: any): Promise<DialogTurnResult<any>>

Parameter

dc

DialogContext

Die DialogContext- für die aktuelle Unterhaltungswende.

reason

DialogReason

(xref:botbuilder-dialogs. DialogReason), Grund, warum das Dialogfeld fortgesetzt wurde.

result

any

Wahlfrei. Der wert, der aus dem aufgerufenen Dialogfeld zurückgegeben wurde. Der Typ des zurückgegebenen Werts hängt vom untergeordneten Dialogfeld ab.

Gibt zurück

Promise<DialogTurnResult<any>>

Eine Promise, die den asynchronen Vorgang darstellt.

Details zur geerbten Methode

configure(Record<string, unknown>)

Fluent-Methode zum Konfigurieren des Objekts.

function configure(config: Record<string, unknown>): this

Parameter

config

Record<string, unknown>

Anzuwendende Konfigurationseinstellungen.

Gibt zurück

this

Die konfigurierbaren nach Abschluss des Vorgangs.

Geerbt von Konfigurierbar.configure

getVersion()

Eine codierte Zeichenfolge zur Unterstützung der Erkennung von Bot-Änderungen bei der erneuten Bereitstellung.

function getVersion(): string

Gibt zurück

string

Eindeutige Zeichenfolge, die sich nur ändern sollte, wenn sich das Dialogfeld auf eine Weise geändert hat, die das Dialogfeld neu starten soll.

Hinweise

Dadurch werden standardmäßig die Dialogfelder ID- zurückgegeben, können jedoch außer Kraft gesetzt werden, um präzisere Änderungserkennungslogik bereitzustellen. Jedes Dialogfeld im Stapel, das seine Versionsänderung hat, führt zu einem versionChanged Ereignis wird ausgelöst. Wenn dieses Ereignis nicht vom Bot behandelt wird, wird ein Fehler ausgelöst, der dazu führt, dass die Bots-Fehlerhandlerlogik ausgeführt wird.

Durch zurückgeben einer leeren Zeichenfolge wird die Versionsnachverfolgung für die Komponente insgesamt deaktiviert.

Geerbt von Dialog.getVersion

onDialogEvent(DialogContext, DialogEvent)

Wird aufgerufen, wenn ein Ereignis mit DialogContext.emitEvent()ausgelöst wurde, entweder durch das aktuelle Dialogfeld oder ein Dialogfeld, das das aktuelle Dialogfeld gestartet hat.

function onDialogEvent(dc: DialogContext, e: DialogEvent): Promise<boolean>

Parameter

dc

DialogContext

Der Dialogkontext für die aktuelle Unterhaltungswende.

e

DialogEvent

Das ausgelöste Ereignis.

Gibt zurück

Promise<boolean>

True, wenn das Ereignis vom aktuellen Dialogfeld behandelt wird und Bubbling beendet werden soll.

geerbt von Dialog.onDialogEvent