Text Analysis Authoring - Get Swap Deployments Status
Gets the status of an existing swap deployment job.
GET {Endpoint}/language/authoring/analyze-text/projects/{projectName}/deployments/swap/jobs/{jobId}?api-version=2023-04-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
Endpoint
|
path | True |
string url |
Supported Cognitive Services endpoint (e.g., https://.api.cognitiveservices.azure.com). |
job
|
path | True |
string |
The job ID. |
project
|
path | True |
string |
The new project name. |
api-version
|
query | True |
string |
The API version to use for this operation. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
The request has succeeded. |
|
Other Status Codes |
An unexpected error response. |
Security
Ocp-Apim-Subscription-Key
Type:
apiKey
In:
header
OAuth2Auth
Type:
oauth2
Flow:
accessCode
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Token URL:
https://login.microsoftonline.com/common/oauth2/token
Scopes
Name | Description |
---|---|
https://cognitiveservices.azure.com/.default |
Examples
SuccessfulGetSwapDeploymentsStatus
Sample request
GET {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/deployments/swap/jobs/c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000?api-version=2023-04-01
Sample response
{
"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 |
---|---|
Error |
The error object. |
Error |
Human-readable error code. |
Error |
Error response. |
Inner |
Human-readable error code. |
Inner |
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. |
Job |
|
Text |
Represents the state of a deployment job. |
Text |
Represents a warning that was encountered while executing the request. |
Error
The error object.
Name | Type | Description |
---|---|---|
code |
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 |
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 |
The error object. |
InnerErrorCode
Human-readable error code.
Name | Type | Description |
---|---|---|
AzureCognitiveSearchNotFound |
string |
|
AzureCognitiveSearchThrottling |
string |
|
EmptyRequest |
string |
|
ExtractionFailure |
string |
|
InvalidCountryHint |
string |
|
InvalidDocument |
string |
|
InvalidDocumentBatch |
string |
|
InvalidParameterValue |
string |
|
InvalidRequest |
string |
|
InvalidRequestBodyFormat |
string |
|
KnowledgeBaseNotFound |
string |
|
MissingInputDocuments |
string |
|
ModelVersionIncorrect |
string |
|
UnsupportedLanguageCode |
string |
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.
Name | Type | Description |
---|---|---|
code |
One of a server-defined set of error codes. |
|
details |
object |
Error details. |
innererror |
An object containing more specific information than the current object about the error. |
|
message |
string |
Error message. |
target |
string |
Error target. |
JobStatus
Name | Type | Description |
---|---|---|
cancelled |
string |
|
cancelling |
string |
|
failed |
string |
|
notStarted |
string |
|
partiallyCompleted |
string |
|
running |
string |
|
succeeded |
string |
TextAnalysisAuthoringSwapDeploymentsJobState
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 |
The job status. |
|
warnings |
The warnings that were encountered while executing the job. |
TextAnalysisAuthoringWarning
Represents a warning that was encountered while executing the request.
Name | Type | Description |
---|---|---|
code |
string |
The warning code. |
message |
string |
The warning message. |