Fontes de dados para conteúdo do QnA MakerData sources for QnA Maker content

O QnA Maker extrai automaticamente pares de pergunta-resposta do conteúdo semiestruturado, como perguntas frequentes, manuais de produto, diretrizes, documentos de suporte e políticas armazenadas como arquivos de documentos do Microsoft Word, arquivos PDF ou páginas da Web.QnA Maker automatically extracts question-answer pairs from semi-structured content such as FAQs, product manuals, guidelines, support documents, and policies stored as web pages, PDF files, or MS Word doc files . O conteúdo também pode ser adicionado à base de conhecimento dos arquivos de conteúdo QnA estruturados.Content can also be added to the knowledge base from structured QnA content files.

Tipos de dados de arquivo e URLFile and URL data types

A tabela a seguir resume os tipos de conteúdo e formatos de arquivo com suporte no QnA Maker.The table below summarizes the types of content and file formats that are supported by QnA Maker.

Tipo de FonteSource Type Tipo de conteúdoContent Type ExemplosExamples
URLURL Perguntas frequentesFAQs
(simples, com seções ou com uma página inicial de tópicos)(Flat, with sections or with a topics homepage)
Páginas de suporteSupport pages
(artigos de instrução de uma página, artigos de solução de problemas etc.)(Single page how-to articles, troubleshooting articles etc.)
Perguntas frequentes simples,Plain FAQ,
Perguntas frequentes com links,FAQ with links,
Perguntas frequentes com home page de tópicosFAQ with topics homepage
Artigo de suporteSupport article
PDF/DOCPDF / DOC Perguntas frequentes,FAQs,
Manual do Produto,Product Manual,
Folhetos,Brochures,
Papel,Paper,
Política de folheto,Flyer Policy,
Guia de suporte,Support guide,
QnA estruturado,Structured QnA,
etc.etc.
QnA.doc estruturado,Structured QnA.doc,
Exemplo produto Manual.pdf,Sample Product Manual.pdf,
Exemplo semi-estruturado.doc,Sample semi-structured.doc,
Exemplo White Paper. pdf,Sample white paper.pdf,
Exemplo de multi-Turn. docxSample multi-turn.docx
* Excel*Excel Arquivo QnA estruturadoStructured QnA file
(incluindo suporte RTF, HTML)(including RTF, HTML support)
Exemplo de QnA FAQ.xlsSample QnA FAQ.xls
* TXT/TSV*TXT/TSV Arquivo QnA estruturadoStructured QnA file Exemplo de chit-chat.tsvSample chit-chat.tsv

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.

Locais de origem de dadosData source locations

Os locais de fonte de dados são URLs ou arquivos públicos, que não exigem autenticação.Data source locations are public URLs or files, which do not require authentication.

Se você precisar de autenticação para sua fonte de dados, considere os seguintes métodos para obter esses dados em QnA Maker:If you need authentication for your data source, consider the following methods to get that data into QnA Maker:

Baixar arquivo do local da fonte de dados autenticadaDownload file from authenticated data source location

Se você tiver um arquivo autenticado (não em um local do SharePoint autenticado) ou URL, uma opção alternativa é baixar o arquivo do site autenticado para o computador local e, em seguida, adicionar o arquivo do seu computador local à base de dados de conhecimento.If you have an authenticated file (not on an authenticated Sharepoint location) or URL, an alternative option is to download the file from the authenticated site to your local computer, then add the file from your local computer to the knowledge base.

Importar arquivo do SharePoint autenticadoImport file from authenticated Sharepoint

Os locais de fonte de dados do SharePoint têm permissão para fornecer arquivosautenticados.Sharepoint data source locations are allowed to provide authenticated files. Os recursos do SharePoint devem ser arquivos, não páginas da Web.Sharepoint resources must be files, not web pages. Se a URL terminar com uma extensão da Web, como . ASPX, ele não será importado para o QnA Maker do SharePoint.If the URL ends with a web extension, such as .ASPX, it will not import into QnA Maker from Sharepoint.

URLs de perguntas frequentesFAQ URLs

O QnA Maker pode dar suporte a páginas da Web de perguntas frequentes de três maneiras diferentes: 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.QnA Maker can support FAQ web pages in 3 different forms: Plain FAQ pages, FAQ pages with links, FAQ 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

Páginas de perguntas frequentes com uma página inicial de TópicosFAQ pages with a Topics homepage

Esse tipo de perguntas frequentes tem uma página inicial com Tópicos, em que cada tópico é um link para as QnAs relevantes em uma página diferente.This type of FAQ has a home page with the Topics where each Topic is a link to its relevant QnAs in a different page. Aqui, o QnA Maker rastreia todas as páginas vinculadas para extrair as perguntas e respostas correspondentes.Here, QnA Maker crawls all the linked pages to extract the corresponding questions & answers.

Abaixo está um exemplo de uma página de perguntas frequentes em que uma página inicial de tópicos tem links para seções de perguntas frequentes em diferentes páginas.Below is an example of an FAQ page where a topics homepage has links to FAQ sections in different pages.

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

Suporte a UrlsSupport 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

Arquivos PDF/DOCPDF/ DOC files

O QnA Maker pode processar o conteúdo semiestruturado em um arquivo PDF ou documento e convertê-la em QnAs.QnA Maker can process semi-structured content in a PDF or DOC file, and convert it into QnAs. Um bom arquivo que pode ser extraído também é um arquivo em que o conteúdo está organizado em alguma forma estruturada e é representado em seções bem definidas.A good file that can be extracted well is one where content is organized in some structured form, and is represented in well-defined sections. As seções adicionais podem ser divididas em subseções ou subtópicos.The sections can further be broken inTO subsections, or subtopics. A extração funciona melhor em documentos que têm uma estrutura clara com cabeçalhos hierárquicos.Extraction works best on documents that have a clear structure with hierarchical headings.

QnA Maker identifica seções e subseções e relações no arquivo com base em pistas visuais, como tamanho da fonte, estilo da fonte, numeração, cores, etc. Arquivos de documento ou PDF semiestruturados podem ser manuais, perguntas frequentes, diretrizes, políticas, folhetos, panfletos e muitos outros tipos de arquivos.QnA Maker identifies sections and subsections and relationships in the file based on visual clues like font size, font style, numbering, colors, etc. Semi-structured PDF or DOC files could be Manuals, FAQs, Guidelines, Policies, Brochures, Flyers, and many other types of files. Abaixo estão alguns tipos de exemplo desses arquivos.Below are some example types of these files.

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 OrigemSource Metadados (1 chave: 1 valor)Metadata (1 key: 1 value)
Pergunta1Question1 Resposta1Answer1 Url1Url1 Key1:Value1 | Key2:Value2
Pergunta2Question2 Resposta2Answer2 EditorialEditorial Key:Value

Adicionar de modo editorial à base de dados de conhecimentoEditorially add to knowledge base

Se não tiver conteúdo pré-existente para preencher a base de dados de conhecimento, você poderá adicionar QnAs editorialmente na Base de Dados de Conhecimento do QnA Maker.If you do not have pre-existing content to populate the knowledge base, you can add QnAs editorially in QnA Maker Knowledge base. Saiba como atualizar sua base de dados de conhecimento aqui.Learn how to update your knowledge base here.

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.

A seguir está a lista de formatos de redução que você pode usar em QnA Maker:Following is the list of markdown formats that you can use in QnA Maker:

FinalidadePurpose FormatarFormat Exemplo de markdownExample markdown RenderizaçãoRendering
conforme exibido no bot de chatas displayed in Chat bot
Uma nova linha entre duas frases.A new line between 2 sentences. \n\n How can I create a bot with \n\n QnA Maker? Formatar nova linha entre duas frases
Cabeçalhos de H1 a H6, o número de # denota qual cabeçalho.Headers from h1 to h6, the number of # denotes which header. 1 # é o H1.1 # is the 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
Formatar com cabeçalhos de redução
Formatar com cabeçalhos de redução H1 a H5
ItálicoItalics *text* How do I create a bot with *QnA Maker*? Formatar com itálico
Cadeia de caracteres (negrito)String (bold) **text** How do I create a bot with **QnA Maker**? Formatar com marcação forte para negrito
URL para o linkURL for link [text](https://www.my.com) How do I create a bot with [QnA Maker](https://www.qnamaker.ai)? formato da URL (hiperlink)
* URL para imagem pública*URL for public image ![text](https://www.my.com/image.png) How can I create a bot with ![QnAMaker](https://review.docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/media/qnamaker-how-to-key-management/qnamaker-resource-list.png) formato da URL da imagem públicaformat for public image URL
TachadoStrikethrough ~~text~~ some ~~questoins~~ questions need to be asked formato de tachado
Negrito e itálicoBold and italics ***text*** How can I create a ***QnA Maker*** bot? formato para negrito e itálico
URL em negrito para o linkBold URL for link [**text**](https://www.my.com) How do I create a bot with [**QnA Maker**](https://www.qnamaker.ai)? formato para URL em negrito
URL de itálico para o linkItalics URL for link [*text*](https://www.my.com) How do I create a bot with [*QnA Maker*](https://www.qnamaker.ai)? formato para URL de itálico
Símbolos de redução de escapeEscape markdown symbols \*text\* How do I create a bot with \*QnA Maker\*? formato para URL de itálico
Lista ordenadaOrdered list \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 à redução.The preceding example uses automatic numbering built into 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.The preceding example uses explicit numbering.
formato da lista ordenada
Lista não ordenadaUnordered list \n * item1 \n * item2
ouor
\n - item1 \n - item2
This is an ordered list: \n * List item 1 \n * List item 2 formato da lista não ordenada
Listas aninhadasNested lists \n * Parent1 \n\t * Child1 \n\t * Child2 \n * Parent2

\n * Parent1 \n\t 1. Child1 \n\t * Child2 \n 1. Parent2

Você pode aninhar listas ordenadas e não ordenadas juntas.You can nest ordered and unordered lists together. A guia \t, indica o nível de recuo do elemento filho.The tab, \t, indicates the indentation level of the child element.
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
formato da lista não ordenada aninhada
formato da lista ordenada aninhada

* QnA Maker não processa a imagem de forma alguma.*QnA Maker doesn't process the image in any way. É a função do aplicativo cliente para renderizar a imagem.It is the client application's role to render the image.

Se você deseja adicionar conteúdo usando atualizar/substituir APIs da base de conhecimento e o conteúdo/arquivo contém marcas HTML, você pode preservar o HTML em seu arquivo, garantindo que a abertura e o fechamento das marcas sejam convertidos no formato codificado.If you want to add content using update/replace knowledgebase APIs and the content/file contains html tags, you can preserve the HTML in your file by ensuring that opening and closing of the tags are converted in the encoded format.

Preservar HTMLPreserve HTML Representação na solicitação de APIRepresentation in the API request Representação em KBRepresentation in KB
SIMYes &lt; br&gt;&lt;br&gt; <br><br>
SIMYes &lt; H3&gt; header&lt;/H3&gt;&lt;h3&gt;header&lt;/h3&gt; <o cabeçalho>H3</H3><h3>header</h3>

Além disso, CR LF (\r\n) são convertidas em \n no KB.Additionally, CR LF(\r\n) are converted to \n in the KB. A LF (\n) é mantida como está.LF(\n) is kept as is. Se você quiser escapar qualquer sequência de escape como um \t ou \n, poderá usar uma barra invertida, por exemplo: '\\r\\n ' e '\\t 'If you want to escape any escape sequence like a \t or \n you can use backslash, for example: '\\r\\n' and '\\t'

Como editar sua base de dados de conhecimento localmenteEditing your knowledge base locally

Após criar uma base de conhecimento, é recomendável que você faça as edições no texto da base de conhecimento no portal QnA Maker, em vez de exportar e reimportar por meio de arquivos locais.Once a knowledge base is created, it is recommended that you make edits to the knowledge base text in the QnA Maker portal, rather than exporting and reimporting through local files. No entanto, pode haver ocasiões em que você precisa editar uma base de conhecimento localmente.However, there may be times that you need to edit a knowledge base locally.

Exporte a base de conhecimento na página Configurações e, em seguida, edite-a com o Microsoft Excel.Export the knowledge base from the Settings page, then edit the knowledge base with Microsoft Excel. Se você optar por usar outro aplicativo para editar o arquivo TSV exportado, o aplicativo pode introduzir erros de sintaxe porque não é totalmente compatível com TSV.If you choose to use another application to edit your exported TSV file, the application may introduce syntax errors because it is not fully TSV compliant. Em geral, os arquivos TSV do Microsoft Excel não introduzem nenhum erro de formatação.Microsoft Excel's TSV files generally don't introduce any formatting errors.

Depois de concluir as edições, reimporte o arquivo TSV na página Configurações.Once you are done with your edits, reimport the TSV file from the Settings page. Isso substitui totalmente a base de conhecimento atual pela base de conhecimento importada.This will completely replace the current knowledge base with the imported knowledge base.

Testar seu MarkdownTesting your Markdown

Use o tutorial CommonMark para validar seu Markdown.Use the CommonMark tutorial to validate your Markdown. O tutorial tem um recurso Experimentar para validação rápida de copiar/colar.The tutorial has a Try it feature for quick copy/paste validation.

Controle de versão para dados em sua base de conhecimentoVersion control for data in your knowledge base

O controle de versão para dados é fornecido por meio do recurso de importação/exportação na página configurações .Version control for data is provided through the import/export feature on the Settings page.

Próximos passosNext steps

ConsulteSee also

Visão geral do QnA MakerQnA Maker overview