Microsoft Cognitive Language Service - Analyze Conversations Authoring (preview:2025-05-15)

2025/04/30 • 2 updated methods

ConversationAuthoringListTrainingJobs (updated)
Description :  Lists the non-expired training jobs created for a project.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ConversationAuthoringListTrainingJobs",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "result": [
              {
                "@added_85ebbb52985f44fd9f40975fc08c6a2f": {
                  "#name": "dataGenerationStatus",
                  "Description": "Represents the model data generation status.",
                  "Required": true,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "percentComplete",
                      "Description": "Represents progress percentage.",
                      "Format": "int32",
                      "Required": true,
                      "Type": "integer"
                    },
                    {
                      "#name": "startDateTime",
                      "Description": "Represents the start date time.",
                      "Format": "date-time",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "endDateTime",
                      "Description": "Represents the end date time.",
                      "Format": "date-time",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "status",
                      "Description": "Represents the status of the sub-operation.",
                      "Enum": [
                        [
                          "notStarted",
                          ""
                        ],
                        [
                          "running",
                          ""
                        ],
                        [
                          "succeeded",
                          ""
                        ],
                        [
                          "failed",
                          ""
                        ],
                        [
                          "cancelled",
                          ""
                        ],
                        [
                          "cancelling",
                          ""
                        ],
                        [
                          "partiallyCompleted",
                          ""
                        ]
                      ],
                      "Required": true,
                      "Type": "string"
                    }
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /authoring/analyze-conversations/projects/{projectName}/train/jobs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
top:
{
Description: The number of result items to return. ,
Format: int32 ,
Required: False ,
}
integer ,
skip:
{
Description: The number of result items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
maxpagesize:
{
Description: The maximum number of result items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The AnalyzeConversationAuthoringTrainingJobState items on this page ,
Required: True ,
}
[
{
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
createdDateTime:
{
Description: The creation date time of the job. ,
Format: date-time ,
Required: True ,
}
string ,
lastUpdatedDateTime:
{
Description: The last date time the job was updated. ,
Format: date-time ,
Required: True ,
}
string ,
expirationDateTime:
{
Description: The expiration date time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The job status. ,
Enum:
{
notStarted: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
cancelled: No description available. ,
cancelling: No description available. ,
partiallyCompleted: No description available. ,
}
,
Required: True ,
}
enum ,
warnings:
{
Description: The warnings that were encountered while executing the job. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
errors:
{
Description: The errors encountered while executing the job. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
result:
{
Description: Represents training tasks detailed result. ,
Required: True ,
}
{
modelLabel:
{
Description: Represents trained model label. ,
Required: True ,
}
string ,
trainingConfigVersion:
{
Description: Represents training config version. ,
Required: True ,
}
string ,
trainingMode:
{
Description: Represents the mode of the training operation. ,
Enum:
{
advanced: Trains using fine-tuned neural network transformer models. Can train multilingual projects. ,
standard: Faster training times for quicker iterations. ,
}
,
Required: False ,
}
enum ,
trainingStatus:
{
Description: Represents the model training status. ,
Required: True ,
}
{
percentComplete:
{
Description: Represents progress percentage. ,
Format: int32 ,
Required: True ,
}
integer ,
startDateTime:
{
Description: Represents the start date time. ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: Represents the end date time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Represents the status of the sub-operation. ,
Enum:
{
notStarted: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
cancelled: No description available. ,
cancelling: No description available. ,
partiallyCompleted: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
dataGenerationStatus:
{
Description: Represents the model data generation status. ,
Required: True ,
}
{
percentComplete:
{
Description: Represents progress percentage. ,
Format: int32 ,
Required: True ,
}
integer ,
startDateTime:
{
Description: Represents the start date time. ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: Represents the end date time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Represents the status of the sub-operation. ,
Enum:
{
notStarted: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
cancelled: No description available. ,
cancelling: No description available. ,
partiallyCompleted: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
evaluationStatus:
{
Description: Represents model evaluation status. ,
Required: False ,
}
{
percentComplete:
{
Description: Represents progress percentage. ,
Format: int32 ,
Required: True ,
}
integer ,
startDateTime:
{
Description: Represents the start date time. ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: Represents the end date time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Represents the status of the sub-operation. ,
Enum:
{
notStarted: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
cancelled: No description available. ,
cancelling: No description available. ,
partiallyCompleted: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
estimatedEndDateTime:
{
Description: Represents the estimated end date time for training and evaluation. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
ConversationAuthoringProject_GetTrainingStatus (updated)
Description :  Gets the status for a training job.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ConversationAuthoringProject_GetTrainingStatus",
  "$responses": {
    "200": {
      "$properties": {
        "result": [
          {
            "@added_f248811c2bb945f79b89a658304c08ee": {
              "#name": "dataGenerationStatus",
              "Description": "Represents the model data generation status.",
              "Required": true,
              "Type": "object",
              "$properties": [
                {
                  "#name": "percentComplete",
                  "Description": "Represents progress percentage.",
                  "Format": "int32",
                  "Required": true,
                  "Type": "integer"
                },
                {
                  "#name": "startDateTime",
                  "Description": "Represents the start date time.",
                  "Format": "date-time",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "endDateTime",
                  "Description": "Represents the end date time.",
                  "Format": "date-time",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "status",
                  "Description": "Represents the status of the sub-operation.",
                  "Enum": [
                    [
                      "notStarted",
                      ""
                    ],
                    [
                      "running",
                      ""
                    ],
                    [
                      "succeeded",
                      ""
                    ],
                    [
                      "failed",
                      ""
                    ],
                    [
                      "cancelled",
                      ""
                    ],
                    [
                      "cancelling",
                      ""
                    ],
                    [
                      "partiallyCompleted",
                      ""
                    ]
                  ],
                  "Required": true,
                  "Type": "string"
                }
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /authoring/analyze-conversations/projects/{projectName}/train/jobs/{jobId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
jobId:
{
Description: The job ID. ,
Required: True ,
}
string ,
createdDateTime:
{
Description: The creation date time of the job. ,
Format: date-time ,
Required: True ,
}
string ,
lastUpdatedDateTime:
{
Description: The last date time the job was updated. ,
Format: date-time ,
Required: True ,
}
string ,
expirationDateTime:
{
Description: The expiration date time of the job. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: The job status. ,
Enum:
{
notStarted: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
cancelled: No description available. ,
cancelling: No description available. ,
partiallyCompleted: No description available. ,
}
,
Required: True ,
}
enum ,
warnings:
{
Description: The warnings that were encountered while executing the job. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
errors:
{
Description: The errors encountered while executing the job. ,
Required: False ,
}
[
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
]
,
result:
{
Description: Represents training tasks detailed result. ,
Required: True ,
}
{
modelLabel:
{
Description: Represents trained model label. ,
Required: True ,
}
string ,
trainingConfigVersion:
{
Description: Represents training config version. ,
Required: True ,
}
string ,
trainingMode:
{
Description: Represents the mode of the training operation. ,
Enum:
{
advanced: Trains using fine-tuned neural network transformer models. Can train multilingual projects. ,
standard: Faster training times for quicker iterations. ,
}
,
Required: False ,
}
enum ,
trainingStatus:
{
Description: Represents the model training status. ,
Required: True ,
}
{
percentComplete:
{
Description: Represents progress percentage. ,
Format: int32 ,
Required: True ,
}
integer ,
startDateTime:
{
Description: Represents the start date time. ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: Represents the end date time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Represents the status of the sub-operation. ,
Enum:
{
notStarted: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
cancelled: No description available. ,
cancelling: No description available. ,
partiallyCompleted: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
dataGenerationStatus:
{
Description: Represents the model data generation status. ,
Required: True ,
}
{
percentComplete:
{
Description: Represents progress percentage. ,
Format: int32 ,
Required: True ,
}
integer ,
startDateTime:
{
Description: Represents the start date time. ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: Represents the end date time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Represents the status of the sub-operation. ,
Enum:
{
notStarted: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
cancelled: No description available. ,
cancelling: No description available. ,
partiallyCompleted: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
evaluationStatus:
{
Description: Represents model evaluation status. ,
Required: False ,
}
{
percentComplete:
{
Description: Represents progress percentage. ,
Format: int32 ,
Required: True ,
}
integer ,
startDateTime:
{
Description: Represents the start date time. ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: Represents the end date time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Represents the status of the sub-operation. ,
Enum:
{
notStarted: No description available. ,
running: No description available. ,
succeeded: No description available. ,
failed: No description available. ,
cancelled: No description available. ,
cancelling: No description available. ,
partiallyCompleted: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
estimatedEndDateTime:
{
Description: Represents the estimated end date time for training and evaluation. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}