Knowledgebase - Replace

Référence

Service:: Cognitive Services - QnA Maker

API Version:: v5.0-preview.2

Remplacez le contenu de la base de connaissances.

PUT {Endpoint}/qnamaker/v5.0-preview.2/knowledgebases/{kbId}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
Endpoint	path	True	string	Point de terminaison Cognitive Services pris en charge (par exemple, https://< qnamaker-resource-name >.api.cognitiveservices.azure.com).
kbId	path	True	string	ID de base de connaissances.

En-tête de la demande

Nom	Obligatoire	Type	Description
Ocp-Apim-Subscription-Key	True	string

Corps de la demande

Nom	Obligatoire	Type	Description
qnAList	True	QnADTO[]	Liste des Q-A (QnADTO) à ajouter à la base de connaissances. Les ID Q-R sont attribués par le service et doivent être omis.

Réponses

Nom	Type	Description
204 No Content		HTTP 204 Aucun contenu.
Other Status Codes	ErrorResponse	Réponse d’erreur.

Sécurité

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Exemples

Successful query

Sample Request

HTTP

PUT {Endpoint}/qnamaker/v5.0-preview.2/knowledgebases/9d091697-fb8c-4ed5-9ac0-35bf8273bfff


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

Status code:: 204

Définitions

Nom	Description
Context	Contexte associé à Qna à mettre à jour.
Error	Objet error. 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	Nom : paire valeur de métadonnées.
PromptDTO	Demander une réponse.
Qna	QnADTO : QnaId ou QnADTO doit être présent dans un objet PromptDTO
QnADTO	Objet Q-A.
ReplaceKbDTO	Schéma de post-corps pour l’opération De remplacement de la Base de connaissances.

Context

Contexte associé à Qna à mettre à jour.

Nom	Type	Description
isContextOnly	boolean	Pour marquer si une invite est pertinente uniquement avec une question précédente ou non. true : n’incluez pas ce QnA comme résultat de recherche pour les requêtes sans contexte false. Ignore le contexte et inclut ce QnA dans le résultat de la recherche
promptsToAdd	PromptDTO[]	Liste des invites à ajouter à la qna.
promptsToDelete	integer[]	Liste des invites associées à qna à supprimer

Error

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

Nom	Type	Description
code	ErrorCodeType	Un des ensembles de codes d’erreur définis par le serveur.
details	Error[]	Tableau de détails sur les erreurs spécifiques qui ont conduit à cette erreur signalée.
innerError	InnerErrorModel	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Représentation lisible de l’erreur.
target	string	Cible de l’erreur.

ErrorCodeType

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

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

Nom	Type	Description
error	Error	Objet error.

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.

Nom	Type	Description
code	string	Code d’erreur plus spécifique que celui fourni par l’erreur contenant.
innerError	InnerErrorModel	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.

MetadataDTO

Nom : paire valeur de métadonnées.

Nom	Type	Description
name	string	nom des métadonnées.
value	string	valeur des métadonnées.

PromptDTO

Demander une réponse.

Nom	Type	Description
displayOrder	integer	Index de l’invite : utilisé dans l’ordre des invites
displayText	string	Texte affiché pour représenter une invite de questions de suivi
qna	Qna	QnADTO : QnaId ou QnADTO doit être présent dans un objet PromptDTO
qnaId	integer	ID Qna correspondant à l’invite : si QnaId est présent, l’objet QnADTO est ignoré.

Qna

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

Nom	Type	Description
answer	string	Texte de réponse
context	Context	Contexte d’un QnA
id	integer	ID unique pour le Q-A.
lastUpdatedTimestamp	string	Horodatage de la dernière mise à jour du QnA.
metadata	MetadataDTO[]	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-R a été indexé. Eg. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

QnADTO

Objet Q-A.

Nom	Type	Description
answer	string	Texte de réponse
context	Context	Contexte d’un QnA
id	integer	ID unique pour le Q-A.
lastUpdatedTimestamp	string	Horodatage de la dernière mise à jour du QnA.
metadata	MetadataDTO[]	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-R a été indexé. Eg. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

ReplaceKbDTO

Schéma de post-corps pour l’opération De remplacement de la Base de connaissances.

Nom	Type	Description
qnAList	QnADTO[]	Liste des Q-A (QnADTO) à ajouter à la base de connaissances. Les ID Q-R sont attribués par le service et doivent être omis.

Share via