Knowledgebase - List All

Serviço:

Azure AI Services

Versão da API:

4.0

Obtém todas as bases de dados de conhecimento para um usuário.

GET {Endpoint}/qnamaker/v4.0/knowledgebases

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

Respostas

Nome	Tipo	Description
200 OK	KnowledgebasesDTO	Coleção de bases de dados de conhecimento.
Other Status Codes	ErrorResponse	Resposta de erro.

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

Exemplos

Successful query

Solicitação de exemplo

HTTP

GET {Endpoint}/qnamaker/v4.0/knowledgebases

Resposta de exemplo

Código de status:

200

{
  "knowledgebases": [
    {
      "id": "9d091697-fb8c-4ed5-9ac0-35bf8273bfff",
      "hostName": "https://myqnamakerbot.azurewebsites.net",
      "lastAccessedTimestamp": "2018-03-16T10:59:46Z",
      "lastChangedTimestamp": "2018-03-16T10:58:10Z",
      "lastPublishedTimestamp": "2018-03-16T10:59:56Z",
      "name": "My QnA Maker Bot",
      "userId": "03a4f4ce-30a6-4ec6-b436-02bcdf6153e1",
      "urls": [
        "https://docs.microsoft.com/en-in/azure/cognitive-services/qnamaker/faqs",
        "https://docs.microsoft.com/en-us/bot-framework/resources-bot-framework-faq"
      ],
      "sources": [
        "Custom Editorial",
        "SurfaceManual.pdf"
      ]
    }
  ]
}

Definições

Nome	Description
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.
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.
KnowledgebaseDTO	Esquema de resposta para a operação CreateKb.
KnowledgebasesDTO	Coleção de bases de dados de conhecimento pertencentes a um usuário.

Error

Objeto

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 ser humano do erro.
target	string	O destino do erro.

ErrorCodeType

Enumeração

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

Valor	Description
BadArgument
EndpointKeysError
ExtractionFailure
Forbidden
KbNotFound
NotFound
OperationNotFound
QnaRuntimeError
QuotaExceeded
SKULimitExceeded
ServiceError
Unauthorized
Unspecified
ValidationFailure

ErrorResponse

Objeto

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.

InnerErrorModel

Objeto

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.

KnowledgebaseDTO

Objeto

Esquema de resposta para a operação CreateKb.

Nome	Tipo	Description
hostName	string	Nome do host de URL no qual a base de dados de conhecimento está hospedada.
id	string	ID exclusiva que identifica uma base de dados de conhecimento.
lastAccessedTimestamp	string	Carimbo de data/hora em que a base de dados de conhecimento foi acessada pela última vez (UTC).
lastChangedTimestamp	string	Carimbo de data/hora no qual a base de dados de conhecimento foi modificada pela última vez (UTC).
lastPublishedTimestamp	string	Carimbo de data/hora em que a base de dados de conhecimento foi publicada pela última vez (UTC).
name	string	Nome amigável da base de dados de conhecimento.
sources	string[]	Fontes personalizadas das quais o Q-A foi extraído ou adicionado explicitamente à base de dados de conhecimento.
urls	string[]	Fontes de URL das quais o Q-A foi extraído e adicionado à base de dados de conhecimento.
userId	string	Usuário que criou/possui a base de dados de conhecimento.

KnowledgebasesDTO

Objeto

Coleção de bases de dados de conhecimento pertencentes a um usuário.

Nome	Tipo	Description
knowledgebases	KnowledgebaseDTO[]	Coleção de registros da base de dados de conhecimento.