Question Answering Projects - Import

Référence

Service:: Azure AI Services

Version d'API:: 2023-04-15-preview

Importer des ressources de projet.

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

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
projectName	path	True	string	Nom du projet à utiliser.
api-version	query	True	string	Version de l’API cliente.
assetKind	query		assetKind	Type de ressource 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		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	ErrorResponse	Réponse d’erreur.

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

ErrorResponse

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

HTTP

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

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

Définitions

Nom	Description
assetKind	Type de ressource du projet.
Assets	Toutes les ressources de ce projet.
CreateProjectOptions	Paramètres nécessaires pour créer le projet.
Error	Objet d’erreur.
ErrorCode	Code d’erreur lisible par l’homme.
ErrorResponse	Réponse d’erreur.
format	Format d’importation ou d’exportation de la base de connaissances.
ImportJobOptions	Ressources de projet à importer.
ImportQnaRecord	Importez un enregistrement QnA.
InnerErrorCode	Code d’erreur lisible par l’homme.
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é Active Learning.
SuggestedQuestionsCluster	Informations sur le cluster questions suggérées pour l’apprentissage actif.
WordAlterations	Collection de modifications de mots.

assetKind

Type de ressource du projet.

Nom	Type	Description
qnas	string
synonyms	string

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. Si ce n’est pas le cas, utilisez « en » pour l’anglais comme valeur par défaut.
multilingualResource	boolean	Définissez la valeur true pour activer 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 d’erreur.

Nom	Type	Description
code	ErrorCode	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	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’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	Error	Objet d’erreur.

format

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

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

ImportJobOptions

Ressources de projet à importer.

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

Importez un 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 le QnA.
lastUpdatedDateTime	string	Date et heure de la dernière mise à jour du 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 .
sourceDisplayName	string	Nom convivial de la source.

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	InnerErrorCode	Un ensemble 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 la base de connaissances.

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	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 classer les 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 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	SuggestedQuestion[]	Liste de toutes les questions suggérées pour le QnA.

WordAlterations

Collection de modifications de mots.

Nom	Type	Description
alterations	string[]	Collection de modifications 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

assetKind

Assets

CreateProjectOptions

Error

ErrorCode

ErrorResponse

format

ImportJobOptions

ImportQnaRecord

InnerErrorCode

InnerErrorModel

ProjectSettings

QnaDialog

QnaPrompt

QnaRecord

SuggestedQuestion

SuggestedQuestionsCluster

WordAlterations

Ressources supplémentaires