Knowledgebase - Update

Référence

Service:: Cognitive Services - QnA Maker

API Version:: v5.0-preview.2

Opération asynchrone pour modifier une base de connaissances.

PATCH {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	Type	Description
add	Add	Instance de CreateKbInputDTO pour l’opération d’ajout
defaultAnswerUsedForExtraction	string	Chaîne de texte à utiliser comme réponse dans tout Q-A qui n’a pas de réponse extraite du document, mais qui a une hiérarchie. Obligatoire lorsque le champ EnableHierarchicalExtraction a la valeur True.
delete	Delete	Instance de DeleteKbContentsDTO pour l’opération de suppression
enableHierarchicalExtraction	boolean	Activer l’extraction hiérarchique de Q-A à partir de fichiers et d’URL. La valeur définie lors de la création de la base de connaissances sera utilisée si ce champ n’est pas présent.
update	Update	Instance de UpdateKbContentsDTO pour l’opération de mise à jour

Réponses

Nom	Type	Description
202 Accepted	Operation	Détails de l’opération asynchrone. Headers Location: string
Other Status Codes	ErrorResponse	Réponse d’erreur.

Nom

Type

Description

202 Accepted

Operation

Détails de l’opération asynchrone.

Headers

Location: string

Other Status Codes

ErrorResponse

Réponse d’erreur.

Sécurité

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Exemples

Successful query

Sample Request

HTTP

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


{
  "add": {
    "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": []
      }
    ],
    "urls": [
      "https://docs.microsoft.com/en-us/azure/cognitive-services/Emotion/FAQ"
    ],
    "files": [
      {
        "fileName": "SurfaceManual.pdf",
        "fileUri": "https://download.microsoft.com/download/2/9/B/29B20383-302C-4517-A006-B0186F04BE28/surface-pro-4-user-guide-EN.pdf"
      }
    ]
  },
  "delete": {
    "ids": [
      13,
      35
    ]
  },
  "update": {
    "name": "QnA Maker FAQ Prompts Bot",
    "qnaList": [
      {
        "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": {
          "add": [],
          "delete": []
        },
        "metadata": {
          "add": [],
          "delete": []
        },
        "context": {
          "isContextOnly": false,
          "promptsToAdd": [
            {
              "displayText": "Add Prompts",
              "displayOrder": 0,
              "qna": {
                "id": 0,
                "answer": "Click here to know more https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/how-to/multiturn-conversation",
                "source": "Editorial",
                "questions": [
                  "How can I add prompts?"
                ],
                "metadata": [],
                "context": {
                  "isContextOnly": false,
                  "prompts": []
                }
              },
              "qnaId": 0
            },
            {
              "displayText": "Delete Prompts",
              "displayOrder": 0,
              "qna": {
                "id": 0,
                "answer": "Click here to know more https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/how-to/multiturn-conversation",
                "source": "Editorial",
                "questions": [
                  "How can I delete delete prompts?"
                ],
                "metadata": [],
                "context": {
                  "isContextOnly": false,
                  "prompts": []
                }
              },
              "qnaId": 0
            },
            {
              "displayText": "Update Knowledgebase",
              "displayOrder": 0,
              "qna": null,
              "qnaId": 3
            }
          ],
          "promptsToDelete": [
            3
          ]
        }
      },
      {
        "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": "Custom Editorial",
        "questions": {
          "add": [],
          "delete": []
        },
        "metadata": {
          "delete": [
            {
              "name": "category",
              "value": "api"
            }
          ],
          "add": [
            {
              "name": "category",
              "value": "programmatic"
            }
          ]
        },
        "context": {
          "isContextOnly": false,
          "promptsToAdd": [
            {
              "displayText": "Regenerate Endpoint keys",
              "displayOrder": 1,
              "qna": null,
              "qnaId": 4
            }
          ],
          "promptsToDelete": [
            4
          ]
        }
      }
    ]
  }
}

Sample Response

Status code:: 202

{
  "operationState": "NotStarted",
  "createdTimestamp": "2018-03-19T07:38:46Z",
  "lastActionTimestamp": "2018-03-19T07:39:29Z",
  "userId": "86bb8390-56c0-42c2-9f81-3de161981191",
  "operationId": "03a4f4ce-30a6-4ec6-b436-02bcdf6153e1"
}

Définitions

Nom	Description
Add	Instance de CreateKbInputDTO pour l’opération d’ajout
Context	Contexte associé à Qna à mettre à jour.
Delete	Instance de DeleteKbContentsDTO pour l’opération de suppression
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.
FileDTO	DTO pour stocker les détails des fichiers chargés.
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.
Metadata	Liste des métadonnées associées à la réponse à mettre à jour
MetadataDTO	Nom : paire valeur de métadonnées.
Operation	Enregistrement pour suivre les opérations de longue durée.
OperationStateType	État de l’opération.
PromptDTO	Demander une réponse.
Qna	QnADTO : QnaId ou QnADTO doit être présent dans un objet PromptDTO
QnADTO	Objet Q-A.
Questions	Liste des questions associées à la réponse.
Update	Instance de UpdateKbContentsDTO pour l’opération de mise à jour
UpdateKbOperationDTO	Contient la liste des QNA à mettre à jour
UpdateQnaDTO	Schéma de corps PATCH pour mettre à jour la liste Qna

Add

Instance de CreateKbInputDTO pour l’opération d’ajout

Nom	Type	Description
files	FileDTO[]	Liste des fichiers à ajouter à la base de connaissances.
qnaList	QnADTO[]	Liste des QNA à ajouter à l’index. Les ID sont générés par le service et doivent être omis.
urls	string[]	Liste des URL à ajouter à 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

Delete

Instance de DeleteKbContentsDTO pour l’opération de suppression

Nom	Type	Description
ids	integer[]	Liste des ID Qna à supprimer
sources	string[]	Liste des sources à supprimer de la base de connaissances.

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.

FileDTO

DTO pour stocker les détails des fichiers chargés.

Nom	Type	Description
fileName	string	Nom du fichier. Les types de fichiers pris en charge sont « .tsv », « .pdf », « .txt », « .docx », « .xlsx ».
fileUri	string	URI public du fichier.
isUnstructured	boolean	Indicateur facultatif pour spécifier si le fichier donné est non structuré.

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.

Metadata

Liste des métadonnées associées à la réponse à mettre à jour

Nom	Type	Description
add	MetadataDTO[]	Liste des métadonnées associées à la réponse à ajouter
delete	MetadataDTO[]	Liste des métadonnées associées à la réponse à supprimer

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.

Operation

Enregistrement pour suivre les opérations de longue durée.

Nom	Type	Description
createdTimestamp	string	Horodatage de la création de l’opération.
errorResponse	ErrorResponse	Détails de l’erreur en cas de défaillance.
lastActionTimestamp	string	Horodatage lorsque l’état actuel a été entré.
operationId	string	ID d'opération.
operationState	OperationStateType	État de l’opération.
resourceLocation	string	URI relatif à l’emplacement de ressource cible pour les ressources terminées.
userId	string	User Id

OperationStateType

État de l’opération.

Nom	Type	Description
Failed	string
NotStarted	string
Running	string
Succeeded	string

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

Questions

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

Nom	Type	Description
add	string[]	Liste de questions à ajouter
delete	string[]	Liste de questions à supprimer.

Update

Instance de UpdateKbContentsDTO pour l’opération de mise à jour

Nom	Type	Description
defaultAnswer	string	Réponse par défaut envoyée à l’utilisateur si aucune correspondance correcte n’est trouvée dans la base de connaissances.
name	string	Nom convivial de la base de connaissances.
qnaList	UpdateQnaDTO[]	Liste des questions-réponses (UpdateQnaDTO) à ajouter à la base de connaissances.
urls	string[]	Liste des URL existantes à actualiser. Le contenu sera extrait à nouveau et réindexé.

UpdateKbOperationDTO

Contient la liste des QNA à mettre à jour

Nom	Type	Description
add	Add	Instance de CreateKbInputDTO pour l’opération d’ajout
defaultAnswerUsedForExtraction	string	Chaîne de texte à utiliser comme réponse dans tout Q-A qui n’a pas de réponse extraite du document, mais qui a une hiérarchie. Obligatoire lorsque le champ EnableHierarchicalExtraction a la valeur True.
delete	Delete	Instance de DeleteKbContentsDTO pour l’opération de suppression
enableHierarchicalExtraction	boolean	Activer l’extraction hiérarchique de Q-A à partir de fichiers et d’URL. La valeur définie lors de la création de la base de connaissances sera utilisée si ce champ n’est pas présent.
update	Update	Instance de UpdateKbContentsDTO pour l’opération de mise à jour

UpdateQnaDTO

Schéma de corps PATCH pour mettre à jour la liste Qna

Nom	Type	Description
answer	string	Texte de réponse
context	Context	Contexte associé à Qna à mettre à jour.
id	integer	ID unique pour le Q-R
metadata	Metadata	Liste des métadonnées associées à la réponse à mettre à jour
questions	Questions	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

Knowledgebase - Update

Paramètres URI

En-tête de la demande

Corps de la demande

Réponses

Sécurité

Ocp-Apim-Subscription-Key

Exemples

Successful query

Sample Request

Sample Response

Définitions

Add

Context

Delete

Error

ErrorCodeType

ErrorResponse

FileDTO

InnerErrorModel

Metadata

MetadataDTO

Operation

OperationStateType

PromptDTO

Qna

QnADTO

Questions

Update

UpdateKbOperationDTO

UpdateQnaDTO

Ressources supplémentaires