Conversational Analysis Authoring - Get Training Status

Reference

Service:: Cognitive Services - Language

API Version:: 2023-04-01

Gets the status for a training job.

GET {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/train/jobs/{jobId}?api-version=2023-04-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.

Responses

Name	Type	Description
200 OK	ConversationalAnalysisAuthoringTrainingJobState	The training job result.
Other Status Codes	ErrorResponse	Error response.

Security

AADToken

These are the Azure Active Directory OAuth2 Flows. When paired with Azure role-based access control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.

To implement scenarios, we recommend viewing authentication concepts. In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.

Notes

This security definition requires the use of the x-ms-client-id header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the Maps management API.

The Authorization URL is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. * The Azure role-based access control is configured from the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs. * Usage of the Azure Maps Web SDK allows for configuration based setup of an application for multiple use cases.

Currently, Azure Active Directory v1.0 or v2.0 supports Work, School, and Guests but does not support Personal accounts.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Ocp-Apim-Subscription-Key

A subscription key for a Language service resource.

Type: apiKey
In: header

Examples

Successful Get Train Status

Sample Request

HTTP

GET {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/train/jobs/8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000?api-version=2023-04-01

Sample Response

Status code:: 200

{
  "result": {
    "modelLabel": "model1",
    "trainingConfigVersion": "2022-05-01",
    "trainingMode": "standard",
    "estimatedEndDateTime": "2022-04-18T15:47:58.8190649Z",
    "trainingStatus": {
      "percentComplete": 3,
      "startDateTime": "2022-04-18T15:45:06.8190649Z",
      "status": "running"
    },
    "evaluationStatus": {
      "percentComplete": 0,
      "status": "notStarted"
    }
  },
  "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000",
  "createdDateTime": "2022-04-18T15:44:44Z",
  "lastUpdatedDateTime": "2022-04-18T15:45:48Z",
  "expirationDateTime": "2022-04-25T15:44:44Z",
  "status": "running"
}

Definitions

Name	Description
ConversationalAnalysisAuthoringSubTrainingJobState	Represents the detailed state of a training sub-operation.
ConversationalAnalysisAuthoringTrainingJobResult	Represents the output of a training job.
ConversationalAnalysisAuthoringTrainingJobState	Represents the state of a training 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.
TrainingMode	Represents the mode of the training operation.

ConversationalAnalysisAuthoringSubTrainingJobState

Represents the detailed state of a training sub-operation.

Name	Type	Description
endDateTime	string	Represents the end date time.
percentComplete	integer	Represents progress percentage.
startDateTime	string	Represents the start date time.
status	JobStatus	Represents the status of the sub-operation.

ConversationalAnalysisAuthoringTrainingJobResult

Represents the output of a training job.

Name	Type	Description
estimatedEndDateTime	string	Represents the estimated end date time for training and evaluation.
evaluationStatus	ConversationalAnalysisAuthoringSubTrainingJobState	Represents model evaluation status.
modelLabel	string	Represents trained model label.
trainingConfigVersion	string	Represents training config version.
trainingMode	TrainingMode	Represents the mode of the training operation.
trainingStatus	ConversationalAnalysisAuthoringSubTrainingJobState	Represents the model training status.

ConversationalAnalysisAuthoringTrainingJobState

Represents the state of a training 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.
result	ConversationalAnalysisAuthoringTrainingJobResult	Represents training tasks detailed result.
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