Knowledgebase - Create

  • Referência
Service:
Cognitive Services - QnA Maker
API Version:
v5.0-preview.2

Operação assíncrona para criar uma base de dados de conhecimento.

POST {Endpoint}/qnamaker/v5.0-preview.2/knowledgebases/create

Parâmetros de URI

Nome Em Obrigatório Tipo Description
Endpoint
 path True

string

Ponto de extremidade dos Serviços Cognitivos com suporte (por exemplo, https://< qnamaker-resource-name >.api.cognitiveservices.azure.com).

Cabeçalho da solicitação

Nome Obrigatório Tipo Description
Ocp-Apim-Subscription-Key True

string

Corpo da solicitação

Nome Obrigatório Tipo Description
name True

string

Nome amigável para a base de dados de conhecimento.
defaultAnswer

string

Resposta padrão enviada ao usuário se nenhuma boa correspondência for encontrada no KB.
defaultAnswerUsedForExtraction

string

Cadeia de caracteres de texto a ser usada como resposta em qualquer Q-A que não tenha resposta extraída do documento, mas que tenha uma hierarquia. Necessário quando o campo EnableHierarchicalExtraction é definido como True.
enableHierarchicalExtraction

boolean

Habilite a extração hierárquica de Q-A de arquivos e urls. Valor a ser considerado False se este campo não estiver presente.
enableMultipleLanguages

boolean

Defina como true para habilitar a criação de KBs em idiomas diferentes para o mesmo recurso.
files

FileDTO[]

Lista de arquivos dos quais extrair Q-A.
language

string

Linguagem da base de dados de conhecimento. Localize a lista de idiomas com suporte aqui.
qnaList

QnADTO[]

Lista de QnADTO (QnADTO) a serem adicionados à base de dados de conhecimento. As IDs de Q-A são atribuídas pelo serviço e devem ser omitidas.
urls

string[]

Lista de URLs a serem usadas para extrair Q-A.

Respostas

Nome Tipo Description
202 Accepted

Operation

Detalhes da operação assíncrona.
Other Status Codes

ErrorResponse

Resposta de erro.

Segurança

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Exemplos

Successful query

Sample Request

POST {Endpoint}/qnamaker/v5.0-preview.2/knowledgebases/create


{
  "name": "QnA Maker FAQ",
  "qnaList": [
    {
      "id": 0,
      "answer": "You can change the default message if you use the QnAMakerDialog. See this for details: https://docs.botframework.com/en-us/azure-bot-service/templates/qnamaker/#navtitle",
      "source": "Custom Editorial",
      "questions": [
        "How can I change the default message from QnA Maker?"
      ],
      "metadata": []
    },
    {
      "id": 0,
      "answer": "You can use our REST apis to create a KB. See here for details: https://docs.microsoft.com/en-us/rest/api/cognitiveservices/qnamaker/knowledgebase/create",
      "source": "Custom Editorial",
      "questions": [
        "How do I programmatically create a KB?"
      ],
      "metadata": [
        {
          "name": "category",
          "value": "api"
        }
      ],
      "context": {
        "isContextOnly": false,
        "prompts": [
          {
            "displayOrder": 1,
            "displayText": "Update KB",
            "qna": {
              "answer": "You can use our REST apis to update your KB. See here for details: https://docs.microsoft.com/en-us/rest/api/cognitiveservices/qnamaker/knowledgebase/update",
              "questions": [
                "How do I programmatically update my KB?"
              ],
              "metadata": [
                {
                  "name": "category",
                  "value": "api"
                }
              ],
              "context": {
                "isContextOnly": false,
                "prompts": [
                  {
                    "displayOrder": 1,
                    "displayText": "Refresh Endpoint Keys",
                    "qna": {
                      "answer": "You can use our REST apis to refresh endpoint keys. See here for details: https://docs.microsoft.com/en-us/rest/api/cognitiveservices/qnamaker/endpointkeys/refreshkeys",
                      "questions": [
                        "How do I programmatically refresh endpoint keys?"
                      ]
                    }
                  }
                ]
              }
            }
          }
        ]
      }
    }
  ],
  "urls": [
    "https://docs.microsoft.com/en-in/azure/cognitive-services/qnamaker/faqs",
    "https://docs.microsoft.com/en-us/bot-framework/resources-bot-framework-faq"
  ],
  "files": [
    {
      "fileName": "SurfaceManual.pdf",
      "fileUri": "https://download.microsoft.com/download/2/9/B/29B20383-302C-4517-A006-B0186F04BE28/surface-pro-4-user-guide-EN.pdf"
    }
  ]
}

Sample Response

Status code:
202 
{
  "operationState": "NotStarted",
  "createdTimestamp": "2018-03-19T07:38:46Z",
  "lastActionTimestamp": "2018-03-19T07:39:29Z",
  "userId": "86bb8390-56c0-42c2-9f81-3de161981191",
  "operationId": "03a4f4ce-30a6-4ec6-b436-02bcdf6153e1"
}

Definições

Nome Description
Context

Contexto associado ao Qna a ser atualizado.
CreateKbDTO

Esquema pós-corpo para a operação CreateKb.
Error

O objeto de erro. De acordo com as diretrizes da API do Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ErrorCodeType

Um de um conjunto definido pelo servidor de códigos de erro.
ErrorResponse

Resposta de erro. De acordo com as diretrizes da API do Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
FileDTO

DTO para armazenar detalhes dos arquivos carregados.
InnerErrorModel

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
MetadataDTO

Nome – par de valores de metadados.
Operation

Registre para acompanhar a operação de execução prolongada.
OperationStateType

Estado da operação.
PromptDTO

Solicite uma resposta.
Qna

QnADTO - QnaId ou QnADTO precisa estar presente em um objeto PromptDTO
QnADTO

Objeto Q-A.

Context

Contexto associado ao Qna a ser atualizado.

Nome Tipo Description
isContextOnly

boolean

Para marcar se um prompt é relevante apenas com uma pergunta anterior ou não. true – Não inclua esse QnA como resultado da pesquisa para consultas sem contexto falso – ignora o contexto e inclui esse QnA no resultado da pesquisa
promptsToAdd

PromptDTO[]

Lista de prompts a serem adicionados ao qna.
promptsToDelete

integer[]

Lista de prompts associados a qna a serem excluídos

CreateKbDTO

Esquema pós-corpo para a operação CreateKb.

Nome Tipo Description
defaultAnswer

string

Resposta padrão enviada ao usuário se nenhuma boa correspondência for encontrada no KB.
defaultAnswerUsedForExtraction

string

Cadeia de caracteres de texto a ser usada como resposta em qualquer Q-A que não tenha resposta extraída do documento, mas que tenha uma hierarquia. Necessário quando o campo EnableHierarchicalExtraction é definido como True.
enableHierarchicalExtraction

boolean

Habilite a extração hierárquica de Q-A de arquivos e urls. Valor a ser considerado False se este campo não estiver presente.
enableMultipleLanguages

boolean

Defina como true para habilitar a criação de KBs em idiomas diferentes para o mesmo recurso.
files

FileDTO[]

Lista de arquivos dos quais extrair Q-A.
language

string

Linguagem da base de dados de conhecimento. Localize a lista de idiomas com suporte aqui.
name

string

Nome amigável para a base de dados de conhecimento.
qnaList

QnADTO[]

Lista de QnADTO (QnADTO) a serem adicionados à base de dados de conhecimento. As IDs de Q-A são atribuídas pelo serviço e devem ser omitidas.
urls

string[]

Lista de URLs a serem usadas para extrair Q-A.

Error

O objeto de erro. De acordo com as diretrizes da API do Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nome Tipo Description
code

ErrorCodeType

Um de um conjunto definido pelo servidor de códigos de erro.
details

Error[]

Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innerError

InnerErrorModel

Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message

string

Uma representação legível pelo homem do erro.
target

string

O destino do erro.

ErrorCodeType

Um de um conjunto definido pelo servidor de códigos de erro.

Nome Tipo Description
BadArgument

string

EndpointKeysError

string

ExtractionFailure

string

Forbidden

string

KbNotFound

string

NotFound

string

OperationNotFound

string

QnaRuntimeError

string

QuotaExceeded

string

SKULimitExceeded

string

ServiceError

string

Unauthorized

string

Unspecified

string

ValidationFailure

string

ErrorResponse

Resposta de erro. De acordo com as diretrizes da API do Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nome Tipo Description
error

Error

O objeto de erro.

FileDTO

DTO para armazenar detalhes dos arquivos carregados.

Nome Tipo Description
fileName

string

Nome do arquivo. Os tipos de arquivo com suporte são ".tsv", ".pdf", ".txt", ".docx", ".xlsx".
fileUri

string

URI público do arquivo.
isUnstructured

boolean

Sinalizador opcional para especificar se o arquivo especificado não está estruturado.

InnerErrorModel

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nome Tipo Description
code

string

Um código de erro mais específico do que foi fornecido pelo erro que contém.
innerError

InnerErrorModel

Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.

MetadataDTO

Nome – par de valores de metadados.

Nome Tipo Description
name

string

nome dos metadados.
value

string

valor dos metadados.

Operation

Registre para acompanhar a operação de execução prolongada.

Nome Tipo Description
createdTimestamp

string

Carimbo de data/hora quando a operação foi criada.
errorResponse

ErrorResponse

Detalhes do erro em caso de falhas.
lastActionTimestamp

string

Carimbo de data/hora quando o estado atual foi inserido.
operationId

string

ID da Operação.
operationState

OperationStateType

Estado da operação.
resourceLocation

string

URI relativo ao local do recurso de destino para recursos concluídos.
userId

string

Id de usuário

OperationStateType

Estado da operação.

Nome Tipo Description
Failed

string

NotStarted

string

Running

string

Succeeded

string

PromptDTO

Solicite uma resposta.

Nome Tipo Description
displayOrder

integer

Índice do prompt – usado na ordenação dos prompts
displayText

string

Texto exibido para representar um prompt de pergunta de acompanhamento
qna

Qna

QnADTO - QnaId ou QnADTO precisa estar presente em um objeto PromptDTO
qnaId

integer

ID de Qna correspondente ao prompt – se QnaId estiver presente, o objeto QnADTO será ignorado.

Qna

QnADTO - QnaId ou QnADTO precisa estar presente em um objeto PromptDTO

Nome Tipo Description
answer

string

Texto de resposta
context

Context

Contexto de um QnA
id

integer

ID exclusiva para o Q-A.
lastUpdatedTimestamp

string

Carimbo de data/hora em que o QnA foi atualizado pela última vez.
metadata

MetadataDTO[]

Lista de metadados associados à resposta.
questions

string[]

Lista de perguntas associadas à resposta.
source

string

Origem da qual o Q-A foi indexado. Eg. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

QnADTO

Objeto Q-A.

Nome Tipo Description
answer

string

Texto de resposta
context

Context

Contexto de um QnA
id

integer

ID exclusiva para o Q-A.
lastUpdatedTimestamp

string

Carimbo de data/hora em que o QnA foi atualizado pela última vez.
metadata

MetadataDTO[]

Lista de metadados associados à resposta.
questions

string[]

Lista de perguntas associadas à resposta.
source

string

Origem da qual o Q-A foi indexado. Eg. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs