Knowledgebase - Create

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

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

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

Parâmetros do URI

Name Em Necessário Tipo Description
Endpoint
 path True

string

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

Cabeçalho do Pedido

Name Necessário Tipo Description
Ocp-Apim-Subscription-Key True

string

Corpo do Pedido

Name Necessário Tipo Description
name True

string

Nome amigável da base de dados de conhecimento.
defaultAnswer

string

Resposta predefinida enviada ao utilizador se não for encontrada uma boa correspondência na BDC.
defaultAnswerUsedForExtraction

string

Cadeia de texto a utilizar 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 está definido como Verdadeiro.
enableHierarchicalExtraction

boolean

Ativar a extração hierárquica de Q-A a partir de ficheiros e URLs. Valor a considerar Falso se este campo não estiver presente.
enableMultipleLanguages

boolean

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

FileDTO[]

Lista de ficheiros a partir dos quais extrair Q-A.
language

string

Idioma da base de dados de conhecimento. Localize a lista de idiomas suportados aqui.
qnaList

QnADTO[]

Lista de Q-A (QnADTO) a adicionar à base de dados de conhecimento. Os IDs de Q-A são atribuídos pelo serviço e devem ser omitidos.
urls

string[]

Lista de URLs a utilizar para extrair Q-A.

Respostas

Name 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

Name Description
Context

Contexto associado à Qna a atualizar.
CreateKbDTO

Pós-esquema do corpo para a operação CreateKb.
Error

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

Um dos conjuntos de códigos de erro definidos pelo servidor.
ErrorResponse

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

DTO para armazenar detalhes dos ficheiros carregados.
InnerErrorModel

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

Nome – par de valores de metadados.
Operation

Grave para controlar a operação de execução prolongada.
OperationStateType

Estado da operação.
PromptDTO

Pedir uma resposta.
Qna

QnADTO – QnaId ou QnADTO tem de estar presente num objeto PromptDTO
QnADTO

Objeto Q-A.

Context

Contexto associado à Qna a atualizar.

Name Tipo Description
isContextOnly

boolean

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

PromptDTO[]

Lista de pedidos a adicionar à qna.
promptsToDelete

integer[]

Lista de pedidos associados à qna a eliminar

CreateKbDTO

Pós-esquema do corpo para a operação CreateKb.

Name Tipo Description
defaultAnswer

string

Resposta predefinida enviada ao utilizador se não for encontrada uma boa correspondência na BDC.
defaultAnswerUsedForExtraction

string

Cadeia de texto a utilizar 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 está definido como Verdadeiro.
enableHierarchicalExtraction

boolean

Ativar a extração hierárquica de Q-A a partir de ficheiros e URLs. Valor a considerar Falso se este campo não estiver presente.
enableMultipleLanguages

boolean

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

FileDTO[]

Lista de ficheiros a partir dos quais extrair Q-A.
language

string

Idioma da base de dados de conhecimento. Localize a lista de idiomas suportados aqui.
name

string

Nome amigável da base de dados de conhecimento.
qnaList

QnADTO[]

Lista de Q-A (QnADTO) a adicionar à base de dados de conhecimento. Os IDs de Q-A são atribuídos pelo serviço e devem ser omitidos.
urls

string[]

Lista de URLs a utilizar para extrair Q-A.

Error

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

Name Tipo Description
code

ErrorCodeType

Um dos conjuntos de códigos de erro definidos pelo servidor.
details

Error[]

Uma série de detalhes sobre erros específicos que levaram a este erro comunicado.
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 por humanos do erro.
target

string

O destino do erro.

ErrorCodeType

Um dos conjuntos de códigos de erro definidos pelo servidor.

Name 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 Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name Tipo Description
error

Error

O objeto de erro.

FileDTO

DTO para armazenar detalhes dos ficheiros carregados.

Name Tipo Description
fileName

string

Nome do ficheiro. Os tipos de ficheiro suportados são ".tsv", ".pdf", ".txt", ".docx", ".xlsx".
fileUri

string

URI público do ficheiro.
isUnstructured

boolean

Sinalizador Opcional para especificar se o ficheiro especificado é Não Estruturado.

InnerErrorModel

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

Name Tipo Description
code

string

Um código de erro mais específico do que o 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.

Name Tipo Description
name

string

Nome dos metadados.
value

string

Valor de metadados.

Operation

Grave para controlar a operação de execução prolongada.

Name 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 introduzido.
operationId

string

ID da Operação.
operationState

OperationStateType

Estado da operação.
resourceLocation

string

URI relativo para a localização do recurso de destino para recursos concluídos.
userId

string

ID de Utilizador

OperationStateType

Estado da operação.

Name Tipo Description
Failed

string

NotStarted

string

Running

string

Succeeded

string

PromptDTO

Pedir uma resposta.

Name Tipo Description
displayOrder

integer

Índice da linha de comandos – utilizado na ordenação dos pedidos
displayText

string

Texto apresentado para representar um pedido de perguntas de seguimento
qna

Qna

QnADTO – QnaId ou QnADTO tem de estar presente num objeto PromptDTO
qnaId

integer

ID da Qna correspondente à linha de comandos – se qnaId estiver presente, o objeto QnADTO é ignorado.

Qna

QnADTO – QnaId ou QnADTO tem de estar presente num objeto PromptDTO

Name Tipo Description
answer

string

Mensagem escrita de resposta
context

Context

Contexto de um FAQ
id

integer

ID exclusivo da Q-A.
lastUpdatedTimestamp

string

Carimbo de data/hora quando o FAQ foi atualizado pela última vez.
metadata

MetadataDTO[]

Lista de metadados associados à resposta.
questions

string[]

Lista de perguntas associadas à resposta.
source

string

Origem a partir da qual a Q-A foi indexada. por exemplo, https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

QnADTO

Objeto Q-A.

Name Tipo Description
answer

string

Mensagem escrita de resposta
context

Context

Contexto de um FAQ
id

integer

ID exclusivo da Q-A.
lastUpdatedTimestamp

string

Carimbo de data/hora quando o FAQ foi atualizado pela última vez.
metadata

MetadataDTO[]

Lista de metadados associados à resposta.
questions

string[]

Lista de perguntas associadas à resposta.
source

string

Origem a partir da qual a Q-A foi indexada. por exemplo, https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs