Diretrizes de formato para documentos e URLs importados

Examine as diretrizes a seguir para obter os melhores resultados para seu conteúdo.

Considerações de 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. Um conhecimento do formato Markdown ajuda você a entender o conteúdo convertido e gerenciar o conteúdo da sua base de dados de conhecimento.

Se você adicionar ou editar seu conteúdo diretamente na sua base de dados de conhecimento, use a formatação Markdown para criar conteúdo rich text ou alterar o conteúdo do formato Markdown que já está na resposta. O QnA Maker dá suporte a grande parte do formato Markdown para trazer funcionalidades de rich text para seu conteúdo. No entanto, o aplicativo cliente, como um chatbot, pode não dar suporte ao mesmo conjunto de formatos Markdown. É importante testar a exibição de respostas do aplicativo cliente.

Confira uma lista completa de tipos de conteúdo e exemplos.

Formatação básica de documentos

O QnA Maker identifica seções e subseções e relacionamentos no arquivo com base em indícios visuais, como:

  • tamanho da fonte
  • estilo da fonte
  • numeração
  • cores

Observação

Não há suporte para a extração de imagens de documentos carregados no momento.

Manuais de produtos

Normalmente, um manual é o material de diretrizes 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

Product Manual example for a knowledge base

Observação

A extração funciona melhor em manuais com uma tabela de conteúdo e/ou uma página de índice e uma estrutura clara com cabeçalhos hierárquicos.

Brochuras, diretrizes, documentos e outros arquivos

Muitos outros tipos de documentos também podem ser processados para gerar pares de QA, contanto que tenham uma estrutura e um layout claros. Eles incluem: brochuras, diretrizes, relatórios, white papers, artigos científicos, políticas, livros etc. Confira um exemplo aqui.

Abaixo está um exemplo de um documento semiestruturado sem um índice:

Azure Blob storage semi-structured Doc

Suporte a documentos não estruturados

Agora, as respostas às perguntas personalizadas dão suporte a documentos não estruturados. Um documento que não tem seu conteúdo organizado em uma maneira hierárquica bem definida, não tem uma estrutura definida ou tem seu fluxo de conteúdo livre, pode ser considerado um documento não estruturado.

Abaixo está um exemplo de um documento PDF não estruturado:

Unstructured document example for a knowledge base

Atualmente, essa funcionalidade está disponível apenas por meio do carregamento de documentos e apenas para formatos de arquivo PDF e DOC.

Importante

O suporte a arquivos/conteúdos não estruturados só está disponível nas respostas às perguntas.

Documento de QnA Estruturado

O formato para Pergunta-Respostas estruturas em arquivos DOC é na forma de Perguntas e Respostas alternadas por linha, uma pergunta por linha seguida pela respectiva resposta na linha seguinte, conforme mostrado abaixo:

Question1

Answer1

Question2

Answer2

Abaixo está um exemplo de um documento do word de QnA estruturado:

Structured QnA document example for a knowledge base

Arquivos TXT, TSV e XLS Estruturados

QnAs na forma de arquivos .txt, .tsv ou .xls estruturados também podem ser carregadas para o QnA Maker para criar ou ampliar uma base de conhecimento. Podem ser texto sem formatação ou ter conteúdo em RTF ou HTML. Os pares de perguntas e respostas têm um campo de metadados opcional que pode ser usado para agrupá-los em categorias.

Pergunta Resposta Metadados (1 chave: 1 valor)
Pergunta1 Resposta1 Key1:Value1 | Key2:Value2
Pergunta2 Resposta2 Key:Value

As colunas adicionais no arquivo de origem são ignoradas.

Exemplo de arquivo Excel estruturado

Abaixo está um exemplo de arquivo .xls de QnA estruturada, com conteúdo HTML:

Structured QnA excel example for a knowledge base

Exemplo de perguntas alternativas para uma resposta no arquivo Excel

Veja abaixo um exemplo de um arquivo .xls estruturado do QnA, com várias perguntas alternativas para uma resposta:

Example of alternate questions for single answer in Excel file

Depois que o arquivo for importado, o par de pergunta e resposta estará na base de dados de conhecimento, conforme mostrado abaixo:

Screenshot of alternate questions for single answer imported into knowledge base

Formato de dados estruturados por meio de importação

Importar 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 de fonte de dados. Essas informações ajudam o QnA Maker a agrupar os pares de resposta de pergunta e atribuí-los a uma fonte de dados específico. Os pares de perguntas e respostas têm um campo de metadados opcional que pode ser usado para agrupá-los em categorias.

Pergunta Resposta Fonte Metadados (1 chave: 1 valor)
Pergunta1 Resposta1 Url1 Key1:Value1 | Key2:Value2
Pergunta2 Resposta2 Editorial Key:Value

Formatação de documento de várias rodadas

  • Use títulos e subtítulos para denotar a hierarquia. Por exemplo, use h1 para indicar o par de pergunta e resposta pai e h2 para indicar o par que deve ser usado como prompt. Use títulos menores para indicar a hierarquia subsequente. Não use estilo, cor ou algum outro mecanismo para indicar a estrutura do documento, pois o QnA Maker não extrairá os prompts de várias rodadas.
  • O primeiro caractere do título deve ser maiúsculo.
  • Não termine um título com um ponto de interrogação, ?.

Documentos de exemplo:
Surface Pro (docx)
Benefícios da Contoso (docx)
Benefícios da Contoso (pdf)

URLs de perguntas frequentes

O QnA Maker pode dar suporte a páginas da Web de perguntas frequentes em três diferentes formas:

  • Páginas de perguntas frequentes simples
  • Páginas de perguntas frequentes com links
  • Páginas de perguntas frequentes com uma página inicial de tópicos

Páginas de perguntas frequentes simples

Este é o tipo mais comum de página de perguntas frequentes em que as respostas a seguem imediatamente às perguntas na mesma página.

Abaixo está um exemplo de uma página de perguntas frequentes simples:

Plain FAQ page example for a knowledge base

Nesse tipo de página de perguntas frequentes, as perguntas são agregadas e vinculadas a respostas em seções diferentes da mesma página ou em páginas diferentes.

Abaixo está um exemplo de uma página de perguntas frequentes com links nas seções que estão na mesma página:

Section Link FAQ page example for a knowledge base

Esse tipo de perguntas frequentes tem uma página Tópicos em que cada tópico está vinculado a um conjunto correspondente de perguntas e respostas em uma 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 Tópicos com links para seções de perguntas frequentes em páginas diferentes.

Deep link FAQ page example for a knowledge base

URLs de suporte

O QnA Maker pode processar páginas da web de suporte semiestruturadas, como artigos da web que descrevem como executar uma tarefa específica, como diagnosticar e resolver um problema específico e quais são as práticas recomendadas para um determinado processo. A extração funciona melhor em documentos que têm uma estrutura clara com cabeçalhos hierárquicos.

Observação

Extração para artigos de suporte é um recurso novo e está nos estágios iniciais. Funciona melhor para páginas simples, que também são estruturadas e não contêm cabeçalhos/rodapés complexos.

QnA Maker supports extraction from semi-structured web pages where a clear structure is presented with hierarchical headings

Importar e exportar base de dados de conhecimento

Os arquivos TSV e XLS das bases de dados de conhecimento exportadas somente podem ser usados ao importar 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 no 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 de pergunta e resposta 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óximas etapas

Confira uma lista completa de tipos de conteúdo e exemplos