Question Answering Projects - Export

Référence

Service:: Azure AI Services

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

Exportez les métadonnées et les ressources du projet.

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

Avec des paramètres facultatifs:

POST {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/:export?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.

Réponses

Nom	Type	Description
200 OK	ExportJobState	Exportez l’état du travail, les métadonnées du projet et les ressources.
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

200 OK

ExportJobState

Exportez l’état du travail, les métadonnées du projet et les ressources.

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/:export?api-version=2023-04-15-preview

Exemple de réponse

Code d’état:: 200

{
  "errors": [],
  "createdDateTime": "2021-05-01T17:21:14Z",
  "expirationDateTime": "2021-05-01T17:21:14Z",
  "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a",
  "lastUpdatedDateTime": "2021-05-01T17:21:14Z",
  "status": "succeeded",
  "resultUrl": "https://<resource-endpoint>/language/authoring/query-knowledgebases/projects/proj1/export/jobs/job1/result?api-version=2023-04-15-preview"
}

Code d’état:: 202

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

Définitions

Nom	Description
assetKind	Type de ressource du projet.
Error	Objet d’erreur.
ErrorCode	Code d’erreur lisible par l’homme.
ErrorResponse	Réponse d’erreur.
ExportJobState	Exportez l’état du travail, les métadonnées du projet et les ressources.
format	Format d’importation ou d’exportation de la base de connaissances.
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.
jobStatus	État du travail.

assetKind

Type de ressource du projet.

Nom	Type	Description
qnas	string
synonyms	string

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.

ExportJobState

Exportez l’état du travail, les métadonnées du projet et les ressources.

Nom	Type	Description
createdDateTime	string
errors	Error[]	Objet d’erreur.
expirationDateTime	string
jobId	string
lastUpdatedDateTime	string
resultUrl	string	URL pour télécharger le résultat du travail d’exportation.
status	jobStatus	État du travail.

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.

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.

jobStatus

État du travail.

Nom	Type	Description
cancelled	string
cancelling	string
failed	string
notStarted	string
partiallyCompleted	string
running	string
succeeded	string

Partager via

Question Answering Projects - Export

Paramètres URI

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

Error

ErrorCode

ErrorResponse

ExportJobState

format

InnerErrorCode

InnerErrorModel

jobStatus

Ressources supplémentaires