Text Analysis Authoring - Export
Löst einen Auftrag aus, um die Daten eines Projekts zu exportieren.
POST {Endpoint}/language/authoring/analyze-text/projects/{projectName}/:export?stringIndexType=Utf16CodeUnit&api-version=2023-04-01
POST {Endpoint}/language/authoring/analyze-text/projects/{projectName}/:export?stringIndexType=Utf16CodeUnit&assetKind={assetKind}&trainedModelLabel={trainedModelLabel}&api-version=2023-04-01
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
Endpoint
|
path | True |
string |
Unterstützter Cognitive Services-Endpunkt (z. B. https://.api.cognitiveservices.azure.com). |
project
|
path | True |
string |
Der Name des zu verwendenden Projekts. |
api-version
|
query | True |
string |
Client-API-Version. |
string
|
query | True |
Gibt die Methode an, die zum Interpretieren von Zeichenfolgenoffsets verwendet wird. Weitere Informationen finden Sie unter https://aka.ms/text-analytics-offsets. |
|
asset
|
query |
string |
Art des zu exportierenden Medienobjekts. |
|
trained
|
query |
string |
Trainierte Modellbezeichnung für den Export. Wenn trainedModelLabel NULL ist, ist das Standardverhalten das Exportieren der aktuellen Arbeitskopie. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
202 Accepted |
Ein erfolgreicher Aufruf enthält einen Operation-Location-Header, mit dem der Auftragsstatus überprüft wird. Headers operation-location: string |
|
Other Status Codes |
Fehlerantwort. |
Sicherheit
AADToken
Dies sind die Azure Active Directory OAuth2-Flows . In Kombination mit der rollenbasierten Zugriffssteuerung in Azure kann sie verwendet werden, um den Zugriff auf Azure Maps REST-APIs zu steuern. Rollenbasierte Zugriffssteuerungen in Azure werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps Ressourcenkonto oder Unterressourcen festzulegen. Jedem Benutzer, jeder Gruppe oder einem Dienstprinzipal kann zugriff über eine integrierte Rolle oder eine benutzerdefinierte Rolle gewährt werden, die aus einer oder mehreren Berechtigungen für Azure Maps REST-APIs besteht.
Zur Implementierung von Szenarien wird empfohlen, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die die Zugriffssteuerung für bestimmte APIs und Bereiche ermöglichen.
Hinweise
- Diese Sicherheitsdefinition erfordert die Verwendung des
x-ms-client-id
Headers, um anzugeben, auf welche Azure Maps Ressource die Anwendung Zugriff anfordert. Dies kann über die Kartenverwaltungs-API abgerufen werden.
ist Authorization URL
spezifisch für die öffentliche Azure-Cloud instance. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Azure Active Directory-Konfigurationen.
* Die rollenbasierte Zugriffssteuerung von Azure wird über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs konfiguriert.
* Die Verwendung des Azure Maps Web SDK ermöglicht die konfigurationsbasierte Einrichtung einer Anwendung für mehrere Anwendungsfälle.
- Derzeit unterstützt Azure Active Directory v1.0 oder v2.0 Arbeit, Schule und Gäste, aber keine persönlichen Konten.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Beschreibung |
---|---|
https://cognitiveservices.azure.com/.default | https://cognitiveservices.azure.com/.default |
Ocp-Apim-Subscription-Key
Ein Abonnementschlüssel für eine Sprachdienstressource.
Type:
apiKey
In:
header
Beispiele
Successful Export Project
Sample Request
POST {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/:export?stringIndexType=Utf16CodeUnit&api-version=2023-04-01
Sample Response
operation-location: {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/export/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-01
Definitionen
Name | Beschreibung |
---|---|
Error |
Das Fehlerobjekt. |
Error |
Lesbarer Fehlercode. |
Error |
Fehlerantwort. |
Inner |
Lesbarer Fehlercode. |
Inner |
Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Richtlinien der Microsoft One-API: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
String |
Gibt die Methode an, die zum Interpretieren von Zeichenfolgenoffsets verwendet wird. Weitere Informationen finden Sie unter https://aka.ms/text-analytics-offsets. |
Error
Das Fehlerobjekt.
Name | Typ | Beschreibung |
---|---|---|
code |
Einer von einem serverdefiniertem Satz von Fehlercodes. |
|
details |
Error[] |
Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben. |
innererror |
Ein -Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler. |
|
message |
string |
Eine lesbare Darstellung des Fehlers. |
target |
string |
Das Ziel des Fehlers. |
ErrorCode
Lesbarer Fehlercode.
Name | Typ | Beschreibung |
---|---|---|
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
Fehlerantwort.
Name | Typ | Beschreibung |
---|---|---|
error |
Das Fehlerobjekt. |
InnerErrorCode
Lesbarer Fehlercode.
Name | Typ | Beschreibung |
---|---|---|
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
Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Richtlinien der Microsoft One-API: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Name | Typ | Beschreibung |
---|---|---|
code |
Einer von einem serverdefiniertem Satz von Fehlercodes. |
|
details |
object |
Fehlerdetails. |
innererror |
Ein -Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler. |
|
message |
string |
Fehlermeldung. |
target |
string |
Fehlerziel. |
StringIndexType
Gibt die Methode an, die zum Interpretieren von Zeichenfolgenoffsets verwendet wird. Weitere Informationen finden Sie unter https://aka.ms/text-analytics-offsets.
Name | Typ | Beschreibung |
---|---|---|
Utf16CodeUnit |
string |
Die Offset- und Längenwerte entsprechen UTF-16-Codeeinheiten. Verwenden Sie diese Option, wenn Ihre Anwendung in einer Sprache geschrieben ist, die Unicode unterstützt, z. B. Java und JavaScript. |