IPromptTextOptions interface

パッケージ:

botbuilder

PromptText クラスに基づいて、session.beginDialog() または 呼び出しでカスタム プロンプトに渡されるオプション。

Extends

IPromptOptions

プロパティ

attachmentLayout	クライアントが複数の添付ファイルをレイアウトする方法のヒント。 既定値は 'list' です。
attachments	受信メッセージには、ユーザーから送信された画像などの添付ファイルが含まれています。 送信メッセージには、ユーザーに送信するカードや画像などのオブジェクトが含まれます。
entities	ボットまたはユーザーに渡される構造化オブジェクト。
inputHint	ボットがさらなる入力を期待しているかどうかをクライアントに知らせるヒント。 組み込みのプロンプトでは、送信メッセージに対してこの値が自動的に設定されます。
libraryNamespace	(省略可能) ローカライズやその他の目的で使用する名前空間。 既定では、呼び出し元の名前空間が使用されます。
listStyle	(省略可能) PromptType.choice に表示するリストの種類。 既定値は ListStyle.auto です。
localizationNamespace	非推奨 代わりに libraryNamespace 使用してください。
maxLength	(省略可能) 認識できる最大長。
maxRetries	(省略可能) ユーザーに再プロンプトを表示する最大回数。 既定では、ユーザーは無期限に再プロンプトが表示されます。
minLength	(省略可能) 認識できる最小長。
prompt	(省略可能)ユーザーを送信するための最初のプロンプト。 これは通常、Prompts.xxx() 関数によって設定されます。
promptAfterAction	(省略可能) アクションによって開始されたダイアログが終了した後のユーザーの再プロンプトを制御するために使用されるフラグ。 既定値は true です。
refDate	(省略可能) 時刻を認識するときの参照日付。 Date.getTime() を使用してティックで表される日付。
retryPrompt	(省略可能) ユーザーの応答が認識されない場合に送信する再試行プロンプト。 既定では、カスタマイズ可能なシステム プロンプトを使用して再プロンプトするだけです。
retrySpeak	(省略可能)retryPromptと共に送信する SSML。 retryPrompt の型が IMessage または IIsMessageの場合、この値は無視されます。 この値が配列の場合、応答はランダムに選択されます。
speak	(省略可能)最初の promptで送信する SSML。 プロンプトの種類が IMessage または IIsMessageの場合、この値は無視されます。 この値が配列の場合、応答はランダムに選択されます。
textFormat	テキスト フィールドの形式。 既定値は 'markdown' です。

プロパティの詳細

attachmentLayout

クライアントが複数の添付ファイルをレイアウトする方法のヒント。 既定値は 'list' です。

attachmentLayout?: string

プロパティ値

string

attachments

受信メッセージには、ユーザーから送信された画像などの添付ファイルが含まれています。 送信メッセージには、ユーザーに送信するカードや画像などのオブジェクトが含まれます。

attachments?: IAttachment[]

プロパティ値

IAttachment[]

entities

ボットまたはユーザーに渡される構造化オブジェクト。

entities?: any[]

プロパティ値

any[]

inputHint

ボットがさらなる入力を期待しているかどうかをクライアントに知らせるヒント。 組み込みのプロンプトでは、送信メッセージに対してこの値が自動的に設定されます。

inputHint?: string

プロパティ値

string

libraryNamespace

(省略可能) ローカライズやその他の目的で使用する名前空間。 既定では、呼び出し元の名前空間が使用されます。

libraryNamespace?: string

プロパティ値

string

listStyle

(省略可能) PromptType.choice に表示するリストの種類。 既定値は ListStyle.auto です。

listStyle?: ListStyle

プロパティ値

ListStyle

localizationNamespace

非推奨 代わりに libraryNamespace 使用してください。

localizationNamespace?: string

プロパティ値

string

maxLength

(省略可能) 認識できる最大長。

maxLength?: number

プロパティ値

number

maxRetries

(省略可能) ユーザーに再プロンプトを表示する最大回数。 既定では、ユーザーは無期限に再プロンプトが表示されます。

maxRetries?: number

プロパティ値

number

minLength

(省略可能) 認識できる最小長。

minLength?: number

プロパティ値

number

prompt

(省略可能)ユーザーを送信するための最初のプロンプト。 これは通常、Prompts.xxx() 関数によって設定されます。

prompt?: TextOrMessageType

プロパティ値

TextOrMessageType

promptAfterAction

(省略可能) アクションによって開始されたダイアログが終了した後のユーザーの再プロンプトを制御するために使用されるフラグ。 既定値は true です。

promptAfterAction?: boolean

プロパティ値

boolean

refDate

(省略可能) 時刻を認識するときの参照日付。 Date.getTime() を使用してティックで表される日付。

refDate?: number

プロパティ値

number

retryPrompt

(省略可能) ユーザーの応答が認識されない場合に送信する再試行プロンプト。 既定では、カスタマイズ可能なシステム プロンプトを使用して再プロンプトするだけです。

retryPrompt?: TextOrMessageType

プロパティ値

TextOrMessageType

retrySpeak

(省略可能)retryPromptと共に送信する SSML。 retryPrompt の型が IMessage または IIsMessageの場合、この値は無視されます。 この値が配列の場合、応答はランダムに選択されます。

retrySpeak?: TextType

プロパティ値

TextType

speak

(省略可能)最初の promptで送信する SSML。 プロンプトの種類が IMessage または IIsMessageの場合、この値は無視されます。 この値が配列の場合、応答はランダムに選択されます。

speak?: TextType

プロパティ値

TextType

textFormat

テキスト フィールドの形式。 既定値は 'markdown' です。

textFormat?: string

プロパティ値

string