Knowledgebase - Download

Télécharge la base de connaissances.

GET {Endpoint}/qnamaker/v4.0/knowledgebases/{kbId}/{environment}/qna

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).

environment
path True

Précise si l’environnement est Test ou Prod.

kbId
path True
  • string

Knowledgebase id.

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 tous les Q-A dans la base 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/9d091697-fb8c-4ed5-9ac0-35bf8273bfff/Test/qna
Ocp-Apim-Subscription-Key: {API key}

Sample Response

{
  "qnaDocuments": [
    {
      "id": 1,
      "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": [],
      "context": {
        "isContextOnly": false,
        "prompts": []
      }
    },
    {
      "id": 2,
      "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,
            "qnaId": 3,
            "displayText": "Update KB"
          }
        ]
      }
    },
    {
      "id": 3,
      "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",
      "source": "Editorial",
      "questions": [
        "How do I programmatically update my KB?"
      ],
      "metadata": [
        {
          "name": "category",
          "value": "api"
        }
      ],
      "context": {
        "isContextOnly": false,
        "prompts": [
          {
            "displayOrder": 1,
            "qnaId": 4,
            "displayText": "Refresh Endpoint Keys"
          }
        ]
      }
    },
    {
      "id": 4,
      "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",
      "source": "Editorial",
      "questions": [
        "How do I programmatically refresh endpoint keys?"
      ],
      "metadata": [],
      "context": {
        "isContextOnly": false,
        "prompts": []
      }
    }
  ]
}

Définitions

Context

Contexte d’un QnA

EnvironmentType

Précise si l’environnement est Test ou Prod.

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 - .

MetadataDTO

Nom - paire de métadonnées de valeur.

PromptDTO

Invitez-vous à obtenir une réponse.

Qna

QnADTO - QnaId ou QnADTO doit être présent dans un objet PromptDTO

QnADocumentsDTO

Liste des QnADTO

QnADTO

Objet Q-A.

Context

Contexte d’un QnA

Name Type Description
isContextOnly
  • boolean

Pour marquer si une invite n’est pertinente qu’avec une question précédente ou non. vrai - N’incluez pas cette QnA comme résultat de recherche pour les requêtes sans contexte faux - ignore le contexte et inclut ce QnA dans le résultat de recherche

prompts

Liste des invites associées à la réponse.

EnvironmentType

Précise si l’environnement est Test ou Prod.

Name Type Description
Prod
  • string
Test
  • string

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.

MetadataDTO

Nom - paire de métadonnées de valeur.

Name Type Description
name
  • string

nom des métadonnées.

value
  • string

valeur des métadonnées.

PromptDTO

Invitez-vous à obtenir une réponse.

Name Type Description
displayOrder
  • integer

Index de l’invite - utilisé dans l’ordre des invites

displayText
  • string

Texte affiché pour représenter une question de suivi prompte

qna

QnADTO - QnaId ou QnADTO doit être présent dans un objet PromptDTO

qnaId
  • integer

Qna id correspondant à l’invite - si QnaId est présent, QnADTO objet est ignoré.

Qna

QnADTO - QnaId ou QnADTO doit être présent dans un objet PromptDTO

QnADocumentsDTO

Liste des QnADTO

Name Type Description
qnaDocuments

Liste des réponses.

QnADTO

Objet Q-A.

Name Type Description
answer
  • string

Texte de réponse

context

Contexte d’un QnA

id
  • integer

Id unique pour le Q-A.

metadata

Liste des métadonnées associées à la réponse.

questions
  • string[]

Liste des questions associées à la réponse.

source
  • string

Source à partir de laquelle Q-A a été indexé. par exemple https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs