Knowledgebase - List All

Obtient toutes les bases de connaissances pour un utilisateur.

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

Paramètres URI

Name In Required Type Description
Endpoint
path True
  • string

Points de terminaison supportés des services cognitifs (protocole et nom d’hôte, par exemple : https://westus.api.cognitive.microsoft.com).

En-tête de la demande

Name Required Type Description
Ocp-Apim-Subscription-Key True
  • string

Réponses

Name Type Description
200 OK

Collection de bases de connaissances.

Other Status Codes

Réponse d’erreur.

Sécurité

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Exemples

Successful query

Sample Request

GET {Endpoint}/qnamaker/v4.0/knowledgebases
Ocp-Apim-Subscription-Key: {API key}

Sample Response

{
  "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"
      ]
    }
  ]
}

Définitions

Error

L’objet d’erreur. Conformément aux lignes directrices https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responsesde Microsoft One API - .

ErrorCodeType

L’un des codes d’erreur définis par le serveur.

ErrorResponse

Réponse d’erreur. Conformément aux lignes directrices https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responsesde Microsoft One API - .

InnerErrorModel

Un objet contenant des informations plus spécifiques sur l’erreur. Conformément aux lignes directrices https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responsesde Microsoft One API - .

KnowledgebaseDTO

Schéma de réponse pour l’opération CreateKb.

KnowledgebasesDTO

Collection de bases de connaissances appartenant à un utilisateur.

Error

L’objet d’erreur. Conformément aux lignes directrices https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responsesde Microsoft One API - .

Name Type Description
code

L’un des codes d’erreur définis par le serveur.

details

Un éventail de détails sur des erreurs spécifiques qui ont conduit à cette erreur signalée.

innerError

Un objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.

message
  • string

Une représentation lisible par l’homme de l’erreur.

target
  • string

La cible de l’erreur.

ErrorCodeType

L’un des codes d’erreur définis par le serveur.

Name Type 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

Réponse d’erreur. Conformément aux lignes directrices https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responsesde Microsoft One API - .

Name Type Description
error

L’objet d’erreur.

InnerErrorModel

Un objet contenant des informations plus spécifiques sur l’erreur. Conformément aux lignes directrices https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responsesde Microsoft One API - .

Name Type Description
code
  • string

Un code d’erreur plus spécifique que celui fourni par l’erreur de confinement.

innerError

Un objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.

KnowledgebaseDTO

Schéma de réponse pour l’opération CreateKb.

Name Type Description
hostName
  • string

Nom d’hôte URL à laquelle la base de connaissances est hébergée.

id
  • string

Id unique qui identifie une base de connaissances.

lastAccessedTimestamp
  • string

Timbre d’heure auquel la base de connaissances a été accessible pour la dernière fois (UTC).

lastChangedTimestamp
  • string

Timbre d’heure auquel la base de connaissances a été modifiée pour la dernière fois (UTC).

lastPublishedTimestamp
  • string

Timbre d’heure auquel la base de connaissances a été publiée pour la dernière fois (UTC).

name
  • string

Nom ami de la base de connaissances.

sources
  • string[]

Des sources personnalisées à partir desquelles Q-A ont été extraites ou explicitement ajoutées à la base de connaissances.

urls
  • string[]

Sources d’URL à partir desquelles Q-A ont été extraits et ajoutés à la base de connaissances.

userId
  • string

Utilisateur qui a créé / possède la base de connaissances.

KnowledgebasesDTO

Collection de bases de connaissances appartenant à un utilisateur.

Name Type Description
knowledgebases

Collection de documents de base de connaissances.