Diretrizes de formato para documentos e URLs importados
Reveja estas diretrizes de formatação para obter os melhores resultados para o seu conteúdo.
Considerações sobre formatação
Depois de importar um arquivo ou URL, o QnA Maker converte e armazena seu conteúdo no formato markdown. O processo de conversão adiciona novas linhas no texto, como \n\n. O conhecimento do formato de marcação ajuda você a entender o conteúdo convertido e gerenciar o conteúdo da base de conhecimento.
Se você adicionar ou editar seu conteúdo diretamente em sua base de dados de conhecimento, use a formatação de marcação para criar conteúdo rich text ou altere o conteúdo de formato de marcação que já está na resposta. O QnA Maker suporta grande parte do formato markdown para trazer recursos de rich text ao seu conteúdo. No entanto, o aplicativo cliente, como um bot de bate-papo, pode não suportar o mesmo conjunto de formatos de marcação. É importante testar a exibição de respostas do aplicativo cliente.
Veja uma lista completa de tipos de conteúdo e exemplos.
Formatação básica do documento
O QnA Maker identifica seções, subseções e relacionamentos no arquivo com base em pistas visuais como:
- tamanho do tipo de letra
- estilo da fonte
- numeração
- cores
Nota
Atualmente, não suportamos a extração de imagens de documentos carregados.
Manuais do produto
Um manual é normalmente um material de orientação que acompanha um produto. Ele ajuda o usuário a configurar, usar, manter e solucionar problemas do produto. Quando o QnA Maker processa um manual, ele extrai os títulos e subtítulos como perguntas e o conteúdo subsequente como respostas. Veja um exemplo aqui.
Abaixo está um exemplo de um manual com uma página de índice e conteúdo hierárquico
Nota
A extração funciona melhor em manuais que têm um índice e/ou uma página de índice e uma estrutura clara com cabeçalhos hierárquicos.
Brochuras, diretrizes, documentos e outros ficheiros
Muitos outros tipos de documentos também podem ser processados para gerar pares de GQ, desde que tenham uma estrutura e layout claros. Estes incluem: Brochuras, diretrizes, relatórios, white papers, artigos científicos, políticas, livros, etc. Veja um exemplo aqui.
Abaixo está um exemplo de um documento semi-estruturado, sem um índice:
Suporte a documentos não estruturados
A resposta personalizada a perguntas agora suporta documentos não estruturados. Um documento que não tem o seu conteúdo organizado de forma hierárquica bem definida, que não tem uma estrutura definida ou que tem o seu conteúdo a fluir livremente pode ser considerado como um documento não estruturado.
Abaixo está um exemplo de um documento PDF não estruturado:
Atualmente, esta funcionalidade está disponível apenas através do upload de documentos e apenas para os formatos de ficheiro PDF e DOC.
Importante
O suporte para ficheiros/conteúdos não estruturados só está disponível na resposta a perguntas.
Documento QnA estruturado
O formato para Perguntas-Respostas estruturadas em arquivos DOC, é na forma de Perguntas e Respostas alternadas por linha, uma pergunta por linha seguida de sua resposta na seguinte linha, como mostrado abaixo:
Question1
Answer1
Question2
Answer2
Abaixo está um exemplo de um documento de palavra QnA estruturado:
Arquivos TXT, TSV e XLS estruturados
QnAs na forma de .txt estruturado, .tsv ou arquivos .xls também podem ser carregados no QnA Maker para criar ou aumentar uma base de conhecimento. Estes podem ser texto simples ou podem ter conteúdo em RTF ou HTML. Os pares QnA têm um campo de metadados opcional que pode ser usado para agrupar pares QnA em categorias.
| Pergunta | Resposta | Metadados (1 chave: 1 valor) |
|---|---|---|
| Pergunta1 | Resposta1 | Key1:Value1 | Key2:Value2 |
| Pergunta2 | Resposta2 | Key:Value |
Todas as colunas adicionais no arquivo de origem são ignoradas.
Exemplo de arquivo Excel estruturado
Abaixo está um exemplo de um arquivo de .xls QnA estruturado, com conteúdo HTML:
Exemplo de perguntas alternativas para resposta única no arquivo Excel
Abaixo está um exemplo de um arquivo de .xls QnA estruturado, com várias perguntas alternativas para uma única resposta:
Depois que o arquivo é importado, o par de perguntas e respostas está na base de dados de conhecimento, conforme mostrado abaixo:
Formato de dados estruturados através da importação
A importação de uma base de dados de conhecimento substitui o conteúdo da base de dados de conhecimento existente. A importação requer um arquivo .tsv estruturado que contenha informações da fonte de dados. Essas informações ajudam o QnA Maker a agrupar os pares pergunta-resposta e atribuí-los a uma fonte de dados específica. Os pares QnA têm um campo de metadados opcional que pode ser usado para agrupar pares QnA em categorias.
| Pergunta | Resposta | Origem | Metadados (1 chave: 1 valor) |
|---|---|---|---|
| Pergunta1 | Resposta1 | Url1 | Key1:Value1 | Key2:Value2 |
| Pergunta2 | Resposta2 | Editorial | Key:Value |
Formatação de documentos em várias voltas
- Use títulos e subtítulos para indicar hierarquia. Por exemplo: Você pode h1 para denotar o QnA pai e h2 para denotar o QnA que deve ser tomado como prompt. Use um tamanho de título pequeno para indicar a hierarquia subsequente. Não use estilo, cor ou algum outro mecanismo para implicar estrutura em seu documento, o QnA Maker não extrairá os prompts de várias voltas.
- O primeiro caractere do título deve ser maiúsculo.
- Não termine um título com um ponto de interrogação,
?.
Exemplos de documentos:
Surface Pro (docx)
Benefícios da Contoso (docx)
Benefícios da Contoso (pdf)
FAQ URLs
O QnA Maker pode suportar páginas web de FAQ em 3 formas diferentes:
- Páginas simples de perguntas frequentes
- Páginas de FAQ com links
- Páginas de FAQ com uma Homepage de Tópicos
Páginas simples de perguntas frequentes
Este é o tipo mais comum de página de FAQ, em que as respostas seguem imediatamente as perguntas na mesma página.
Abaixo está um exemplo de uma página de FAQ simples:
Páginas de FAQ com links
Neste tipo de página de FAQ, as perguntas são agregadas e estão ligadas a respostas que estão em diferentes secções da mesma página ou em páginas diferentes.
Abaixo está um exemplo de uma página de FAQ com links em seções que estão na mesma página:
Links da página Tópicos dos pais para páginas de respostas de crianças
Este tipo de FAQ tem uma página de Tópicos onde cada tópico está ligado a um conjunto correspondente de perguntas e respostas numa página diferente. O QnA Maker rastreia todas as páginas vinculadas para extrair as perguntas e respostas correspondentes.
Abaixo está um exemplo de uma página de tópicos com links para seções de perguntas frequentes em páginas diferentes.
URLs de suporte
O QnA Maker pode processar páginas da Web de suporte semiestruturadas, como artigos da Web que descreveriam como executar uma determinada tarefa, como diagnosticar e resolver um determinado problema e quais são as melhores práticas para um determinado processo. A extração funciona melhor em conteúdo que tem uma estrutura clara com cabeçalhos hierárquicos.
Nota
A extração de artigos de suporte é um recurso novo e está em estágios iniciais. Funciona melhor para páginas simples, que estão bem estruturadas e não contêm cabeçalhos/rodapés complexos.
Base de conhecimento de importação e exportação
Os arquivos TSV e XLS, de bases de dados de conhecimento exportadas, só podem ser usados importando os arquivos da página Configurações no portal do QnA Maker. Eles não podem ser usados como fontes de dados durante a criação da base de dados de conhecimento ou do recurso + Adicionar arquivo ou + Adicionar URL na página Configurações .
Quando você importa a Base de Dados de Conhecimento por meio desses arquivos TSV e XLS, os pares QnA são adicionados à fonte editorial e não às fontes das quais os QnAs foram extraídos na Base de Dados de Conhecimento exportada.
Próximos passos
Veja uma lista completa de tipos de conteúdo e exemplos