Text Analysis Authoring - Get Project Deletion Status

Reference

Služba:: Azure AI Services

Verze rozhraní API:: 2023-04-01

Získá stav úlohy odstranění projektu.

GET {Endpoint}/language/authoring/analyze-text/projects/global/deletion-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říklad https://.api.cognitiveservices.azure.com.
jobId	path	True	string	ID úlohy.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	TextAnalysisAuthoringProjectDeletionJobState	Požadavek byl úspěšný.
Other Status Codes	ErrorResponse	Neočekávaná chybová odpověď

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

SuccessfulGetProjectDeletionStatus

Ukázkový požadavek

HTTP

GET {Endpoint}/language/authoring/analyze-text/projects/global/deletion-jobs/129d3182-625d-496c-bcf9-43686e85160b_637858368000000000?api-version=2023-04-01

Ukázková odpověď

Stavový kód:: 200

{
  "jobId": "129d3182-625d-496c-bcf9-43686e85160b_637858368000000000",
  "createdDateTime": "2022-04-18T14:02:34Z",
  "lastUpdatedDateTime": "2022-04-18T14:02:34Z",
  "expirationDateTime": "2022-04-25T14:02:34Z",
  "status": "succeeded"
}

Definice

Name	Description
Error	Objekt chyby.
ErrorCode	Kód chyby čitelné člověkem
ErrorResponse	Chybová odpověď.
InnerErrorCode	Kód chyby čitelné člověkem
InnerErrorModel	Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní API Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
JobStatus
TextAnalysisAuthoringProjectDeletionJobState	Představuje stav úlohy odstranění projektu.
TextAnalysisAuthoringWarning	Představuje upozornění, ke kterému došlo při provádění požadavku.

Error

Objekt chyby.

Name	Typ	Description
code	ErrorCode	Jedna ze serverově definovaných kódů chyb.
details	Error[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innererror	InnerErrorModel	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.

ErrorCode

Kód chyby čitelné člověkem

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

Chybová odpověď.

Name	Typ	Description
error	Error	Objekt chyby.

InnerErrorCode