Text Analysis Authoring - Get Import Status
Lekéri az importálás állapotát.
GET {Endpoint}/language/authoring/analyze-text/projects/{projectName}/import/jobs/{jobId}?api-version=2023-04-01
URI-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
Endpoint
|
path | True |
string url |
Támogatott Cognitive Services-végpont (például https://.api.cognitiveservices.azure.com). |
job
|
path | True |
string |
A feladat azonosítója. |
project
|
path | True |
string |
Az új projektnév. |
api-version
|
query | True |
string |
A művelethez használni kívánt API-verzió. |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
A kérés sikeres volt. |
|
Other Status Codes |
Váratlan hibaválasz. |
Biztonság
Ocp-Apim-Subscription-Key
Típus:
apiKey
In:
header
OAuth2Auth
Típus:
oauth2
Folyamat:
accessCode
Engedélyezési URL:
https://login.microsoftonline.com/common/oauth2/authorize
Jogkivonat URL-címe:
https://login.microsoftonline.com/common/oauth2/token
Hatókörök
Name | Description |
---|---|
https://cognitiveservices.azure.com/.default |
Példák
Successful Get Import Status
Mintakérelem
GET {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/import/jobs/c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000?api-version=2023-04-01
Mintaválasz
{
"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"
}
Definíciók
Name | Description |
---|---|
Error |
A hibaobjektum. |
Error |
Ember által olvasható hibakód. |
Error |
Hibaválasz. |
Inner |
Ember által olvasható hibakód. |
Inner |
Egy objektum, amely részletesebb információkat tartalmaz a hibáról. A Microsoft One API irányelvei szerint – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
Job |
|
Text |
Egy importálási feladat állapotát jelöli. |
Text |
A kérés végrehajtása során észlelt figyelmeztetést jelöli. |
Error
A hibaobjektum.
Name | Típus | Description |
---|---|---|
code |
A kiszolgáló által definiált hibakódok egyike. |
|
details |
Error[] |
A jelentett hibához vezető konkrét hibák részleteinek tömbje. |
innererror |
Egy objektum, amely az aktuális objektumnál pontosabb információt tartalmaz a hibáról. |
|
message |
string |
A hiba ember által olvasható ábrázolása. |
target |
string |
A hiba célja. |
ErrorCode
Ember által olvasható hibakód.
Name | Típus | 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
Hibaválasz.
Name | Típus | Description |
---|---|---|
error |
A hibaobjektum. |
InnerErrorCode
Ember által olvasható hibakód.
Name | Típus | 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
Egy objektum, amely részletesebb információkat tartalmaz a hibáról. A Microsoft One API irányelvei szerint – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Name | Típus | Description |
---|---|---|
code |
A kiszolgáló által definiált hibakódok egyike. |
|
details |
object |
Hiba részletei. |
innererror |
Egy objektum, amely az aktuális objektumnál pontosabb információt tartalmaz a hibáról. |
|
message |
string |
Hibaüzenet. |
target |
string |
Hibacél. |
JobStatus
Name | Típus | Description |
---|---|---|
cancelled |
string |
|
cancelling |
string |
|
failed |
string |
|
notStarted |
string |
|
partiallyCompleted |
string |
|
running |
string |
|
succeeded |
string |
TextAnalysisAuthoringImportProjectJobState
Egy importálási feladat állapotát jelöli.
Name | Típus | Description |
---|---|---|
createdDateTime |
string |
A feladat létrehozási dátuma. |
errors |
Error[] |
A feladat végrehajtása során észlelt hibák. |
expirationDateTime |
string |
A feladat lejárati dátuma. |
jobId |
string |
A feladat azonosítója. |
lastUpdatedDateTime |
string |
A feladat utolsó frissítésének dátuma. |
status |
A feladat állapota. |
|
warnings |
A feladat végrehajtása során észlelt figyelmeztetések. |
TextAnalysisAuthoringWarning
A kérés végrehajtása során észlelt figyelmeztetést jelöli.
Name | Típus | Description |
---|---|---|
code |
string |
A figyelmeztető kód. |
message |
string |
A figyelmeztető üzenet. |