Text Analysis Authoring - Get Import Status

Ruft den Status für einen Import ab.

GET {Endpoint}/language/authoring/analyze-text/projects/{projectName}/import/jobs/{jobId}?api-version=2022-05-01

URI-Parameter

Name In Required Type Description
Endpoint
path True
  • string

Unterstützter Cognitive Services-Endpunkt (z. B. https://.api.cognitiveservices.azure.com).

jobId
path True
  • string

Die Auftrags-ID.

projectName
path True
  • string

Der Name des zu verwendenden Projekts.

api-version
query True
  • string

Client-API-Version.

Anforderungsheader

Name Required Type Description
Ocp-Apim-Subscription-Key True
  • string

Ein Abonnementschlüssel für eine Sprachdienstressource.

Antworten

Name Type Description
200 OK

Die Details des lang ausgeführten Vorgangs.

Other Status Codes

Fehlerantwort.

Sicherheit

Ocp-Apim-Subscription-Key

Ein Abonnementschlüssel für eine Sprachdienstressource.

Type: apiKey
In: header

Beispiele

Successful Get Import Status

Sample Request

GET {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/import/jobs/c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000?api-version=2022-05-01

Sample Response

{
  "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"
}

Definitionen

Error

Das Fehlerobjekt.

ErrorCode

Menschlichen lesbaren Fehlercode.

ErrorResponse

Fehlerantwort.

InnerErrorCode

Menschlichen lesbaren Fehlercode.

InnerErrorModel

Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß Den Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

JobStatus

Der Auftragsstatus.

TextAnalysisAuthoringImportProjectJobState

Stellt den Status eines Importauftrags dar.

TextAnalysisAuthoringWarning

Stellt eine Warnung dar, die beim Ausführen der Anforderung aufgetreten ist.

Error

Das Fehlerobjekt.

Name Type Description
code

Eine serverdefinierte Gruppe von Fehlercodes.

details

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 menschlich lesbare Darstellung des Fehlers.

target
  • string

Das Ziel des Fehlers.

ErrorCode

Menschlichen lesbaren Fehlercode.

Name Type 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

Fehlerantwort.

Name Type Description
error

Das Fehlerobjekt.

InnerErrorCode

Menschlichen lesbaren Fehlercode.

Name Type 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

Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß Den Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name Type Description
code

Eine serverdefinierte Gruppe 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.

JobStatus

Der Auftragsstatus.

Name Type Description
cancelled
  • string
cancelling
  • string
failed
  • string
notStarted
  • string
partiallyCompleted
  • string
running
  • string
succeeded
  • string

TextAnalysisAuthoringImportProjectJobState

Stellt den Status eines Importauftrags dar.

Name Type Description
createdDateTime
  • string

Das Erstellungsdatum des Auftrags.

errors

Fehler beim Ausführen des Auftrags.

expirationDateTime
  • string

Die Ablaufdatumszeit des Auftrags.

jobId
  • string

Die Auftrags-ID.

lastUpdatedDateTime
  • string

Das letzte Datum, an dem der Auftrag aktualisiert wurde.

status

Der Auftragsstatus.

warnings

Die Warnungen, die beim Ausführen des Auftrags aufgetreten sind.

TextAnalysisAuthoringWarning

Stellt eine Warnung dar, die beim Ausführen der Anforderung aufgetreten ist.

Name Type Description
code
  • string

Der Warncode.

message
  • string

Die Warnmeldung.