Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MessageInput

An input object that includes the input text.

Hierarchy

  • MessageInput

Indexable

[propName: string]: any

MessageInput accepts additional properties.

Index

Properties

Optional original_text

original_text: string

The original user input text. This property is returned only if autocorrection is enabled and the user input was corrected.

Optional spelling_auto_correct

spelling_auto_correct: boolean

Whether to use autocorrection when processing the input. If spelling correction is used and this property is false, any suggested corrections are returned in the suggested_text property of the message response. If this property is true, any corrections are automatically applied to the user input, and the original text is returned in the original_text property of the message response. This property overrides the value of the spelling_auto_correct property in the workspace settings.

Optional spelling_suggestions

spelling_suggestions: boolean

Whether to use spelling correction when processing the input. This property overrides the value of the spelling_suggestions property in the workspace settings.

Optional suggested_text

suggested_text: string

Any suggested corrections of the input text. This property is returned only if spelling correction is enabled and autocorrection is disabled.

Optional text

text: string

The text of the user input. This string cannot contain carriage return, newline, or tab characters.

Generated using TypeDoc