Question Answering Projects - Update Qnas
Met à jour les QnAs d’un projet.
PATCH {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/qnas?api-version=2023-04-15-preview
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
project
|
path | True |
string |
Nom du projet à utiliser. |
api-version
|
query | True |
string |
Version de l’API cliente. |
Corps de la demande
Nom | Type | Description |
---|---|---|
body |
Mettez à jour les paramètres QnAs d’un projet. |
Réponses
Nom | Type | Description |
---|---|---|
202 Accepted |
Résultats de l’appel réussi avec un en-tête Operation-Location utilisé pour vérifier l’état du travail. En-têtes Operation-Location: string |
|
Other Status Codes |
Réponse d’erreur. |
Sécurité
AADToken
Il s’agit des flux Azure Active Directory OAuth2. Lorsqu’il est associé à 'accès en fonction du rôle Azure contrôle, il peut être utilisé pour contrôler l’accès aux API REST Azure Maps. Les contrôles d’accès en fonction du rôle Azure sont utilisés pour désigner l’accès à un ou plusieurs comptes de ressources Azure Maps ou sous-ressources. Tout utilisateur, groupe ou principal de service peut avoir accès via un rôle intégré ou un rôle personnalisé composé d’une ou plusieurs autorisations pour les API REST Azure Maps.
Pour implémenter des scénarios, nous vous recommandons d’afficher concepts d’authentification. En résumé, cette définition de sécurité fournit une solution pour la modélisation des applications via des objets capables de contrôler l’accès sur des API et des étendues spécifiques.
Notes
- Cette définition de sécurité nécessite l’utilisation de l’en-tête
x-ms-client-id
pour indiquer la ressource Azure Maps à laquelle l’application demande l’accès. Cela peut être acquis à partir de l’API de gestion Maps.
La Authorization URL
est spécifique à l’instance de cloud public Azure. Les clouds souverains ont des URL d’autorisation uniques et des configurations Azure Active Directory.
* Le contrôle d’accès en fonction du rôle Azure est configuré à partir de l'plan de gestion Azure via le portail Azure, PowerShell, l’interface CLI, les SDK Azure ou les API REST.
* L’utilisation du kit de développement logiciel (SDK) web Azure Maps permet la configuration basée sur la configuration d’une application pour plusieurs cas d’usage.
- Actuellement, Azure Active Directory v1.0 ou v2.0 prend en charge les comptes professionnels, scolaires et invités, mais ne prend pas en charge les comptes personnels.
Type:
oauth2
Flux:
implicit
URL d’autorisation:
https://login.microsoftonline.com/common/oauth2/authorize
Étendues
Nom | Description |
---|---|
https://cognitiveservices.azure.com/.default | https://cognitiveservices.azure.com/.default |
Ocp-Apim-Subscription-Key
Clé d’abonnement pour une ressource de service de langage.
Type:
apiKey
Dans:
header
Exemples
Successful query
Exemple de requête
PATCH {Endpoint}/language/authoring/query-knowledgebases/projects/proj1/qnas?api-version=2023-04-15-preview
[
{
"op": "add",
"value": {
"id": 3,
"answer": "ans3",
"source": "source1",
"questions": [
"question 3.1",
"question 3.2"
],
"metadata": {
"k1": "v1",
"k2": "v2"
},
"dialog": {
"isContextOnly": false,
"prompts": [
{
"displayOrder": 1,
"qnaId": 11,
"displayText": "prompt 3.1"
},
{
"displayOrder": 2,
"qnaId": 21,
"displayText": "prompt 3.2"
}
]
}
}
},
{
"op": "replace",
"value": {
"id": 1,
"answer": "ans4",
"source": "source1",
"questions": [
"question 4.1",
"question 4.2"
]
}
},
{
"op": "delete",
"value": {
"id": 2,
"answer": "ans2",
"source": "source1",
"questions": [
"question 2.1",
"question 2.2"
]
}
}
]
Exemple de réponse
Operation-Location: https:///language/authoring/query-knowledgebases/projects/proj1/qnas/jobs/job1?api-version=2023-04-15-preview
Définitions
Nom | Description |
---|---|
Error |
Objet d’erreur. |
Error |
Code d’erreur lisible par l’homme. |
Error |
Réponse d’erreur. |
Inner |
Code d’erreur lisible par l’homme. |
Inner |
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. |
Qna |
Boîte de dialogue associée à l’enregistrement QnA. |
Qna |
Demander une réponse. |
Qna |
Enregistrement QnA. |
Suggested |
Question suggérée par la fonctionnalité Active Learning. |
Suggested |
Informations sur le cluster questions suggérées pour l’apprentissage actif. |
update |
Mettre à jour le type d’opération pour les ressources. |
Update |
Enregistrement QnA à mettre à jour. |
Error
Objet d’erreur.
Nom | Type | Description |
---|---|---|
code |
Un ensemble de codes d’erreur définis par le serveur. |
|
details |
Error[] |
Tableau de détails sur des 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. |
ErrorCode
Code d’erreur lisible par l’homme.
Nom | Type | Description |
---|---|---|
AzureCognitiveSearchIndexLimitReached |
string |
|
AzureCognitiveSearchIndexNotFound |
string |
|
AzureCognitiveSearchNotFound |
string |
|
AzureCognitiveSearchThrottling |
string |
|
Conflict |
string |
|
Forbidden |
string |
|
InternalServerError |
string |
|
InvalidArgument |
string |
|
InvalidRequest |
string |
|
NotFound |
string |
|
OperationNotFound |
string |
|
ProjectNotFound |
string |
|
QuotaExceeded |
string |
|
ServiceUnavailable |
string |
|
Timeout |
string |
|
TooManyRequests |
string |
|
Unauthorized |
string |
|
Warning |
string |
ErrorResponse
Réponse d’erreur.
Nom | Type | Description |
---|---|---|
error |
Objet d’erreur. |
InnerErrorCode
Code d’erreur lisible par l’homme.
Nom | Type | Description |
---|---|---|
AzureCognitiveSearchNotFound |
string |
|
AzureCognitiveSearchThrottling |
string |
|
EmptyRequest |
string |
|
ExtractionFailure |
string |
|
InvalidCountryHint |
string |
|
InvalidDocument |
string |
|
InvalidDocumentBatch |
string |
|
InvalidParameterValue |
string |
|
InvalidRequest |
string |
|
InvalidRequestBodyFormat |
string |
|
KnowledgeBaseNotFound |
string |
|
MissingInputDocuments |
string |
|
ModelVersionIncorrect |
string |
|
UnsupportedLanguageCode |
string |
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 |
Un ensemble de codes d’erreur définis par le serveur. |
|
details |
object |
Détails de l’erreur. |
innererror |
Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur. |
|
message |
string |
Message d'erreur. |
target |
string |
Cible d’erreur. |
QnaDialog
Boîte de dialogue associée à l’enregistrement QnA.
Nom | Type | Description |
---|---|---|
isContextOnly |
boolean |
Marquer si une invite est pertinente uniquement avec une question précédente ou non. Si la valeur est true, n’incluez pas ce QnA comme réponse aux requêtes sans contexte ; sinon, ignore le contexte et inclut ce QnA dans les réponses. |
prompts |
Liste des invites associées à la réponse. |
QnaPrompt
Demander une réponse.
Nom | Type | Description |
---|---|---|
displayOrder |
integer |
Index de l’invite. Il est utilisé pour classer les invites. |
displayText |
string |
Texte affiché pour représenter une invite de questions de suivi. |
qna |
Enregistrement QnA. L’enregistrement QnAId ou QnA doit être présent dans une invite. |
|
qnaId |
integer |
ID du QnA correspondant à l’invite. |
QnaRecord
Enregistrement QnA.
Nom | Type | Description |
---|---|---|
activeLearningSuggestions |
Liste des suggestions d’apprentissage actif pour le QnA. |
|
answer |
string |
Texte de réponse. |
dialog |
Contexte d’un QnA. |
|
id |
integer |
ID unique pour le QnA. |
metadata |
object |
Métadonnées associées à la réponse, utiles pour catégoriser ou filtrer les réponses aux questions. |
questions |
string[] |
Liste des questions associées à la réponse. |
source |
string |
Source à partir de laquelle QnA a été indexé, par exemple https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs . |
SuggestedQuestion
Question suggérée par la fonctionnalité Active Learning.
Nom | Type | Description |
---|---|---|
autoSuggestedCount |
integer |
Nombre de fois où la question a été suggérée automatiquement par l’algorithme Active Learning. |
question |
string |
Question suggérée par la fonctionnalité Active Learning. |
userSuggestedCount |
integer |
Nombre de fois où la question a été suggérée explicitement par l’utilisateur. |
SuggestedQuestionsCluster
Informations sur le cluster questions suggérées pour l’apprentissage actif.
Nom | Type | Description |
---|---|---|
clusterHead |
string |
Question choisie comme responsable du cluster de questions suggérées par l’algorithme de clustering Active Learning. |
suggestedQuestions |
Liste de toutes les questions suggérées pour le QnA. |
updateOperationKind
Mettre à jour le type d’opération pour les ressources.
Nom | Type | Description |
---|---|---|
add |
string |
|
delete |
string |
|
replace |
string |
UpdateQnaRecord
Enregistrement QnA à mettre à jour.
Nom | Type | Description |
---|---|---|
op |
Mettre à jour le type d’opération pour les ressources. |
|
value |
Enregistrement QnA. |