Conversational Analysis Authoring - Get Deployment Status

Referenz

Dienst:: Azure AI Services

API-Version:: 2023-04-01

Ruft den Status eines vorhandenen Bereitstellungsauftrags ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
deploymentName	path	True	string	Stellt den Bereitstellungsnamen dar.
Endpoint	path	True	string
jobId	path	True	string	Die Auftrags-ID.
projectName	path	True	string	Der neue Projektname.
api-version	query	True	string	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	ConversationalAnalysisAuthoringDeploymentJobState	Die Anforderung ist erfolgreich.
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

Ocp-Apim-Subscription-Key

Typ: apiKey
In: header

OAuth2Auth

Typ: oauth2
Ablauf: accessCode
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize
Token-URL: https://login.microsoftonline.com/common/oauth2/token

Bereiche

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

Beispiele

Successful Get Deployment Status

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
ConversationalAnalysisAuthoringDeploymentJobState	Stellt den Status eines Bereitstellungsauftrags dar.
Error	Das Fehlerobjekt.
ErrorCode	Lesbarer Fehlercode.
ErrorResponse	Fehlerantwort.
InnerErrorCode	Lesbarer 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
Warning	Stellt eine Warnung dar, die beim Ausführen der Anforderung aufgetreten ist.

ConversationalAnalysisAuthoringDeploymentJobState

Stellt den Status eines Bereitstellungsauftrags dar.

Name	Typ	Beschreibung
createdDateTime	string	Das Erstellungsdatum des Auftrags.
errors	Error[]	Fehler beim Ausführen des Auftrags.
expirationDateTime	string	Die Ablaufzeit des Auftrags.
jobId	string	Die Auftrags-ID.
lastUpdatedDateTime	string	Das letzte Datum, zu dem der Auftrag aktualisiert wurde.
status	JobStatus	Der Auftragsstatus.
warnings	Warning[]	Die Warnungen, die beim Ausführen des Auftrags aufgetreten sind.

Error

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	ErrorCode	Eine serverdefinierte Gruppe von Fehlercodes.
details	Error[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	InnerErrorModel	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine lesbare Darstellung des Fehlers.
target	string	Das Ziel des Fehlers.

ErrorCode

Lesbarer Fehlercode.

Name	Typ	Beschreibung
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	Typ	Beschreibung
error	Error	Das Fehlerobjekt.

InnerErrorCode