Knowledgebase - Replace

Remplacez le contenu de la base de connaissances.

PUT {Endpoint}/qnamaker/v4.0/knowledgebases/{kbId}

Paramètres URI

Name In Required Type Description
Endpoint
path True
  • string

Points de terminaison de Cognitive Services pris en charge (protocole et nom d’hôte, par exemple : https://westus.api.cognitive.microsoft.com) .

kbId
path True
  • string

ID de la base de connaissances.

En-tête de la demande

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

Corps de la demande

Name Required Type Description
qnAList True

Liste de Q-A (QnADTO) à ajouter à la base de connaissances. Q : les ID ont été affectés par le service et doivent être omis.

Réponses

Name Type Description
204 No Content

HTTP 204 aucun contenu.

Other Status Codes

Réponse d’erreur.

Sécurité

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Exemples

Successful query

Sample Request

PUT {Endpoint}/qnamaker/v4.0/knowledgebases/9d091697-fb8c-4ed5-9ac0-35bf8273bfff
Ocp-Apim-Subscription-Key: {API key}
{
  "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"
        }
      ]
    }
  ]
}

Sample Response

Définitions

Context

Contexte d’un QnA

Error

Objet d’erreur. Conformément aux instructions de l’API Microsoft One- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses .

ErrorCodeType

Un des ensembles de codes d’erreur définis par le serveur.

ErrorResponse

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

InnerErrorModel

Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux instructions de l’API Microsoft One- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses .

MetadataDTO

Paire nom-valeur de métadonnées.

PromptDTO

Demander une réponse.

Qna

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

QnADTO

Q : objet.

ReplaceKbDTO

Publication du schéma de corps pour l’opération de remplacement de Ko.

Context

Contexte d’un QnA

Name Type Description
isContextOnly
  • boolean

Pour marquer si une invite est pertinente uniquement avec une question précédente. true : n’incluez pas ce QnA comme résultat de la recherche pour les requêtes sans le contexte false-ignore le contexte et inclut ce QnA dans le résultat de la recherche

prompts

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

Error

Objet d’erreur. Conformément aux instructions de l’API Microsoft One- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses .

Name Type Description
code

Un des ensembles de codes d’erreur définis par le serveur.

details

Tableau de détails sur les erreurs spécifiques qui ont conduit à cette erreur signalée.

innerError

Objet contenant des informations plus spécifiques que l’objet en cours à propos de l’erreur.

message
  • string

Représentation explicite de l’erreur.

target
  • string

Cible de l’erreur.

ErrorCodeType

Un des ensembles de 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 instructions de l’API Microsoft One- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses .

Name Type Description
error

Objet d’erreur.

InnerErrorModel

Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux instructions de l’API Microsoft One- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses .

Name Type Description
code
  • string

Code d’erreur plus spécifique que celui fourni par l’erreur conteneur.

innerError

Objet contenant des informations plus spécifiques que l’objet en cours à propos de l’erreur.

MetadataDTO

Paire nom-valeur de métadonnées.

Name Type Description
name
  • string

nom des métadonnées.

value
  • string

valeur des métadonnées.

PromptDTO

Demander une réponse.

Name Type Description
displayOrder
  • integer

Index de l’invite utilisée pour l’ordre des invites

displayText
  • string

Texte affiché pour représenter une invite de questions de suivi

qna

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

qnaId
  • integer

L’ID QnA correspondant à l’invite-if QnaId est présent, l’objet QnADTO est ignoré.

Qna

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

QnADTO

Q : objet.

Name Type Description
answer
  • string

Texte de réponse

context

Contexte d’un QnA

id
  • integer

ID unique pour le lecteur 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

ReplaceKbDTO

Publication du schéma de corps pour l’opération de remplacement de Ko.

Name Type Description
qnAList

Liste de Q-A (QnADTO) à ajouter à la base de connaissances. Q : les ID ont été affectés par le service et doivent être omis.