Formato Markdown admitido en el texto de respuesta de QnA Maker
QnA Maker almacena el texto de respuesta como Markdown. Hay muchos tipos de Markdown. Para asegurarse de que el texto de respuesta se devuelve y se muestra correctamente, use esta referencia.
Use el tutorial CommonMark para validar su Markdown. El tutorial tiene una característica Pruébelo para la validación rápida de copiar y pegar.
Cuándo usar la edición de texto enriquecido en lugar de Markdown
La edición de texto enriquecido de las respuestas le permite, como autor, usar una barra de herramientas de formato para seleccionar y dar formato al texto rápidamente.
Markdown es la mejor herramienta cuando se necesita generar contenido automáticamente para crear bases de conocimiento que se van a importar como parte de una canalización de CI/CD o para pruebas por lotes.
Formato Markdown compatible
A continuación se muestra la lista de formatos de Markdown que puede usar en el texto de respuesta de QnA Maker.
Propósito | Formato | Markdown de ejemplo | Representación tal como se muestra en el bot de chat |
---|---|---|---|
Nueva línea entre dos oraciones. | \n\n |
How can I create a bot with \n\n QnA Maker? |
|
Encabezados de h1 a h6, el número de # indica el encabezado. 1 # es el 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 |
|
Cursiva | *text* |
How do I create a bot with *QnA Maker*? |
|
Negrita | **text** |
How do I create a bot with **QnA Maker**? |
|
Dirección URL del vínculo | [text](https://www.my.com) |
How do I create a bot with [QnA Maker](https://www.qnamaker.ai)? |
|
*Dirección URL de imagen 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 |
|
Negrita y cursiva | ***text*** |
How can I create a ***QnA Maker*** bot? |
|
Dirección URL en negrita del vínculo. | [**text**](https://www.my.com) |
How do I create a bot with [**QnA Maker**](https://www.qnamaker.ai)? |
|
Dirección URL en cursiva del vínculo. | [*text*](https://www.my.com) |
How do I create a bot with [*QnA Maker*](https://www.qnamaker.ai)? |
|
Símbolos de escape de Markdown | \*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 En el ejemplo anterior se utiliza la numeración automática integrada en Markdown. This is an ordered list: \n 1. List item 1 \n 2. List item 2 En el ejemplo anterior se usa la numeración explícita. |
|
Lista sin ordenar | \n * item1 \n * item2 or \n - item1 \n - item2 |
This is an unordered list: \n * List item 1 \n * List item 2 |
|
Listas anidadas | \n * Parent1 \n\t * Child1 \n\t * Child2 \n * Parent2 \n * Parent1 \n\t 1. Child1 \n\t * Child2 \n 1. Parent2 Puede anidar listas ordenadas y sin ordenar juntas. La pestaña, \t , indica el nivel de sangría del elemento secundario. |
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 |
\* QnA Maker no procesa la imagen de ninguna manera. Es el rol de la aplicación cliente para representar la imagen.
Si quiere agregar contenido mediante las API de base de conocimiento de actualización y sustitución y el contenido o el archivo incluyen etiquetas HTML, puede conservar el código HTML en el archivo si se asegura de que la apertura y el cierre de las etiquetas se convierten en el formato codificado.
Conservar HTML | Representación en la solicitud de API | Representación en la base de conocimiento |
---|---|---|
Sí | < br> | <br> |
Sí | < h3> encabezado | <h3>header</h3> |
Además, CR LF(\r\n) se convierte en \n en la base de conocimiento. LF(\n) se queda como está. Si quiere escapar cualquier secuencia de escape, como \t o \n, puede usar una barra diagonal inversa, por ejemplo: "\\r\\n" y "\\t".
Pasos siguientes
Revise los formatos de archivo de las pruebas por lotes.