Text Analysis Authoring - Get Deployment Status

Riferimento

Servizio:: Azure AI Services

Versione API:: 2023-04-01

Ottiene lo stato di un processo di distribuzione esistente.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
deploymentName	path	True	string	Rappresenta il nome della distribuzione.
Endpoint	path	True	string url	Endpoint di Servizi cognitivi supportato (ad esempio, https://.api.cognitiveservices.azure.com).
jobId	path	True	string	ID processo.
projectName	path	True	string	Nome del nuovo progetto.
api-version	query	True	string	Versione dell'API da usare per questa operazione.

Risposte

Nome	Tipo	Descrizione
200 OK	TextAnalysisAuthoringDeploymentJobState	La richiesta ha avuto esito positivo.
Other Status Codes	ErrorResponse	Risposta di errore imprevista.

Sicurezza

Ocp-Apim-Subscription-Key

Tipo: apiKey
In: header

OAuth2Auth

Tipo: oauth2
Flow: accessCode
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize
URL token: https://login.microsoftonline.com/common/oauth2/token

Ambiti

Nome	Descrizione
https://cognitiveservices.azure.com/.default

Esempio

Successful Get Deployment Status

Esempio di richiesta

HTTP

GET {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/deployments/production/jobs/66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000?api-version=2023-04-01

Risposta di esempio

Codice di stato:: 200

{
  "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000",
  "createdDateTime": "2022-04-18T15:52:48Z",
  "lastUpdatedDateTime": "2022-04-18T15:53:04Z",
  "expirationDateTime": "2022-04-25T15:52:48Z",
  "status": "succeeded"
}

Definizioni

Nome	Descrizione
Error	Oggetto error.
ErrorCode	Codice di errore leggibile.
ErrorResponse	Risposta di errore.
InnerErrorCode	Codice di errore leggibile.
InnerErrorModel	Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API Microsoft One , https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
JobStatus
TextAnalysisAuthoringDeploymentJobState	Rappresenta lo stato di un processo di distribuzione.
TextAnalysisAuthoringWarning	Rappresenta un avviso rilevato durante l'esecuzione della richiesta.

Error

Oggetto error.

Nome	Tipo	Descrizione
code	ErrorCode	Uno di un set definito dal server di codici di errore.
details	Error[]	Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.
innererror	InnerErrorModel	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Rappresentazione leggibile dell'errore.
target	string	Destinazione dell'errore.

ErrorCode

Codice di errore leggibile.

Nome	Tipo	Descrizione
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

Risposta di errore.

Nome	Tipo	Descrizione
error	Error	Oggetto error.

InnerErrorCode