Question Answering Projects - Import

Référence

Service:: Cognitive Services - Language

Version d'API:: 2023-04-01

Importer des ressources de projet.

POST {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/:import?api-version=2023-04-01

Avec des paramètres facultatifs:

POST {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/:import?api-version=2023-04-01&format={format}&assetKind={assetKind}

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.
assetKind	query		string	Type de l’actif du projet.
format	query		format	Format d’importation ou d’exportation de la base de connaissances.

Corps de la demande

Nom	Type	Description
assets	Assets	Toutes les ressources de ce projet.
fileUri	string	IMPORTER l’URI du fichier de données.
metadata	CreateProjectOptions	Paramètres nécessaires pour créer le 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.

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

est Authorization URL 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, kits 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

HTTP

POST {Endpoint}/language/authoring/query-knowledgebases/projects/proj1/:import?api-version=2023-04-01

{
  "assets": {
    "synonyms": [
      {
        "alterations": [
          "wa",
          "washington",
          "washington state"
        ]
      },
      {
        "alterations": [
          "U.S",
          "usa",
          "united states of america"
        ]
      }
    ],
    "qnas": [
      {
        "lastUpdatedDateTime": "2021-05-01T17:21:14Z",
        "id": 1,
        "answer": "ans1",
        "source": "source1",
        "questions": [
          "question 1.1",
          "question 1.2"
        ],
        "metadata": {
          "k1": "v1",
          "k2": "v2"
        },
        "dialog": {
          "isContextOnly": false,
          "prompts": [
            {
              "displayOrder": 1,
              "qnaId": 2,
              "displayText": "prompt 1.1"
            }
          ]
        }
      },
      {
        "lastUpdatedDateTime": "2021-05-01T17:21:14Z",
        "id": 2,
        "answer": "ans2",
        "source": "source2",
        "questions": [
          "question 2.1",
          "question 2.2"
        ]
      }
    ]
  }
}

Exemple de réponse

Code d’état:: 202

Operation-Location: https:///language/authoring/query-knowledgebases/projects/proj1/import/jobs/job1?api-version=2023-04-01

Définitions

Nom	Description
Assets	Toutes les ressources de ce projet.
CreateProjectOptions	Paramètres nécessaires pour créer le projet.
Error	Objet error.
ErrorCode	Code d’erreur lisible par l’utilisateur.
ErrorResponse	Réponse d’erreur.
format	Format d’importation ou d’exportation de la base de connaissances.
ImportJobOptions	Les ressources du projet doivent être importées.
ImportQnaRecord	Importer un enregistrement QnA.
InnerErrorCode	Code d’erreur lisible par l’utilisateur.
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.
ProjectSettings	Paramètres configurables du projet.
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é d’apprentissage actif.
SuggestedQuestionsCluster	Détails du cluster des questions suggérées d’Active Learning.
WordAlterations	Collection d’altérations de mots.

Assets

Toutes les ressources de ce projet.

Nom	Type	Description
qnas	ImportQnaRecord[]	Liste des enregistrements QnA à importer.
synonyms	WordAlterations[]	Collection de synonymes.

CreateProjectOptions

Paramètres nécessaires pour créer le projet.

Nom	Type	Description
description	string	Description du projet.
language	string	Langue des enregistrements de texte. Il s’agit de la représentation BCP-47 d’une langue. Par exemple, utilisez « en » pour l’anglais ; « es » pour l’espagnol, etc. S’il n’est pas défini, utilisez « en » pour l’anglais comme valeur par défaut.
multilingualResource	boolean	Définissez sur true pour permettre la création de bases de connaissances dans différentes langues pour la même ressource.
settings	ProjectSettings	Paramètres configurables du projet.

Error

Objet error.

Nom	Type	Description
code	ErrorCode	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.

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

format

Format d’importation ou d’exportation de la base de connaissances.

Nom	Type	Description
excel	string	Exporter ou importer des base de connaissances réplica incluant toutes les ressources et métadonnées au format Tsv.
json	string	Exportez ou importez des ressources QnA au format JSON.
tsv	string	Exporter ou importer des base de connaissances réplica y compris toutes les ressources et métadonnées au format Excel.

ImportJobOptions

Les ressources du projet doivent être importées.

Nom	Type	Description
assets	Assets	Toutes les ressources de ce projet.
fileUri	string	IMPORTER l’URI du fichier de données.
metadata	CreateProjectOptions	Paramètres nécessaires pour créer le projet.

ImportQnaRecord

Importer un enregistrement QnA.

Nom	Type	Description
activeLearningSuggestions	SuggestedQuestionsCluster[]	Liste des suggestions d’apprentissage actif pour le QnA.
answer	string	Texte de la réponse.
dialog	QnaDialog	Contexte d’un QnA.
id	integer	ID unique pour le QnA.
lastUpdatedDateTime	string	Date-heure de la dernière mise à jour du QnA.
metadata	object	Métadonnées associées à la réponse, utiles pour classer ou filtrer les réponses aux questions.
questions	string[]	Liste des questions associées à la réponse.
source	string	Source à partir de laquelle le QnA a été indexé, https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs par exemple .
sourceDisplayName	string	Nom convivial de la source.

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

ProjectSettings

Paramètres configurables du projet.

Nom	Type	Description
defaultAnswer	string	Réponse par défaut quand aucune bonne correspondance n’est trouvée dans le base de connaissances.

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 la réponse.
dialog	QnaDialog	Contexte d’un QnA.
id	integer	ID unique pour le QnA.
metadata	object	Métadonnées associées à la réponse, utiles pour classer ou filtrer les réponses aux questions.
questions	string[]	Liste des questions associées à la réponse.
source	string	Source à partir de laquelle le 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é d’apprentissage actif.

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é d’apprentissage actif.
userSuggestedCount	integer	Nombre de fois où la question a été suggérée explicitement par l’utilisateur.

SuggestedQuestionsCluster

Détails du cluster des questions suggérées d’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 le QnA.

WordAlterations

Collection d’altérations de mots.

Nom	Type	Description
alterations	string[]	Collection d’altérations de mots.

Partager via

Question Answering Projects - Import

Paramètres URI

Corps de la demande

Réponses

Sécurité

AADToken

Notes

Étendues

Ocp-Apim-Subscription-Key

Exemples

Successful query

Exemple de requête

Exemple de réponse

Définitions

Assets

CreateProjectOptions

Error

ErrorCode

ErrorResponse

format

ImportJobOptions

ImportQnaRecord

InnerErrorCode

InnerErrorModel

ProjectSettings

QnaDialog

QnaPrompt

QnaRecord

SuggestedQuestion

SuggestedQuestionsCluster

WordAlterations

Ressources supplémentaires