Diretrizes de formato para documentos e URLs importadasFormat guidelines for imported documents and URLs

Examine essas diretrizes de formatação para obter os melhores resultados para seu conteúdo.Review these formatting guidelines to get the best results for your content.

Considerações de formataçãoFormatting considerations

Depois de importar um arquivo ou URL, QnA Maker converte e armazena seu conteúdo no formato de redução.After importing a file or URL, QnA Maker converts and stores your content in the markdown format. O processo de conversão adiciona novas linhas no texto, como \n\n .The conversion process adds new lines in the text, such as \n\n. Um conhecimento do formato de redução ajuda você a entender o conteúdo convertido e gerenciar seu conteúdo da base de dados de conhecimento.A knowledge of the markdown format helps you to understand the converted content and manage your knowledge base content.

Se você adicionar ou editar seu conteúdo diretamente na sua base de dados de conhecimento, use a formatação de redução para criar conteúdo de Rich Text ou alterar o conteúdo do formato de redução que já está na resposta.If you add or edit your content directly in your knowledge base, use markdown formatting to create rich text content or change the markdown format content that is already in the answer. QnA Maker dá suporte a grande parte do formato de redução para trazer recursos de Rich Text para seu conteúdo.QnA Maker supports much of the markdown format to bring rich text capabilities to your content. No entanto, o aplicativo cliente, como um bot de chat, pode não dar suporte ao mesmo conjunto de formatos de redução.However, the client application, such as a chat bot may not support the same set of markdown formats. É importante testar a exibição de respostas do aplicativo cliente.It is important to test the client application's display of answers.

Consulte uma lista completa de tipos de conteúdo e exemplos.See a full list of content types and examples.

Formatação básica de documentosBasic document formatting

QnA Maker identifica seções e subseções e relações no arquivo com base em pistas visuais como:QnA Maker identifies sections and subsections and relationships in the file based on visual clues like:

  • tamanho da fontefont size
  • estilo da fontefont style
  • numeraçãonumbering
  • corescolors

Observação

Não há suporte para extração de imagens de documentos carregados no momento.We don't support extraction of images from uploaded documents currently.

Manuais de produtosProduct manuals

Normalmente, um manual é o material de diretrizes que acompanha um produto.A manual is typically guidance material that accompanies a product. Ele ajuda o usuário a configurar, usar, manter e solucionar problemas do produto.It helps the user to set up, use, maintain, and troubleshoot the product. Quando o QnA Maker processa um manual, ele extrai os títulos e subtítulos como perguntas e o conteúdo subsequente como respostas.When QnA Maker processes a manual, it extracts the headings and subheadings as questions and the subsequent content as answers. Veja um exemplo aqui.See an example here.

Abaixo está um exemplo de um manual com uma página de índice e conteúdo hierárquicoBelow is an example of a manual with an index page, and hierarchical content

Exemplo de manual de produto para uma base de dados de conhecimento

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.Extraction works best on manuals that have a table of contents and/or an index page, and a clear structure with hierarchical headings.

Brochuras, diretrizes, documentos e outros arquivosBrochures, guidelines, papers, and other files

Muitos outros tipos de documentos também podem ser processados para gerar pares de QA, contanto que tenham uma estrutura e um layout claros.Many other types of documents can also be processed to generate QA pairs, provided they have a clear structure and layout. Eles incluem: folhetos, diretrizes, relatórios, White papers, documentos científicos, políticas, livros, etc. Veja um exemplo aqui.These include: Brochures, guidelines, reports, white papers, scientific papers, policies, books, etc. See an example here.

Abaixo está um exemplo de um documento semiestruturado sem um índice:Below is an example of a semi-structured doc, without an index:

Documento semiestruturado de armazenamento de Blobs do Azure

Documento de QnA EstruturadoStructured QnA Document

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:The format for structured Question-Answers in DOC files, is in the form of alternating Questions and Answers per line, one question per line followed by its answer in the following line, as shown below:

Question1

Answer1

Question2

Answer2

Abaixo está um exemplo de um documento do word de QnA estruturado:Below is an example of a structured QnA word document:

Exemplo de documento do QnA estruturado em uma base de dados de conhecimento

Arquivos TXT, TSV e XLS EstruturadosStructured TXT, TSV and XLS Files

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.QnAs in the form of structured .txt, .tsv or .xls files can also be uploaded to QnA Maker to create or augment a knowledge base. Podem ser texto sem formatação ou ter conteúdo em RTF ou HTML.These can either be plain text, or can have content in RTF or HTML.

PerguntaQuestion RespostaAnswer Metadados (1 chave: 1 valor)Metadata (1 key: 1 value)
Pergunta1Question1 Resposta1Answer1 Key1:Value1 | Key2:Value2
Pergunta2Question2 Resposta2Answer2 Key:Value

As colunas adicionais no arquivo de origem são ignoradas.Any additional columns in the source file are ignored.

Exemplo de arquivo do Excel estruturadoExample of structured Excel file

Abaixo está um exemplo de arquivo .xls de QnA estruturada, com conteúdo HTML:Below is an example of a structured QnA .xls file, with HTML content:

Exemplo do QnA estruturado em uma base de dados de conhecimento

Exemplo de perguntas alternativas para uma única resposta no arquivo do ExcelExample of alternate questions for single answer in Excel file

Veja abaixo um exemplo de um arquivo QnA . xls estruturado, com várias perguntas alternativas para uma única resposta:Below is an example of a structured QnA .xls file, with several alternate questions for a single answer:

Exemplo de perguntas alternativas para uma única resposta no arquivo do Excel

Depois que o arquivo for importado, o par de perguntas e respostas estará na base de dados de conhecimento, conforme mostrado abaixo:After the file is imported, the question-and-answer pair is in the knowledge base as shown below:

Captura de tela de perguntas alternativas para uma única resposta importada na base de dados de conhecimento

Formato de dados estruturados por meio de importaçãoStructured data format through import

Importar uma base de dados de conhecimento substitui o conteúdo da base de dados de conhecimento existente.Importing a knowledge base replaces the content of the existing knowledge base. A importação requer um arquivo .tsv estruturado que contenha informações de fonte de dados.Import requires a structured .tsv file that contains data source information. 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.This information helps QnA Maker group the question-answer pairs and attribute them to a particular data source.

PerguntaQuestion RespostaAnswer FonteSource Metadados (1 chave: 1 valor)Metadata (1 key: 1 value)
Pergunta1Question1 Resposta1Answer1 Url1Url1 Key1:Value1 | Key2:Value2
Pergunta2Question2 Resposta2Answer2 EditorialEditorial Key:Value

Formatação de documento de várias transformaçõesMulti-turn document formatting

  • Use títulos e subtítulos para denotar hierarquia.Use headings and sub-headings to denote hierarchy. Por exemplo, você pode indicar que o pai QnA e H2 denotam o QnA que deve ser levado como prompt.For example You can h1 to denote the parent QnA and h2 to denote the QnA that should be taken as prompt. Use pequeno tamanho de título para denotar a hierarquia subsequente.Use small heading size to denote subsequent hierarchy. Não use estilo, cor ou algum outro mecanismo para implicar a estrutura em seu documento, QnA Maker não extrairá as solicitações de múltipla ativação.Don't use style, color, or some other mechanism to imply structure in your document, QnA Maker will not extract the multi-turn prompts.
  • O primeiro caractere de título deve estar em letras maiúsculas.First character of heading must be capitalized.
  • Não termine um cabeçalho com um ponto de interrogação, ? .Do not end a heading with a question mark, ?.

Documentos de exemplo:Sample documents:
Surface pro (docx)Surface Pro (docx)
Benefícios da Contoso (docx)Contoso Benefits (docx)
Benefícios da Contoso (PDF)Contoso Benefits (pdf)

URLs de perguntas frequentesFAQ URLs

O QnA Maker pode dar suporte a páginas da Web de perguntas frequentes em três diferentes formas:QnA Maker can support FAQ web pages in 3 different forms:

  • Páginas de perguntas frequentes simplesPlain FAQ pages
  • Páginas de perguntas frequentes com linksFAQ pages with links
  • Página de perguntas frequentes com uma home page de tópicosFAQ pages with a Topics Homepage

Páginas de perguntas frequentes simplesPlain FAQ pages

Este é o tipo mais comum de página de perguntas frequentes em que as respostas a seguem imediatamente às perguntas na mesma página.This is the most common type of FAQ page, in which the answers immediately follow the questions in the same page.

Abaixo está um exemplo de uma página de perguntas frequentes simples:Below is an example of a plain FAQ page:

Exemplo de página de perguntas frequentes simples para uma base de dados de conhecimento

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.In this type of FAQ page, questions are aggregated together and are linked to answers that are either in different sections of the same page, or in different pages.

Abaixo está um exemplo de uma página de perguntas frequentes com links nas seções que estão na mesma página:Below is an example of an FAQ page with links in sections that are on the same page:

Exemplo de página de perguntas frequentes com link de seção para uma base de dados de conhecimento

Esse tipo de perguntas frequentes tem uma página de tópicos em que cada tópico está vinculado a um conjunto correspondente de perguntas e respostas em uma página diferente.This type of FAQ has a Topics page where each topic is linked to a corresponding set of questions and answers on a different page. QnA Maker rastreia todas as páginas vinculadas para extrair as perguntas correspondentes & respostas.QnA Maker crawls all the linked pages to extract the corresponding questions & answers.

Abaixo está um exemplo de uma página de tópicos com links para seções de perguntas frequentes em páginas diferentes.Below is an example of a Topics page with links to FAQ sections in different pages.

Exemplo de página de perguntas frequentes com link profundo para uma base de dados de conhecimento

URLs de suporteSupport URLs

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.QnA Maker can process semi-structured support web pages, such as web articles that would describe how to perform a given task, how to diagnose and resolve a given problem, and what are the best practices for a given process. A extração funciona melhor em documentos que têm uma estrutura clara com cabeçalhos hierárquicos.Extraction works best on content that has a clear structure with hierarchical headings.

Observação

Extração para artigos de suporte é um recurso novo e está nos estágios iniciais.Extraction for support articles is a new feature and is in early stages. Funciona melhor para páginas simples, que também são estruturadas e não contêm cabeçalhos/rodapés complexos.It works best for simple pages, that are well structured, and do not contain complex headers/footers.

O QnA Maker dá suporte à extração de páginas web semi-estruturadas em que a estrutura limpa é apresentada com cabeçalhos hierárquicos

Importar e exportar base de dados de conhecimentoImport and export knowledge base

Os arquivos TSV e XLS, das bases de dados de conhecimento exportadas, só podem ser usados pela importação dos arquivos da página configurações no portal de QnA Maker.TSV and XLS files, from exported knowledge bases, can only be used by importing the files from the Settings page in the QnA Maker portal. Eles não podem ser usados como fontes de dados durante a criação da base de conhecimento ou no recurso + Adicionar arquivo ou + Adicionar URL na página configurações .They can't be used as data sources during knowledge base creation or from the + Add file or + Add URL feature on the Settings page.

Quando você importa a base de dados de conhecimento por meio desses arquivos TSV e XLS, os pares de 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.When you import the Knowledge base through these TSV and XLS files, the QnA pairs get added to the editorial source and not the sources from which the QnAs were extracted in the exported Knowledge Base.

Próximas etapasNext steps

Veja uma lista completa de tipos de conteúdo e exemplosSee a full list of content types and examples