Conversational Analysis Authoring - Get Swap Deployments Status

Reference

Service:: Azure AI Services

API Version:: 2022-05-01

Gets the status of an existing swap deployment job.

GET {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/deployments/swap/jobs/{jobId}?api-version=2022-05-01

URI Parameters

Name	In	Required	Type	Description
Endpoint	path	True	string	Supported Cognitive Services endpoint (e.g., https://.api.cognitiveservices.azure.com).
jobId	path	True	string	The job ID.
projectName	path	True	string	The name of the project to use.
api-version	query	True	string	Client API version.

Request Header

Name	Required	Type	Description
Ocp-Apim-Subscription-Key	True	string	A subscription key for a Language service resource.

Responses

Name	Type	Description
200 OK	ConversationalAnalysisAuthoringDeploymentJobState	The swap deployment job result.
Other Status Codes	ErrorResponse	Error response.

Security

Ocp-Apim-Subscription-Key

A subscription key for a Language service resource.

Type: apiKey
In: header

Examples

Successful Get Swap Deployments Status

Sample request

HTTP

GET {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/deployments/swap/jobs/c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000?api-version=2022-05-01

Sample response

Status code:: 200

{
  "jobId": "c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000",
  "createdDateTime": "2022-04-18T16:09:50Z",
  "lastUpdatedDateTime": "2022-04-18T16:09:58Z",
  "expirationDateTime": "2022-04-25T16:09:50Z",
  "status": "succeeded"
}

Definitions

Name	Description
ConversationalAnalysisAuthoringDeploymentJobState	Represents the state of a deployment job.
ConversationalAnalysisAuthoringWarning	Represents a warning that was encountered while executing the request.
Error	The error object.
ErrorCode	Human-readable error code.
ErrorResponse	Error response.
InnerErrorCode	Human-readable error code.
InnerErrorModel	An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
JobStatus	The job status.

ConversationalAnalysisAuthoringDeploymentJobState

Represents the state of a deployment job.

Name	Type	Description
createdDateTime	string	The creation date time of the job.
errors	Error[]	The errors encountered while executing the job.
expirationDateTime	string	The expiration date time of the job.
jobId	string	The job ID.
lastUpdatedDateTime	string	The last date time the job was updated.
status	JobStatus	The job status.
warnings	ConversationalAnalysisAuthoringWarning[]	The warnings that were encountered while executing the job.

ConversationalAnalysisAuthoringWarning

Represents a warning that was encountered while executing the request.

Name	Type	Description
code	string	The warning code.
message	string	The warning message.

Error

The error object.

Name	Type	Description
code	ErrorCode	One of a server-defined set of error codes.
details	Error[]	An array of details about specific errors that led to this reported error.
innererror	InnerErrorModel	An object containing more specific information than the current object about the error.
message	string	A human-readable representation of the error.
target	string	The target of the error.

ErrorCode

Human-readable error code.

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

Error response.

Name	Type	Description
error	Error	The error object.

InnerErrorCode