Partager via

Question Answering Projects - Update Qnas

  • Référence
Service:
Cognitive Services - Language
Version d'API:
2023-04-01

Mises à jour les QnA d’un projet.

PATCH {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/qnas?api-version=2023-04-01

Paramètres URI

Nom Dans Obligatoire Type Description
Endpoint
 path True

string

Point de terminaison Cognitive Services pris en charge (par exemple, https://.api.cognitiveservices.azure.com).
projectName
 path True

string

Nom du projet à utiliser.
api-version
 query True

string

Version d’API client.

Corps de la demande

Nom Type Description
body

UpdateQnaRecord[]

Mettre à jour les paramètres QnAs d’un projet.

Réponses

Nom Type Description
202 Accepted

Un appel réussi donne un en-tête Operation-Location utilisé pour vérifier l’état du travail.

En-têtes

Operation-Location: string
Other Status Codes

ErrorResponse

Réponse d’erreur.

Sécurité

AADToken

Il s’agit des flux OAuth2 Azure Active Directory . Lorsqu’il est associé au contrôle d’accès en fonction du rôle Azure, il peut être utilisé pour contrôler l’accès à Azure Maps API REST. Les contrôles d’accès en fonction du rôle Azure sont utilisés pour désigner l’accès à un ou plusieurs Azure Maps compte de ressources ou sous-ressources. Tout utilisateur, groupe ou principal de service peut se voir accorder l’accès via un rôle intégré ou un rôle personnalisé composé d’une ou plusieurs autorisations pour Azure Maps API REST.

Pour implémenter des scénarios, nous vous recommandons d’afficher les concepts d’authentification. En résumé, cette définition de sécurité fournit une solution pour modéliser 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 à quelle ressource Azure Maps l’application demande l’accès. Vous pouvez l’acquérir à partir de l’API de gestion Maps.

Authorization URL est spécifique au cloud public Azure instance. 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 du plan de gestion Azure via Portail Azure, PowerShell, CLI, sdk Azure ou API REST. * L’utilisation du Kit de développement logiciel (SDK) web Azure Maps permet une 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 Language.

Type: apiKey
Dans: header

Exemples

Successful query

Exemple de requête

PATCH {Endpoint}/language/authoring/query-knowledgebases/projects/proj1/qnas?api-version=2023-04-01

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

Code d’état:
202 
Operation-Location: https:///language/authoring/query-knowledgebases/projects/proj1/qnas/jobs/job1?api-version=2023-04-01

Définitions

Nom Description
Error

Objet d’erreur.
ErrorCode

Code d’erreur lisible par l’utilisateur.
ErrorResponse

Réponse d’erreur.
InnerErrorCode

Code d’erreur lisible par l’utilisateur.
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.
QnaDialog

Boîte de dialogue associée à l’enregistrement QnA.
QnaPrompt

Demander une réponse.
QnaRecord

Enregistrement QnA.
SuggestedQuestion

Question suggérée par la fonctionnalité Active Learning.
SuggestedQuestionsCluster

Informations sur le cluster des questions suggérées par Active Learning.
updateOperationKind

Mettre à jour le type d’opération pour les ressources.
UpdateQnaRecord

Enregistrement QnA à mettre à jour.

Error

Objet d’erreur.

Nom Type Description
code

ErrorCode

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

InnerErrorModel

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

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

Error

Objet d’erreur.

InnerErrorCode

Code d’erreur lisible par l’utilisateur.

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 relatives à l’API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nom Type Description
code

InnerErrorCode

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

object

Détails de l’erreur.
innererror

InnerErrorModel

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

Pour 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

QnaPrompt[]

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 l’ordre des invites.
displayText

string

Texte affiché pour représenter une invite de questions de suivi.
qna

QnaRecord

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

SuggestedQuestionsCluster[]

Liste des suggestions d’apprentissage actif pour le QnA.
answer

string

Texte de réponse.
dialog

QnaDialog

Contexte d’un QnA.
id

integer

ID unique pour la 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 de questions associées à la réponse.
source

string

Source à partir de laquelle QnA a été indexé, https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs par exemple .

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 des questions suggérées par Active Learning.

Nom Type Description
clusterHead

string

Question choisie comme responsable du cluster de questions suggérées par l’algorithme Active Learning clustering.
suggestedQuestions

SuggestedQuestion[]

Liste de toutes les questions suggérées pour la 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

updateOperationKind

Mettre à jour le type d’opération pour les ressources.
value

QnaRecord

Enregistrement QnA.