Knowledgebase - Create
Opération asynchrone permettant de créer une base de connaissances.
POST {Endpoint}/qnamaker/v5.0-preview.2/knowledgebases/create
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). |
En-tête de la demande
Nom | Obligatoire | Type | Description |
---|---|---|---|
Ocp-Apim-Subscription-Key | True |
string |
Corps de la demande
Nom | Obligatoire | Type | Description |
---|---|---|---|
name | True |
string |
Nom convivial de la base de connaissances. |
defaultAnswer |
string |
Réponse par défaut envoyée à l’utilisateur si aucune correspondance correcte n’est trouvée dans la base de connaissances. |
|
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. |
|
enableHierarchicalExtraction |
boolean |
Activez l’extraction hiérarchique de Q-A à partir de fichiers et d’URL. Valeur à considérer comme False si ce champ n’est pas présent. |
|
enableMultipleLanguages |
boolean |
Définissez sur true pour activer la création de ko dans différentes langues pour la même ressource. |
|
files |
FileDTO[] |
Liste des fichiers à partir desquels extraire des Q-A. |
|
language |
string |
Langue de la base de connaissances. Vous trouverez la liste des langues prises en charge ici. |
|
qnaList |
QnADTO[] |
Liste des Q-A (QnADTO) à ajouter à la base de connaissances. Les ID Q-A sont attribués par le service et doivent être omis. |
|
urls |
string[] |
Liste des URL à utiliser pour l’extraction de Q-A. |
Réponses
Nom | 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/v5.0-preview.2/knowledgebases/create
{
"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
Nom | Description |
---|---|
Context |
Contexte associé à Qna à mettre à jour. |
Create |
Post-schéma de corps pour l’opération CreateKb. |
Error |
Objet d’erreur. Conformément aux instructions relatives à l’API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
Error |
Un des codes d’erreur définis par le serveur. |
Error |
Réponse d’erreur. Conformément aux instructions relatives à l’API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
FileDTO |
DTO pour contenir les détails des fichiers chargés. |
Inner |
Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux instructions relatives à 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. |
Operation |
Enregistrez pour suivre les opérations de longue durée. |
Operation |
É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. |
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 |
Liste des invites à ajouter au qna. |
|
promptsToDelete |
integer[] |
Liste des invites associées à qna à supprimer |
CreateKbDTO
Post-schéma de corps pour l’opération CreateKb.
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. |
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. |
enableHierarchicalExtraction |
boolean |
Activez l’extraction hiérarchique de Q-A à partir de fichiers et d’URL. Valeur à considérer comme False si ce champ n’est pas présent. |
enableMultipleLanguages |
boolean |
Définissez sur true pour activer la création de ko dans différentes langues pour la même ressource. |
files |
FileDTO[] |
Liste des fichiers à partir desquels extraire des Q-A. |
language |
string |
Langue de la base de connaissances. Vous trouverez la liste des langues prises en charge ici. |
name |
string |
Nom convivial de la base de connaissances. |
qnaList |
QnADTO[] |
Liste des Q-A (QnADTO) à ajouter à la base de connaissances. Les ID Q-A sont attribués par le service et doivent être omis. |
urls |
string[] |
Liste des URL à utiliser pour l’extraction de Q-A. |
Error
Objet d’erreur. Conformément aux instructions relatives à l’API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Nom | Type | Description |
---|---|---|
code |
Un des 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 |
Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur. |
|
message |
string |
Représentation lisible par l’homme de l’erreur. |
target |
string |
Cible de l’erreur. |
ErrorCodeType
Un des 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 relatives à l’API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Nom | Type | Description |
---|---|---|
error |
Objet d’erreur. |
FileDTO
DTO pour contenir 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 relatives à l’API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Nom | Type | Description |
---|---|---|
code |
string |
Un code d’erreur plus spécifique que celui fourni par l’erreur contenante. |
innerError |
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. |
Operation
Enregistrez pour suivre les opérations de longue durée.
Nom | Type | Description |
---|---|---|
createdTimestamp |
string |
Horodatage lors de la création de l’opération. |
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 |
É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 |
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 |
Contexte d’un QnA |
|
id |
integer |
ID unique pour le Q-A. |
lastUpdatedTimestamp |
string |
Horodatage de la dernière mise à jour du QnA. |
metadata |
Liste des métadonnées associées à la réponse. |
|
questions |
string[] |
Liste de questions associées à la réponse. |
source |
string |
Source à partir de laquelle Q-A 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 |
Contexte d’un QnA |
|
id |
integer |
ID unique pour le Q-A. |
lastUpdatedTimestamp |
string |
Horodatage de la dernière mise à jour du QnA. |
metadata |
Liste des métadonnées associées à la réponse. |
|
questions |
string[] |
Liste de questions associées à la réponse. |
source |
string |
Source à partir de laquelle Q-A a été indexé. Eg. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs |