Partager via

Text Analysis Authoring - Export

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

Déclenche un travail pour exporter les données d’un projet.

POST {Endpoint}/language/authoring/analyze-text/projects/{projectName}/:export?api-version=2023-04-01&stringIndexType=Utf16CodeUnit
Avec des paramètres facultatifs: 
POST {Endpoint}/language/authoring/analyze-text/projects/{projectName}/:export?api-version=2023-04-01&stringIndexType=Utf16CodeUnit&assetKind={assetKind}&trainedModelLabel={trainedModelLabel}

Paramètres URI

Nom Dans Obligatoire Type Description
Endpoint
 path True

string

url

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 de l’API à utiliser pour cette opération.
stringIndexType
 query True

StringIndexType

Spécifie la méthode utilisée pour interpréter les décalages de chaîne. Pour plus d’informations, consultez https://aka.ms/text-analytics-offsets.
assetKind
 query

string

Type de ressource à exporter.
trainedModelLabel
 query

string

Étiquette de modèle entraînée à exporter. Si l’objet trainedModelLabel a la valeur Null, le comportement par défaut consiste à exporter la copie de travail actuelle.

Réponses

Nom Type Description
202 Accepted

La demande a été acceptée pour traitement, mais le traitement n’a pas encore été terminé.

En-têtes

Operation-Location: string
Other Status Codes

ErrorResponse

Réponse d’erreur inattendue.

Sécurité

Ocp-Apim-Subscription-Key

Type: apiKey
Dans: header

OAuth2Auth

Type: oauth2
Flux: accessCode
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize
URL du jeton: https://login.microsoftonline.com/common/oauth2/token

Étendues

Nom Description
https://cognitiveservices.azure.com/.default

Exemples

Successful Export Project

Exemple de requête

POST {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/:export?api-version=2023-04-01&stringIndexType=Utf16CodeUnit

Exemple de réponse

Code d’état:
202 
operation-location: {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/export/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-01

Définitions

Nom Description
Error

Objet d’erreur.
ErrorCode

Code d’erreur lisible par l’homme.
ErrorResponse

Réponse d’erreur.
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.
StringIndexType

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.

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.

StringIndexType

Nom Type Description
Utf16CodeUnit

string

Les valeurs de décalage et de longueur correspondent aux unités de code UTF-16. Utilisez cette option si votre application est écrite dans un langage qui prend en charge Unicode, par exemple JavaScript.