Question Answering Projects - Export
Exportez les métadonnées et les ressources du projet.
POST {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/:export?api-version=2023-04-01
POST {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/:export?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). |
project
|
path | True |
string |
Nom du projet à utiliser. |
api-version
|
query | True |
string |
Version d’API client. |
asset
|
query |
string |
Type de l’actif du projet. |
|
format
|
query |
Format d’importation ou d’exportation de la base de connaissances. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
Exportez les status de travail, les métadonnées de projet et les ressources. |
|
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 |
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
POST {Endpoint}/language/authoring/query-knowledgebases/projects/proj1/:export?api-version=2023-04-01
Exemple de réponse
{
"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-01"
}
Operation-Location: https:///language/authoring/query-knowledgebases/projects/proj1/export/jobs/job1?api-version=2023-04-01
Définitions
Nom | Description |
---|---|
Error |
Objet d’erreur. |
Error |
Code d’erreur lisible par l’utilisateur. |
Error |
Réponse d’erreur. |
Export |
Exportez les status de travail, les métadonnées de projet et les ressources. |
format |
Format d’importation ou d’exportation de la base de connaissances. |
Inner |
Code d’erreur lisible par l’utilisateur. |
Inner |
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. |
job |
État du travail. |
Error
Objet d’erreur.
Nom | Type | Description |
---|---|---|
code |
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 |
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 |
Objet d’erreur. |
ExportJobState
Exportez les status de travail, les métadonnées de 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 de la tâche d’exportation. |
status |
État du travail. |
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 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 |
Exporter ou importer des base de connaissances réplica y compris toutes les ressources et métadonnées au format Excel. |
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 |
Un des 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. |
jobStatus
État du travail.
Nom | Type | Description |
---|---|---|
cancelled |
string |
|
cancelling |
string |
|
failed |
string |
|
notStarted |
string |
|
partiallyCompleted |
string |
|
running |
string |
|
succeeded |
string |