Knowledgebase - Create

Opération asynchrone permettant de créer une base de connaissances.

POST {Endpoint}/qnamaker/v4.0/knowledgebases/create

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

Corps de la demande

Name Required Type Description
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 a une hiérarchie. Nécessaire lorsque enableHierarchicalExtraction champ est réglé à Vrai.

enableHierarchicalExtraction
  • boolean

Activez l’extraction hiérarchique de Q-A à partir de fichiers et d’urls. Valeur à considérer comme faux si ce champ n’est pas présent.

files

Liste des fichiers à partir desquels extraire Q-A.

language
  • string

Langue de la base de connaissances.

name True
  • string

Nom amical pour la base de connaissances.

qnaList

Liste des Q-A (QnADTO) à ajouter à la base de connaissances. Les ids Q-A sont attribués par le service et doivent être omis.

urls
  • string[]

Liste des URL à utiliser pour extraire Q-A.

Réponses

Name Type Description
202 Accepted

Détails de l’opération asynchrone.

Other Status Codes

Réponse d’erreur.

Sécurité

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Exemples

Successful query

Sample Request

POST {Endpoint}/qnamaker/v4.0/knowledgebases/create
Ocp-Apim-Subscription-Key: {API key}
{
  "name": "QnA Maker FAQ",
  "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"
        }
      ],
      "context": {
        "isContextOnly": false,
        "prompts": [
          {
            "displayOrder": 1,
            "displayText": "Update KB",
            "qna": {
              "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",
              "questions": [
                "How do I programmatically update my KB?"
              ],
              "metadata": [
                {
                  "name": "category",
                  "value": "api"
                }
              ],
              "context": {
                "isContextOnly": false,
                "prompts": [
                  {
                    "displayOrder": 1,
                    "displayText": "Refresh Endpoint Keys",
                    "qna": {
                      "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",
                      "questions": [
                        "How do I programmatically refresh endpoint keys?"
                      ]
                    }
                  }
                ]
              }
            }
          }
        ]
      }
    }
  ],
  "urls": [
    "https://docs.microsoft.com/en-in/azure/cognitive-services/qnamaker/faqs",
    "https://docs.microsoft.com/en-us/bot-framework/resources-bot-framework-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"
    }
  ]
}

Sample Response

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

Context

Contexte d’un QnA

CreateKbDTO

Schéma de corps de poteau pour l’opération De CreateKb.

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

FileDTO

DTO pour conserver les détails des fichiers téléchargés.

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.

Operation

Enregistrement pour suivre l’opération de longue durée.

OperationStateType

État de l’opération.

PromptDTO

Invitez-vous à obtenir une réponse.

Qna

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

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.

CreateKbDTO

Schéma de corps de poteau pour l’opération De CreateKb.

Name Type Description
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 a une hiérarchie. Nécessaire lorsque enableHierarchicalExtraction champ est réglé à Vrai.

enableHierarchicalExtraction
  • boolean

Activez l’extraction hiérarchique de Q-A à partir de fichiers et d’urls. Valeur à considérer comme faux si ce champ n’est pas présent.

files

Liste des fichiers à partir desquels extraire Q-A.

language
  • string

Langue de la base de connaissances.

name
  • string

Nom amical pour la base de connaissances.

qnaList

Liste des Q-A (QnADTO) à ajouter à la base de connaissances. Les ids Q-A sont attribués par le service et doivent être omis.

urls
  • string[]

Liste des URL à utiliser pour extraire Q-A.

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.

FileDTO

DTO pour conserver les détails des fichiers téléchargés.

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

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.

Operation

Enregistrement pour suivre l’opération de longue durée.

Name Type Description
createdTimestamp
  • string

Timestamp lors de la création de l’opération.

errorResponse

Détails d’erreur en cas d’échecs.

lastActionTimestamp
  • string

Timestamp quand l’état actuel a été entré.

operationId
  • string

ID d'opération.

operationState

État de l’opération.

resourceLocation
  • string

RELATIVE URI à l’emplacement cible des ressources pour les ressources terminées.

userId
  • string

User Id

OperationStateType

État de l’opération.

Name Type Description
Failed
  • string
NotStarted
  • string
Running
  • string
Succeeded
  • string

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

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