Text Analysis Authoring - Export

Service:

Azure AI Services

API-versie:

2022-05-01

Hiermee wordt een taak geactiveerd om de gegevens van een project te exporteren.

POST {Endpoint}/language/authoring/analyze-text/projects/{projectName}/:export?stringIndexType=Utf16CodeUnit&api-version=2022-05-01

Met optionele parameters:

POST {Endpoint}/language/authoring/analyze-text/projects/{projectName}/:export?stringIndexType=Utf16CodeUnit&assetKind={assetKind}&api-version=2022-05-01

URI-parameters

Name	In	Vereist	Type	Description
Endpoint	path	True	string	Ondersteund Cognitive Services-eindpunt (bijvoorbeeld https://.api.cognitiveservices.azure.com).
projectName	path	True	string maxLength: 100	De naam van het te gebruiken project.
api-version	query	True	string	Client-API-versie.
stringIndexType	query	True	StringIndexType	Hiermee geeft u de methode op die wordt gebruikt om tekenreeksverschuivingen te interpreteren. Zie https://aka.ms/text-analytics-offsetsvoor meer informatie.
assetKind	query		string	Soort asset dat moet worden geëxporteerd.

Aanvraagkoptekst

Name	Vereist	Type	Description
Ocp-Apim-Subscription-Key	True	string	Een abonnementssleutel voor een Taalserviceresource.

Antwoorden

Name	Type	Description
202 Accepted		Een geslaagde aanroep met een Operation-Location header die wordt gebruikt om de status van de taak te controleren. Kopteksten operation-location: string
Other Status Codes	ErrorResponse	Foutreactie.

Beveiliging

Ocp-Apim-Subscription-Key

Een abonnementssleutel voor een Taalserviceresource.

Type: apiKey
In: header

Voorbeelden

Successful Export Project

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:

202

operation-location: {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/export/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2022-05-01

Definities

Name	Description
Error	Het foutobject.
ErrorCode	Leesbare foutcode.
ErrorResponse	Foutreactie.
InnerErrorCode	Leesbare foutcode.
InnerErrorModel	Een object met meer specifieke informatie over de fout. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
StringIndexType	Hiermee geeft u de methode op die wordt gebruikt om tekenreeksverschuivingen te interpreteren. Zie https://aka.ms/text-analytics-offsetsvoor meer informatie.

Error

Object

Het foutobject.

Name	Type	Description
code	ErrorCode	Een van een door de server gedefinieerde set foutcodes.
details	Error[]	Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.
innererror	InnerErrorModel	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Een leesbare weergave van de fout.
target	string	Het doel van de fout.

ErrorCode

Inventarisatie

Leesbare foutcode.

Waarde	Description
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Conflict
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
QuotaExceeded
ServiceUnavailable
Timeout
TooManyRequests
Unauthorized
Warning

ErrorResponse

Object

Foutreactie.

Name	Type	Description
error	Error	Het foutobject.

InnerErrorCode

Inventarisatie

Leesbare foutcode.

Waarde	Description
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
EmptyRequest
ExtractionFailure
InvalidCountryHint
InvalidDocument
InvalidDocumentBatch
InvalidParameterValue
InvalidRequest
InvalidRequestBodyFormat
KnowledgeBaseNotFound
MissingInputDocuments
ModelVersionIncorrect
UnsupportedLanguageCode

InnerErrorModel

Object

Een object met meer specifieke informatie over de fout. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
code	InnerErrorCode	Een van een door de server gedefinieerde set foutcodes.
details	object	Foutdetails.
innererror	InnerErrorModel	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Foutmelding.
target	string	Foutdoel.

StringIndexType

Inventarisatie

Hiermee geeft u de methode op die wordt gebruikt om tekenreeksverschuivingen te interpreteren. Zie https://aka.ms/text-analytics-offsetsvoor meer informatie.

Waarde	Description
Utf16CodeUnit	De offset- en lengtewaarden komen overeen met UTF-16-code-eenheden. Gebruik deze optie als uw toepassing is geschreven in een taal die Unicode ondersteunt, bijvoorbeeld JavaScript.