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

2025/10/07 • 6 updated methods

ConversationAuthoringDeployment_DeleteDeploymentFromResources (updated)
Description :  Deletes a deployment from the specified project-assigned resources.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ConversationAuthoringDeployment_DeleteDeploymentFromResources",
  "Description": {
    "new": "Deletes a deployment from the specified project-assigned resources.",
    "old": "Deletes a project deployment from the specified assigned resources."
  },
  "$parameters": [
    {
      "#name": "body",
      "Description": {
        "new": "The Language or AIService resource list for deleting the deployment.\\r\\n            The deployment will only be deleted from the specified resources, and will remain for the rest.",
        "old": "The options for deleting the deployment."
      },
      "$schema": {
        "Description": {
          "new": "Represents the payload for deleting a project deployment.",
          "old": "Represents the options for deleting a project deployment."
        },
        "$properties": [
          {
            "#name": "assignedResourceIds",
            "Description": {
              "new": "Represents the Language or AIService resource IDs to unassign from the project or delete the deployment from.",
              "old": "Represents the resource IDs to delete the deployment from. If not provided, the deployment will be rolled out from all the resources it is deployed to. If provided, it will delete the deployment only from the specified assigned resources, and leave it for the rest."
            }
          }
        ]
      }
    }
  ]
}

⚼ Request

POST:  /authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}/:delete-from-resources
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the specific deployment of the project to use. ,
Required: True ,
}
string ,
body:
{
Description: The Language or AIService resource list for deleting the deployment.\r\n The deployment will only be deleted from the specified resources, and will remain for the rest. ,
Required: True ,
}
{
assignedResourceIds:
{
Description: Represents the Language or AIService resource IDs to unassign from the project or delete the deployment from. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (202)

{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
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 ,
}
,
}
,
}
,
}
ConversationAuthoringListDeploymentResources (updated)
Description :  Lists the Language or AIService resources assigned to the project.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ConversationAuthoringListDeploymentResources",
  "Description": {
    "new": "Lists the Language or AIService resources assigned to the project.",
    "old": "Lists the deployments resources assigned to the project."
  },
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "Description": {
            "new": "Represents the assigned project resource.",
            "old": "Represents the assigned deployment resource."
          },
          "$properties": [
            {
              "#name": "azureResourceId",
              "Description": {
                "new": "The Azure resource ID of the language or AI resource.",
                "old": "The resource ID."
              }
            },
            {
              "#name": "region",
              "Description": {
                "new": "The Azure resource region.",
                "old": "The resource region."
              }
            }
          ]
        }
      }
    }
  }
}

⚼ Request

GET:  /authoring/analyze-conversations/projects/{projectName}/resources
{
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 AnalyzeConversationAuthoringAssignedDeploymentResource items on this page ,
Required: True ,
}
[
{
azureResourceId:
{
Description: The Azure resource ID of the language or AI resource. ,
Required: True ,
}
string ,
region:
{
Description: The Azure resource region. ,
Required: True ,
}
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_AssignDeploymentResources (updated)
Description :  Assign new Language or AIService Azure resources to a project to allowing deployment to them. This API is available only via AAD authentication and not supported via subscription key authentication. For more details about AAD authentication, check here: https://learn.microsoft.com/en-us/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-azure-active-directory
Reference :  Link ¶

⚶ Changes

{
  "#id": "ConversationAuthoringProject_AssignDeploymentResources",
  "Description": {
    "new": "Assign new Language or AIService Azure resources to a project to allowing deployment to them. This API is available only via AAD authentication and not supported via subscription key authentication. For more details about AAD authentication, check here: https://learn.microsoft.com/en-us/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-azure-active-directory",
    "old": "Assign new Azure resources to a project to allow deploying new deployments to them. This API is available only via AAD authentication and not supported via subscription key authentication. For more details about AAD authentication, check here: https://learn.microsoft.com/en-us/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-azure-active-directory"
  },
  "$parameters": [
    {
      "#name": "body",
      "Description": {
        "new": "The new project resources to be assigned.",
        "old": "The new project resources info."
      },
      "$schema": {
        "Description": {
          "new": "Represents the payload for assigning Azure resources to a project.",
          "old": "Represents the options for assigning Azure resources to a project."
        },
        "$properties": [
          {
            "#name": "resourcesMetadata",
            "Description": {
              "new": "Represents the metadata for the project resources to be assigned.",
              "old": "Represents the metadata for the resources to be assigned."
            }
          }
        ]
      }
    }
  ]
}

⚼ Request

POST:  /authoring/analyze-conversations/projects/{projectName}/resources/:assign
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
body:
{
Description: The new project resources to be assigned. ,
Required: True ,
}
{
resourcesMetadata:
{
Description: Represents the metadata for the project resources to be assigned. ,
Required: True ,
}
[
{
azureResourceId:
{
Description: Represents the Azure resource ID. ,
Required: True ,
}
string ,
customDomain:
{
Description: Represents the Azure resource custom domain. ,
Required: True ,
}
string ,
region:
{
Description: Represents the Azure resource region. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
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_UnassignDeploymentResources (updated)
Description :  Unassign resources from a project. This disallows deployment to these resources.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ConversationAuthoringProject_UnassignDeploymentResources",
  "Description": {
    "new": "Unassign resources from a project. This disallows deployment to these resources.",
    "old": "Unassign resources from a project. This disallows deploying new deployments to these resources, and deletes existing deployments assigned to them."
  },
  "$parameters": [
    {
      "#name": "body",
      "Description": {
        "new": "The list of Language or AIService Azure resource IDs to be unassigned.",
        "old": "The info for the deployment resources to be deleted."
      }
    }
  ]
}

⚼ Request

POST:  /authoring/analyze-conversations/projects/{projectName}/resources/:unassign
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project to use. ,
Required: True ,
}
string ,
body:
{
Description: The list of Language or AIService Azure resource IDs to be unassigned. ,
Required: True ,
}
{
assignedResourceIds:
{
Description: Represents the assigned resource IDs to be unassigned. ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (202)

{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
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_GetAssignDeploymentResourcesStatus (updated)
Description :  Gets the status of an existing assign project resources job.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ConversationAuthoringProject_GetAssignDeploymentResourcesStatus",
  "Description": {
    "new": "Gets the status of an existing assign project resources job.",
    "old": "Gets the status of an existing assign deployment resources job."
  },
  "$responses": {
    "200": {
      "Description": {
        "new": "Represents the state of a project resources job.",
        "old": "Represents the state of a deployment resources job."
      }
    }
  }
}

⚼ Request

GET:  /authoring/analyze-conversations/projects/{projectName}/resources/assign/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 ,
}
,
}
,
]
,
}

⚐ 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_GetUnassignDeploymentResourcesStatus (updated)
Description :  Gets the status of an existing unassign project resources job.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ConversationAuthoringProject_GetUnassignDeploymentResourcesStatus",
  "Description": {
    "new": "Gets the status of an existing unassign project resources job.",
    "old": "Gets the status of an existing unassign deployment resources job."
  },
  "$responses": {
    "200": {
      "Description": {
        "new": "Represents the state of a project resources job.",
        "old": "Represents the state of a deployment resources job."
      }
    }
  }
}

⚼ Request

GET:  /authoring/analyze-conversations/projects/{projectName}/resources/unassign/jobs/{jobId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the project to use. ,
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 ,
}
,
}
,
]
,
}

⚐ 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 ,
}
,
}
,
}
,
}