Formato Markdown suportado no texto de resposta do QnA Maker
O QnA Maker armazena o texto da resposta como markdown. Há muitos sabores de markdown. Para garantir que o texto da resposta seja retornado e exibido corretamente, use essa referência.
Use o tutorial CommonMark para validar seu Markdown. O tutorial tem um recurso Try it para validação rápida de copiar / colar.
Quando usar edição rich-text versus markdown
A edição rich-text de respostas permite que você, como autor, use uma barra de ferramentas de formatação para selecionar e formatar texto rapidamente.
Markdown é uma ferramenta melhor quando você precisa gerar automaticamente conteúdo para criar bases de conhecimento a serem importadas como parte de um pipeline de CI/CD ou para testes em lote.
Formato de markdown suportado
A seguir está a lista de formatos de marcação que você pode usar no texto de resposta do QnA Maker.
Propósito | Formato | Markdown de exemplo | Composição conforme exibido no bot de bate-papo |
---|---|---|---|
Uma nova linha entre 2 frases. | \n\n |
How can I create a bot with \n\n QnA Maker? |
|
Cabeçalhos de h1 a h6, o número de # indica qual cabeçalho. # 1 é o h1. |
\n# text \n## text \n### text \n####text \n#####text |
## Creating a bot \n ...text.... \n### Important news\n ...text... \n### Related Information\n ....text... \n# my h1 \n## my h2\n### my h3 \n#### my h4 \n##### my h5 |
|
Itálico | *text* |
How do I create a bot with *QnA Maker*? |
|
Forte (negrito) | **text** |
How do I create a bot with **QnA Maker**? |
|
URL para link | [text](https://www.my.com) |
How do I create a bot with [QnA Maker](https://www.qnamaker.ai)? |
|
*URL para imagem pública | ![text](https://www.my.com/image.png) |
How can I create a bot with ![QnAMaker](https://review.learn.microsoft.com/azure/ai-services/qnamaker/media/qnamaker-how-to-key-management/qnamaker-resource-list.png) |
|
Rasurado | ~~text~~ |
some ~~questoins~~ questions need to be asked |
|
Negrito e itálico | ***text*** |
How can I create a ***QnA Maker*** bot? |
|
URL em negrito para link | [**text**](https://www.my.com) |
How do I create a bot with [**QnA Maker**](https://www.qnamaker.ai)? |
|
URL em itálico para link | [*text*](https://www.my.com) |
How do I create a bot with [*QnA Maker*](https://www.qnamaker.ai)? |
|
Símbolos de marcação de escape | \*text\* |
How do I create a bot with \*QnA Maker\*? |
|
Lista ordenada | \n 1. item1 \n 1. item2 |
This is an ordered list: \n 1. List item 1 \n 1. List item 2 O exemplo anterior usa numeração automática embutida na marcação. This is an ordered list: \n 1. List item 1 \n 2. List item 2 O exemplo anterior usa numeração explícita. |
|
Lista não ordenada | \n * item1 \n * item2 ou \n - item1 \n - item2 |
This is an unordered list: \n * List item 1 \n * List item 2 |
|
Nested lists | \n * Parent1 \n\t * Child1 \n\t * Child2 \n * Parent2 \n * Parent1 \n\t 1. Child1 \n\t * Child2 \n 1. Parent2 Você pode aninhar listas ordenadas e não ordenadas juntas. A guia, \t , indica o nível de recuo do elemento filho. |
This is an unordered list: \n * List item 1 \n\t * Child1 \n\t * Child2 \n * List item 2 This is an ordered nested list: \n 1. Parent1 \n\t 1. Child1 \n\t 1. Child2 \n 1. Parent2 |
*O QnA Maker não processa a imagem de forma alguma. É função do aplicativo cliente renderizar a imagem.
Se quiser adicionar conteúdo usando APIs da base de dados de conhecimento update/replace e o conteúdo/arquivo contiver tags html, você poderá preservar o HTML em seu arquivo garantindo que a abertura e o fechamento das tags sejam convertidos no formato codificado.
Preservar HTML | Representação na solicitação de API | Representação em KB |
---|---|---|
Sim | < br> | <br> |
Sim | < h3> cabeçalho | <h3>cabeçalho</h3> |
Além disso, CR LF(\r\n) são convertidos em \n no KB. LF(\n) é mantido como está. Se você quiser escapar de qualquer sequência de escape como \t ou \n, você pode usar barra invertida, por exemplo: '\\r\\n' e '\\t'
Próximos passos
Revise os formatos de arquivo de teste em lote.