Text Analysis Authoring - Get Import Status
Pobiera stan importu.
GET {Endpoint}/language/authoring/analyze-text/projects/{projectName}/import/jobs/{jobId}?api-version=2023-04-01
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
Endpoint
|
path | True |
string url |
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 |
Nowa nazwa projektu. |
api-version
|
query | True |
string |
Wersja interfejsu API do użycia dla tej operacji. |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
Żądanie zakończyło się pomyślnie. |
|
Other Status Codes |
Nieoczekiwana odpowiedź na błąd. |
Zabezpieczenia
Ocp-Apim-Subscription-Key
Typ:
apiKey
W:
header
OAuth2Auth
Typ:
oauth2
Flow:
accessCode
Adres URL autoryzacji:
https://login.microsoftonline.com/common/oauth2/authorize
Adres URL tokenu:
https://login.microsoftonline.com/common/oauth2/token
Zakresy
Nazwa | Opis |
---|---|
https://cognitiveservices.azure.com/.default |
Przykłady
Successful Get Import Status
Przykładowe żądanie
GET {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/import/jobs/c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000?api-version=2023-04-01
Przykładowa odpowiedź
{
"jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000",
"createdDateTime": "2022-04-18T15:17:20Z",
"lastUpdatedDateTime": "2022-04-18T15:17:22Z",
"expirationDateTime": "2022-04-25T15:17:20Z",
"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 dotyczącymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
Job |
|
Text |
Reprezentuje stan zadania importu. |
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 dotyczącymi interfejsu MICROSOFT One API — 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 |
Element docelowy błędu. |
JobStatus
Nazwa | Typ | Opis |
---|---|---|
cancelled |
string |
|
cancelling |
string |
|
failed |
string |
|
notStarted |
string |
|
partiallyCompleted |
string |
|
running |
string |
|
succeeded |
string |
TextAnalysisAuthoringImportProjectJobState
Reprezentuje stan zadania importu.
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. |
status |
Stan zadania. |
|
warnings |
Ostrzeżenia 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. |