IPromptTextOptions interface
Prompts.text() 또는 session.beginDialog() 클래스에 따라 사용자 지정 프롬프트에 대한 호출에 전달되는 옵션입니다.
- Extends
속성
| attachment |
클라이언트가 여러 첨부 파일을 레이아웃하는 방법에 대한 힌트입니다. 기본값은 'list'입니다. |
| attachments | 들어오는 메시지에는 사용자가 보낸 이미지와 같은 첨부 파일이 포함됩니다. 보내는 메시지에는 사용자에게 보낼 카드 또는 이미지와 같은 개체가 포함됩니다. |
| entities | 구조화된 개체가 봇 또는 사용자에게 전달됩니다. |
| input |
봇이 추가 입력을 기대하는지 여부를 알려주는 클라이언트에 대한 힌트입니다. 기본 제공 프롬프트는 나가는 메시지에 대해 이 값을 자동으로 채웁니다. |
| library |
(선택 사항) 지역화 및 기타 용도로 사용할 네임스페이스입니다. 이 기본값은 호출자 네임스페이스입니다. |
| list |
(선택 사항) PromptType.choice에 대해 렌더링할 목록의 유형입니다. 기본값은 ListStyle.auto입니다. |
| localization |
더 이상 사용되지 않는 libraryNamespace 대신 사용할 있습니다. |
| max |
(선택 사항) 인식할 수 있는 최대 길이입니다. |
| max |
(선택 사항) 사용자에게 다시 메시지를 표시할 최대 횟수입니다. 기본적으로 사용자에게 무기한으로 다시 메시지가 표시됩니다. |
| min |
(선택 사항) 인식할 수 있는 최소 길이입니다. |
| prompt | (선택 사항) 사용자를 보내는 초기 프롬프트입니다. 일반적으로 |
| prompt |
(선택 사항) 작업으로 시작된 대화 상자가 종료된 후 사용자의 다시 프롬프트를 제어하는 데 사용되는 플래그입니다. 기본값은 true입니다. |
| ref |
(선택 사항) 시간을 인식할 때의 참조 날짜입니다. Date.getTime()을 사용하여 틱으로 표현된 날짜입니다. |
| retry |
(선택 사항) 사용자 응답을 이해하지 못하는 경우 전송하라는 재시도 프롬프트입니다. 기본값은 사용자 지정 가능한 시스템 프롬프트를 사용하여 다시 프롬프트하는 것입니다. |
| retry |
(선택 사항) |
| speak | (선택 사항) 초기 |
| text |
텍스트 필드의 형식입니다. 기본값은 'markdown'입니다. |
속성 세부 정보
attachmentLayout
클라이언트가 여러 첨부 파일을 레이아웃하는 방법에 대한 힌트입니다. 기본값은 'list'입니다.
attachmentLayout?: string
속성 값
string
attachments
들어오는 메시지에는 사용자가 보낸 이미지와 같은 첨부 파일이 포함됩니다. 보내는 메시지에는 사용자에게 보낼 카드 또는 이미지와 같은 개체가 포함됩니다.
attachments?: IAttachment[]
속성 값
entities
구조화된 개체가 봇 또는 사용자에게 전달됩니다.
entities?: any[]
속성 값
any[]
inputHint
봇이 추가 입력을 기대하는지 여부를 알려주는 클라이언트에 대한 힌트입니다. 기본 제공 프롬프트는 나가는 메시지에 대해 이 값을 자동으로 채웁니다.
inputHint?: string
속성 값
string
libraryNamespace
(선택 사항) 지역화 및 기타 용도로 사용할 네임스페이스입니다. 이 기본값은 호출자 네임스페이스입니다.
libraryNamespace?: string
속성 값
string
listStyle
(선택 사항) PromptType.choice에 대해 렌더링할 목록의 유형입니다. 기본값은 ListStyle.auto입니다.
listStyle?: ListStyle
속성 값
localizationNamespace
maxLength
(선택 사항) 인식할 수 있는 최대 길이입니다.
maxLength?: number
속성 값
number
maxRetries
(선택 사항) 사용자에게 다시 메시지를 표시할 최대 횟수입니다. 기본적으로 사용자에게 무기한으로 다시 메시지가 표시됩니다.
maxRetries?: number
속성 값
number
minLength
(선택 사항) 인식할 수 있는 최소 길이입니다.
minLength?: number
속성 값
number
prompt
(선택 사항) 사용자를 보내는 초기 프롬프트입니다. 일반적으로 Prompts.xxx() 함수로 채워집니다.
prompt?: TextOrMessageType
속성 값
promptAfterAction
(선택 사항) 작업으로 시작된 대화 상자가 종료된 후 사용자의 다시 프롬프트를 제어하는 데 사용되는 플래그입니다. 기본값은 true입니다.
promptAfterAction?: boolean
속성 값
boolean
refDate
(선택 사항) 시간을 인식할 때의 참조 날짜입니다. Date.getTime()을 사용하여 틱으로 표현된 날짜입니다.
refDate?: number
속성 값
number
retryPrompt
(선택 사항) 사용자 응답을 이해하지 못하는 경우 전송하라는 재시도 프롬프트입니다. 기본값은 사용자 지정 가능한 시스템 프롬프트를 사용하여 다시 프롬프트하는 것입니다.
retryPrompt?: TextOrMessageType
속성 값
retrySpeak
(선택 사항) retryPrompt함께 보낼 SSML입니다. retryPrompt가 IMessage 또는 IIsMessage형식인 경우 이 값은 무시됩니다. 이 값이 배열인 경우 임의로 응답이 선택됩니다.
retrySpeak?: TextType
속성 값
speak
(선택 사항) 초기 prompt함께 보낼 SSML입니다. 프롬프트가 IMessage 형식이거나 IIsMessage경우 이 값은 무시됩니다. 이 값이 배열인 경우 임의로 응답이 선택됩니다.
speak?: TextType
속성 값
textFormat
텍스트 필드의 형식입니다. 기본값은 'markdown'입니다.
textFormat?: string
속성 값
string