Text Authoring Project - Get Import Status

Služba:

Azure AI Services

Verze rozhraní API:

2023-04-01

Získá stav importu.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
Endpoint	path	True	string (url)	Podporovaný koncový bod služeb Cognitive Services, např. https://< resource-name.api.cognitiveservices.azure.com>.
jobId	path	True	string	ID úlohy.
projectName	path	True	string	Název nového projektu.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	TextAnalysisAuthoringImportProjectJobState	Žádost byla úspěšná.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Neočekávaná chybová odpověď Hlavičky x-ms-error-code: string

Zabezpečení

Ocp-Apim-Subscription-Key

Typ: apiKey
V: header

OAuth2Auth

Typ: oauth2
Tok: accessCode
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize
URL tokenu: https://login.microsoftonline.com/common/oauth2/token

Rozsahy

Name	Description
https://cognitiveservices.azure.com/.default

Příklady

Successful Get Import Status

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:

200

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

Definice

Name	Description
Azure.Core.Foundations.Error	Objekt chyby.
Azure.Core.Foundations.ErrorResponse	Odpověď obsahující podrobnosti o chybě.
Azure.Core.Foundations.InnerError	Objekt obsahující konkrétnější informace o chybě. Podle pokynů pro rozhraní Azure REST API - https://aka.ms/AzureRestApiGuidelines#handling-errors.
JobStatus
TextAnalysisAuthoringImportProjectJobState	Představuje stav úlohy importu.

Azure.Core.Foundations.Error

Objekt

Objekt chyby.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
details	Azure.Core.Foundations.Error[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innererror	Azure.Core.Foundations.InnerError	Objekt obsahující konkrétnější informace, než je aktuální objekt o chybě.
message	string	Čitelné znázornění chyby člověkem.
target	string	Cíl chyby.

Azure.Core.Foundations.ErrorResponse

Objekt

Odpověď obsahující podrobnosti o chybě.

Name	Typ	Description
error	Azure.Core.Foundations.Error	Objekt chyby.

Azure.Core.Foundations.InnerError

Objekt

Objekt obsahující konkrétnější informace o chybě. Podle pokynů pro rozhraní Azure REST API - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
innererror	Azure.Core.Foundations.InnerError	Vnitřní chyba.

JobStatus

Výčet

Hodnota	Description
notStarted
running
succeeded
failed
cancelled
cancelling
partiallyCompleted

TextAnalysisAuthoringImportProjectJobState

Objekt

Představuje stav úlohy importu.

Name	Typ	Description
createdDateTime	string (date-time)	Datum vytvoření a čas úlohy.
errors	Azure.Core.Foundations.Error[]	Chyby, ke kterým došlo při provádění úlohy.
expirationDateTime	string (date-time)	Datum vypršení platnosti a čas úlohy.
jobId	string	ID úlohy.
lastUpdatedDateTime	string (date-time)	Datum poslední aktualizace úlohy.
status	JobStatus	Stav úlohy.
warnings	Azure.Core.Foundations.Error[]	Upozornění, ke kterým došlo při provádění úlohy.