Formatting options for generated and editorial AI chatbot messages
Formatting helps to structure information more clearly and improve readability. It supports the visual perception of content and increases the comprehensibility of responses.
The available formatting options for the AI chatbot are described below. Individual formatting characters primarily refer to editorial content in the response editor. Formatting is done in Markdown.
With generative AI, it is sufficient to store the corresponding instructions to output formatted content.
Markdown is a markup language that can be used to format and structure text.
- Enable formatting
- Generative AI
- Editorial content
3.1 Bold, italics, strikethrough
3.2 Inline code and code blocks
3.3 Headings
3.4 Quotations
3.5 Lists
3.6 Links
3.7 Tables
1. Enable formatting
In order for generated text messages to be formatted in the chatbot, the function must first be enabled.
This setting can be found under the menu item Bot Settings → General settings & privacy. The function is enabled using the Enable formatting slider.
Important: Activation must be carried out separately for each language.
2. Generative AI
With generative AI, formatting is controlled using instructions.
Instructions are stored in the Knowledge Base menu item via the RAG button. The desired instructions are stored in the Instructions tile via the Create button. Formatting is done in Markdown syntax, which should be explicitly noted in the instructions.
3. Editorial content
The available formatting types and their implementation are described below.
3.1 Bold, italics, strikethrough
Emphasis improves readability and draws attention to key terms.
- Bold: Two asterisks ** before and after the word make the word bold.
- Italics: An asterisk * before and after the word puts the word in italics.
- Strikethrough: Two tildes ~ at the beginning and end strike through the word.
**bold**
*italics*
~~strikethrough~~
3.2 Inline code and code blocks
Code can be displayed within the text or in separate sections.
Inline code: Code snippets within a sentence are inline code. They are enclosed in backticks (`). The code is highlighted in grey.
Code blocks: Code that spans several paragraphs is code blocks. They begin and end with three quotation marks (```). The code is highlighted in a grey box.
`Inline Code`
```python
def hello():
print("Hello world!")
```
3.3 Headings
Headings structure content and make it easier to navigate.
The number of hash symbols (#) at the beginning of a line determines the hierarchical level. Headings are always formatted in bold and, depending on their hierarchical level, are larger than normal text.
A maximum depth of three levels is recommended.
# heading 1
section...
## heading 2
section...
### heading 3
section...
3.4 Quotations
Quotations can highlight references, statements or external sources.
The greater-than sign > at the beginning of the line creates an indented quotation field.
Quotations are indented and marked with a vertical line on the left-hand side.
> Quotation or note box
3.5 Lists
Lists structure enumerations and make it easier to grasp content. Bullet points are suitable for lists where the order is not important. In numerical lists, the order is important.
Bullet points are implemented with a hyphen at the beginning of the line.
Numerical lists begin with a number followed by a full stop and a space at the beginning of the line.
- Point 1
- Point 2
- Subpoint 2.1
- Subpoint 2.2
1. First step
2. Second step
3. Third step
3.6 Links
Links refer to external websites and additional information.
The display text is enclosed in square brackets [ ]. The link is enclosed in round brackets () after it.
3.7 Tables
Tables are used to present data and comparative information in a structured manner.
They are particularly suitable for relatively static overviews, such as contact persons and their contact details or opening hours and addresses of company locations.
| Name | Age | Occupation |
|-------------|-------|--------------------|
| Anna Miller | 29 | Designer |
| Max Smith | 35 | Software developer |
| Lisa King | 41 | Teacher |