Formato Markdown compatível com o texto de resposta do QnA Maker
O QnA Maker armazena texto de resposta como markdown. Existem várias variantes de markdown. Para ter certeza de que o texto de resposta será retornado e exibido corretamente, use esta referência.
Use o tutorial CommonMark para validar seu Markdown. O tutorial tem um recurso Experimentar para validação rápida de copiar/colar.
Quando usar edição de rich text ou markdown
A edição de respostas em rich text permite que você, como autor, use uma barra de ferramentas de formatação para selecionar e formatar rapidamente o texto.
Markdown é uma ferramenta melhor quando você precisa gerar o conteúdo automaticamente para criar bases de dados de conhecimento a serem importadas como parte de um pipeline de CI/CD ou para testes em lotes.
Formato de markdown compatível
Veja a seguir a lista de formatos de markdown que podem ser usados no texto de resposta do QnA Maker.
Finalidade | Formatar | Exemplo de markdown | Renderização Conforme exibido no chatbot |
---|---|---|---|
Uma nova linha entre duas frases. | \n\n |
How can I create a bot with \n\n QnA Maker? |
|
Cabeçalhos de H1 a H6, o número de # denota o 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 do link | [text](https://www.my.com) |
How do I create a bot with [QnA Maker](https://www.qnamaker.ai)? |
|
*URL de 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) |
|
Tachado | ~~text~~ |
some ~~questoins~~ questions need to be asked |
|
Negrito e itálico | ***text*** |
How can I create a ***QnA Maker*** bot? |
|
URL do link em negrito | [**text**](https://www.my.com) |
How do I create a bot with [**QnA Maker**](https://www.qnamaker.ai)? |
|
URL do link em itálico | [*text*](https://www.my.com) |
How do I create a bot with [*QnA Maker*](https://www.qnamaker.ai)? |
|
Símbolos de markdown 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 a numeração automática incorporada ao markdown. This is an ordered list: \n 1. List item 1 \n 2. List item 2 O exemplo anterior usa a 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 |
|
Listas aninhadas | \n * Parent1 \n\t * Child1 \n\t * Child2 \n * Parent2 \n * Parent1 \n\t 1. Child1 \n\t * Child2 \n 1. Parent2 É possível aninhar listas ordenadas e não ordenadas. 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 modo algum. Renderizar a imagem é função do aplicativo cliente.
Para adicionar conteúdo usando as APIs de atualização/substituição da base de dados de conhecimento quando o conteúdo/arquivo contém tags de HTML, preserve o HTML no 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 na base de dados de conhecimento |
---|---|---|
Sim | < br> | <br> |
Sim | < h3> cabeçalho | <h3>header</h3> |
Além disso, CR LF(\r\n) é convertido para \n na base de dados de conhecimento. LF(\n) é mantido como está. Para escapar uma sequência de escape como \t ou \n, use a barra invertida, por exemplo: '\\r\\n' and '\\t'
Próximas etapas
Examine os formatos de arquivo de teste de lote.