Conversation Authoring Deployment - Get Deployment Status

Szolgáltatás:

Azure AI Services

API-verzió:

2023-04-01

Lekéri egy meglévő üzembehelyezési feladat állapotát.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
deploymentName	path	True	string	Az üzembe helyezés nevét jelöli.
Endpoint	path	True	string	Támogatott Cognitive Services-végpont, például https://.api.cognitiveservices.azure.com.
jobId	path	True	string	A feladat azonosítója.
projectName	path	True	string maxLength: 100	Az új projektnév.
api-version	query	True	string minLength: 1	A művelethez használni kívánt API-verzió.

Válaszok

Name	Típus	Description
200 OK	AnalyzeConversationAuthoringDeploymentJobState	A kérés sikeres volt.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Váratlan hibaválasz. Fejlécek x-ms-error-code: string

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 Deployment Status

Mintakérelem

HTTP

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

Mintaválasz

Állapotkód:

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

Definíciók

Name	Description
AnalyzeConversationAuthoringDeploymentJobState	Az üzembehelyezési feladat állapotát jelöli.
Azure.Core.Foundations.Error	A hibaobjektum.
Azure.Core.Foundations.ErrorResponse	Hibaadatokat tartalmazó válasz.
Azure.Core.Foundations.InnerError	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/azure/Guidelines.md#handling-errors.
JobStatus

AnalyzeConversationAuthoringDeploymentJobState

Objektum

Az üzembehelyezési feladat állapotát jelöli.

Name	Típus	Description
createdDateTime	string (date-time)	A feladat létrehozási dátuma.
errors	Azure.Core.Foundations.Error[]	A feladat végrehajtása során észlelt hibák.
expirationDateTime	string (date-time)	A feladat lejárati dátuma.
jobId	string	A feladat azonosítója.
lastUpdatedDateTime	string (date-time)	A feladat utolsó frissítésének dátuma.
status	JobStatus	A feladat állapota.
warnings	Azure.Core.Foundations.Error[]	A feladat végrehajtása során észlelt figyelmeztetések.

Azure.Core.Foundations.Error

Objektum

A hibaobjektum.

Name	Típus	Description
code	string	A kiszolgáló által definiált hibakódok egyike.
details	Azure.Core.Foundations.Error[]	A jelentett hibához vezető konkrét hibák részleteinek tömbje.
innererror	Azure.Core.Foundations.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.

Azure.Core.Foundations.ErrorResponse

Objektum

Hibaadatokat tartalmazó válasz.

Name	Típus	Description
error	Azure.Core.Foundations.Error	A hibaobjektum.

Azure.Core.Foundations.InnerError

Objektum

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/azure/Guidelines.md#handling-errors.

Name	Típus	Description
code	string	A kiszolgáló által definiált hibakódok egyike.
innererror	Azure.Core.Foundations.InnerError	Belső hiba.

JobStatus

Enumerálás

Érték	Description
cancelled
cancelling
failed
notStarted
partiallyCompleted
running
succeeded