Text Analysis Authoring - Get Export Status
Pobiera stan zadania eksportu. Po zakończeniu zadania zwraca metadane projektu i zasoby.
GET {Endpoint}/language/authoring/analyze-text/projects/{projectName}/export/jobs/{jobId}?api-version=2023-04-01
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
Endpoint
|
path | True |
string |
Obsługiwany punkt końcowy usług Cognitive Services (np. https://.api.cognitiveservices.azure.com). |
job
|
path | True |
string |
Identyfikator zadania. |
project
|
path | True |
string |
Nazwa projektu do użycia. |
api-version
|
query | True |
string |
Wersja interfejsu API klienta. |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
Stan długotrwałej operacji. |
|
Other Status Codes |
Odpowiedź na błąd. |
Zabezpieczenia
AADToken
Są to przepływy protokołu OAuth2 usługi Azure Active Directory . W połączeniu z kontrolą dostępu opartą na rolach platformy Azure może służyć do kontrolowania dostępu do interfejsów API REST Azure Maps. Mechanizmy kontroli dostępu opartej na rolach platformy Azure służą do wyznaczania dostępu do co najmniej jednego konta zasobów Azure Maps lub zasobów podrzędnych. Każdy użytkownik, grupa lub jednostka usługi może mieć dostęp za pośrednictwem wbudowanej roli lub roli niestandardowej składającej się z co najmniej jednego uprawnienia do Azure Maps interfejsów API REST.
Aby zaimplementować scenariusze, zalecamy wyświetlenie pojęć dotyczących uwierzytelniania. Podsumowując, ta definicja zabezpieczeń udostępnia rozwiązanie do modelowania aplikacji za pośrednictwem obiektów, które mogą kontrolować dostęp do określonych interfejsów API i zakresów.
Uwagi
- Ta definicja zabezpieczeń wymaga użycia nagłówka
x-ms-client-id
, aby wskazać, do którego zasobu Azure Maps aplikacja żąda dostępu. Można to uzyskać za pomocą interfejsu API zarządzania mapami.
Element Authorization URL
jest specyficzny dla wystąpienia chmury publicznej platformy Azure. Suwerenne chmury mają unikatowe adresy URL autoryzacji i konfiguracje usługi Azure Active Directory.
* Kontrola dostępu oparta na rolach platformy Azure jest konfigurowana z płaszczyzny zarządzania platformy Azure za pośrednictwem Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsów API REST.
* Użycie zestawu AZURE MAPS Web SDK umożliwia konfigurację opartą na konfiguracji aplikacji w wielu przypadkach użycia.
- Obecnie usługa Azure Active Directory w wersji 1.0 lub 2.0 obsługuje konta służbowe, szkolne i gości, ale nie obsługują kont osobistych.
Typ:
oauth2
Flow:
implicit
Adres URL autoryzacji:
https://login.microsoftonline.com/common/oauth2/authorize
Zakresy
Nazwa | Opis |
---|---|
https://cognitiveservices.azure.com/.default | https://cognitiveservices.azure.com/.default |
Ocp-Apim-Subscription-Key
Klucz subskrypcji zasobu usługi językowej.
Typ:
apiKey
W:
header
Przykłady
Successful Get Export Status
Przykładowe żądanie
GET {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/export/jobs/c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000?api-version=2023-04-01
Przykładowa odpowiedź
{
"resultUrl": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/export/jobs/c4946bfa-4fbf-493b-bfcf-2d232eb9de69_637858368000000000/result?api-version=2023-04-01",
"jobId": "c4946bfa-4fbf-493b-bfcf-2d232eb9de69_637858368000000000",
"createdDateTime": "2022-04-18T15:23:07Z",
"lastUpdatedDateTime": "2022-04-18T15:23:08Z",
"expirationDateTime": "2022-04-25T15:23:07Z",
"status": "succeeded"
}
Definicje
Nazwa | Opis |
---|---|
Error |
Obiekt błędu. |
Error |
Kod błędu czytelny dla człowieka. |
Error |
Odpowiedź na błąd. |
Inner |
Kod błędu czytelny dla człowieka. |
Inner |
Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi interfejsu API usługi Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
Job |
Stan zadania. |
Text |
Reprezentuje stan zadania eksportu. |
Text |
Reprezentuje ostrzeżenie, które zostało napotkane podczas wykonywania żądania. |
Error
Obiekt błędu.
Nazwa | Typ | Opis |
---|---|---|
code |
Jeden z zdefiniowanych przez serwer zestaw kodów błędów. |
|
details |
Error[] |
Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu. |
innererror |
Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie. |
|
message |
string |
Czytelna dla człowieka reprezentacja błędu. |
target |
string |
Element docelowy błędu. |
ErrorCode
Kod błędu czytelny dla człowieka.
Nazwa | Typ | Opis |
---|---|---|
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
Odpowiedź na błąd.
Nazwa | Typ | Opis |
---|---|---|
error |
Obiekt błędu. |
InnerErrorCode
Kod błędu czytelny dla człowieka.
Nazwa | Typ | Opis |
---|---|---|
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
Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi interfejsu API usługi Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Nazwa | Typ | Opis |
---|---|---|
code |
Jeden z zdefiniowanych przez serwer zestaw kodów błędów. |
|
details |
object |
Szczegóły błędu. |
innererror |
Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie. |
|
message |
string |
Komunikat o błędzie. |
target |
string |
Błąd docelowy. |
JobStatus
Stan zadania.
Nazwa | Typ | Opis |
---|---|---|
cancelled |
string |
|
cancelling |
string |
|
failed |
string |
|
notStarted |
string |
|
partiallyCompleted |
string |
|
running |
string |
|
succeeded |
string |
TextAnalysisAuthoringExportProjectJobState
Reprezentuje stan zadania eksportu.
Nazwa | Typ | Opis |
---|---|---|
createdDateTime |
string |
Data utworzenia zadania. |
errors |
Error[] |
Błędy napotkane podczas wykonywania zadania. |
expirationDateTime |
string |
Data wygaśnięcia zadania. |
jobId |
string |
Identyfikator zadania. |
lastUpdatedDateTime |
string |
Data ostatniej aktualizacji zadania. |
resultUrl |
string |
Adres URL do użycia w celu pobrania wyeksportowanego projektu. |
status |
Stan zadania. |
|
warnings |
Ostrzeżenia, które zostały napotkane podczas wykonywania zadania. |
TextAnalysisAuthoringWarning
Reprezentuje ostrzeżenie, które zostało napotkane podczas wykonywania żądania.
Nazwa | Typ | Opis |
---|---|---|
code |
string |
Kod ostrzegawczy. |
message |
string |
Komunikat ostrzegawczy. |