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

2025/09/11 • 6 updated methods

TextAnalysisAuthoringListProjects (updated)
Description :  Lists the existing projects.
Reference :  Link ¶

⚶ Changes

{
  "#id": "TextAnalysisAuthoringListProjects",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "@removed_f2eb49c4f2f3479baa3973f7bc187593": {
              "#name": "storageAccountResourceId",
              "Description": "The project storage account resource ID.",
              "Required": false,
              "Type": "string"
            }
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /authoring/analyze-text/projects
{
api-version:
{
Description: The API version to use for this operation. ,
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 TextAnalysisAuthoringProjectMetadata items on this page ,
Required: True ,
}
[
{
createdDateTime:
{
Description: Represents the project creation datetime. ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedDateTime:
{
Description: Represents the project last modification datetime. ,
Format: date-time ,
Required: True ,
}
string ,
lastTrainedDateTime:
{
Description: Represents the project last training datetime. ,
Format: date-time ,
Required: False ,
}
string ,
lastDeployedDateTime:
{
Description: Represents the project last deployment datetime. ,
Format: date-time ,
Required: False ,
}
string ,
projectKind:
{
Description: The project kind. ,
Enum:
{
CustomSingleLabelClassification: For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B. ,
CustomMultiLabelClassification: For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C. ,
CustomEntityRecognition: For building an extraction model to identify your domain categories using your own data. ,
CustomAbstractiveSummarization: For building an abstractive summarization models which are able to summarize long documents. ,
CustomHealthcare: For building an text analytics for health model to identify your health domain data. ,
CustomTextSentiment: For building a sentiment models which are able to extract sentiment for long documents. ,
}
,
Required: True ,
}
enum ,
storageInputContainerName:
{
Description: The storage container name. ,
Required: True ,
}
string ,
settings:
{
Description: The project settings. ,
Required: False ,
}
{
confidenceThreshold:
{
Description: The threshold of the class with the highest confidence, at which the prediction will automatically be changed to "None". The value of the threshold should be between 0 and 1 inclusive. ,
Format: float ,
Required: False ,
}
number ,
amlProjectPath:
{
Description: The path to the AML connected project. ,
Required: False ,
}
string ,
isLabelingLocked:
{
Description: Indicates whether the labeling experience can be modified or not. ,
Required: False ,
}
boolean ,
runGptPredictions:
{
Description: Indicates whether to run GPT predictions or not. ,
Required: False ,
}
boolean ,
gptPredictiveLookahead:
{
Description: The predictive lookahead for GPT predictions that is specified by the user. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
multilingual:
{
Description: Whether the project would be used for multiple languages or not. ,
Required: False ,
}
boolean ,
description:
{
Description: The project description. ,
Required: False ,
}
string ,
language:
{
Description: The project language. This is BCP-47 representation of a language. For example, use "en" for English, "en-gb" for English (UK), "es" for Spanish etc. ,
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 ,
}
,
}
,
}
,
}
TextAuthoringProject_GetProject (updated)
Description :  Gets the details of a project.
Reference :  Link ¶

⚶ Changes

{
  "#id": "TextAuthoringProject_GetProject",
  "$responses": {
    "200": {
      "$properties": {
        "@removed_e9cf318668344a2ba082443f4df4651f": {
          "#name": "storageAccountResourceId",
          "Description": "The project storage account resource ID.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ Request

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

⚐ Response (200)

{
createdDateTime:
{
Description: Represents the project creation datetime. ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedDateTime:
{
Description: Represents the project last modification datetime. ,
Format: date-time ,
Required: True ,
}
string ,
lastTrainedDateTime:
{
Description: Represents the project last training datetime. ,
Format: date-time ,
Required: False ,
}
string ,
lastDeployedDateTime:
{
Description: Represents the project last deployment datetime. ,
Format: date-time ,
Required: False ,
}
string ,
projectKind:
{
Description: The project kind. ,
Enum:
{
CustomSingleLabelClassification: For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B. ,
CustomMultiLabelClassification: For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C. ,
CustomEntityRecognition: For building an extraction model to identify your domain categories using your own data. ,
CustomAbstractiveSummarization: For building an abstractive summarization models which are able to summarize long documents. ,
CustomHealthcare: For building an text analytics for health model to identify your health domain data. ,
CustomTextSentiment: For building a sentiment models which are able to extract sentiment for long documents. ,
}
,
Required: True ,
}
enum ,
storageInputContainerName:
{
Description: The storage container name. ,
Required: True ,
}
string ,
settings:
{
Description: The project settings. ,
Required: False ,
}
{
confidenceThreshold:
{
Description: The threshold of the class with the highest confidence, at which the prediction will automatically be changed to "None". The value of the threshold should be between 0 and 1 inclusive. ,
Format: float ,
Required: False ,
}
number ,
amlProjectPath:
{
Description: The path to the AML connected project. ,
Required: False ,
}
string ,
isLabelingLocked:
{
Description: Indicates whether the labeling experience can be modified or not. ,
Required: False ,
}
boolean ,
runGptPredictions:
{
Description: Indicates whether to run GPT predictions or not. ,
Required: False ,
}
boolean ,
gptPredictiveLookahead:
{
Description: The predictive lookahead for GPT predictions that is specified by the user. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
multilingual:
{
Description: Whether the project would be used for multiple languages or not. ,
Required: False ,
}
boolean ,
description:
{
Description: The project description. ,
Required: False ,
}
string ,
language:
{
Description: The project language. This is BCP-47 representation of a language. For example, use "en" for English, "en-gb" for English (UK), "es" for Spanish etc. ,
Required: True ,
}
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 ,
}
,
}
,
}
,
}
TextAuthoringProject_CreateProject (updated)
Description :  The most basic operation that applies to a resource.
Reference :  Link ¶

⚶ Changes

{
  "#id": "TextAuthoringProject_CreateProject",
  "$responses": {
    "200": {
      "$properties": {
        "@removed_202adfb487fd4e3a95da27b7d0d650c6": {
          "#name": "storageAccountResourceId",
          "Description": "The project storage account resource ID.",
          "Required": false,
          "Type": "string"
        }
      }
    },
    "201": {
      "$properties": {
        "@removed_700f7ead71734e8492642ce35ffce88b": {
          "#name": "storageAccountResourceId",
          "Description": "The project storage account resource ID.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ Request

PATCH:  /authoring/analyze-text/projects/{projectName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
body:
{
Description: The request body ,
Required: True ,
}
{
projectKind:
{
Description: The project kind. ,
Enum:
{
CustomSingleLabelClassification: For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B. ,
CustomMultiLabelClassification: For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C. ,
CustomEntityRecognition: For building an extraction model to identify your domain categories using your own data. ,
CustomAbstractiveSummarization: For building an abstractive summarization models which are able to summarize long documents. ,
CustomHealthcare: For building an text analytics for health model to identify your health domain data. ,
CustomTextSentiment: For building a sentiment models which are able to extract sentiment for long documents. ,
}
,
Required: True ,
}
enum ,
storageInputContainerName:
{
Description: The storage container name. ,
Required: True ,
}
string ,
settings:
{
Description: The project settings. ,
Required: False ,
}
{
confidenceThreshold:
{
Description: The threshold of the class with the highest confidence, at which the prediction will automatically be changed to "None". The value of the threshold should be between 0 and 1 inclusive. ,
Format: float ,
Required: False ,
}
number ,
amlProjectPath:
{
Description: The path to the AML connected project. ,
Required: False ,
}
string ,
isLabelingLocked:
{
Description: Indicates whether the labeling experience can be modified or not. ,
Required: False ,
}
boolean ,
runGptPredictions:
{
Description: Indicates whether to run GPT predictions or not. ,
Required: False ,
}
boolean ,
gptPredictiveLookahead:
{
Description: The predictive lookahead for GPT predictions that is specified by the user. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
multilingual:
{
Description: Whether the project would be used for multiple languages or not. ,
Required: False ,
}
boolean ,
description:
{
Description: The project description. ,
Required: False ,
}
string ,
language:
{
Description: The project language. This is BCP-47 representation of a language. For example, use "en" for English, "en-gb" for English (UK), "es" for Spanish etc. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
createdDateTime:
{
Description: Represents the project creation datetime. ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedDateTime:
{
Description: Represents the project last modification datetime. ,
Format: date-time ,
Required: True ,
}
string ,
lastTrainedDateTime:
{
Description: Represents the project last training datetime. ,
Format: date-time ,
Required: False ,
}
string ,
lastDeployedDateTime:
{
Description: Represents the project last deployment datetime. ,
Format: date-time ,
Required: False ,
}
string ,
projectKind:
{
Description: The project kind. ,
Enum:
{
CustomSingleLabelClassification: For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B. ,
CustomMultiLabelClassification: For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C. ,
CustomEntityRecognition: For building an extraction model to identify your domain categories using your own data. ,
CustomAbstractiveSummarization: For building an abstractive summarization models which are able to summarize long documents. ,
CustomHealthcare: For building an text analytics for health model to identify your health domain data. ,
CustomTextSentiment: For building a sentiment models which are able to extract sentiment for long documents. ,
}
,
Required: True ,
}
enum ,
storageInputContainerName:
{
Description: The storage container name. ,
Required: True ,
}
string ,
settings:
{
Description: The project settings. ,
Required: False ,
}
{
confidenceThreshold:
{
Description: The threshold of the class with the highest confidence, at which the prediction will automatically be changed to "None". The value of the threshold should be between 0 and 1 inclusive. ,
Format: float ,
Required: False ,
}
number ,
amlProjectPath:
{
Description: The path to the AML connected project. ,
Required: False ,
}
string ,
isLabelingLocked:
{
Description: Indicates whether the labeling experience can be modified or not. ,
Required: False ,
}
boolean ,
runGptPredictions:
{
Description: Indicates whether to run GPT predictions or not. ,
Required: False ,
}
boolean ,
gptPredictiveLookahead:
{
Description: The predictive lookahead for GPT predictions that is specified by the user. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
multilingual:
{
Description: Whether the project would be used for multiple languages or not. ,
Required: False ,
}
boolean ,
description:
{
Description: The project description. ,
Required: False ,
}
string ,
language:
{
Description: The project language. This is BCP-47 representation of a language. For example, use "en" for English, "en-gb" for English (UK), "es" for Spanish etc. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
createdDateTime:
{
Description: Represents the project creation datetime. ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedDateTime:
{
Description: Represents the project last modification datetime. ,
Format: date-time ,
Required: True ,
}
string ,
lastTrainedDateTime:
{
Description: Represents the project last training datetime. ,
Format: date-time ,
Required: False ,
}
string ,
lastDeployedDateTime:
{
Description: Represents the project last deployment datetime. ,
Format: date-time ,
Required: False ,
}
string ,
projectKind:
{
Description: The project kind. ,
Enum:
{
CustomSingleLabelClassification: For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B. ,
CustomMultiLabelClassification: For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C. ,
CustomEntityRecognition: For building an extraction model to identify your domain categories using your own data. ,
CustomAbstractiveSummarization: For building an abstractive summarization models which are able to summarize long documents. ,
CustomHealthcare: For building an text analytics for health model to identify your health domain data. ,
CustomTextSentiment: For building a sentiment models which are able to extract sentiment for long documents. ,
}
,
Required: True ,
}
enum ,
storageInputContainerName:
{
Description: The storage container name. ,
Required: True ,
}
string ,
settings:
{
Description: The project settings. ,
Required: False ,
}
{
confidenceThreshold:
{
Description: The threshold of the class with the highest confidence, at which the prediction will automatically be changed to "None". The value of the threshold should be between 0 and 1 inclusive. ,
Format: float ,
Required: False ,
}
number ,
amlProjectPath:
{
Description: The path to the AML connected project. ,
Required: False ,
}
string ,
isLabelingLocked:
{
Description: Indicates whether the labeling experience can be modified or not. ,
Required: False ,
}
boolean ,
runGptPredictions:
{
Description: Indicates whether to run GPT predictions or not. ,
Required: False ,
}
boolean ,
gptPredictiveLookahead:
{
Description: The predictive lookahead for GPT predictions that is specified by the user. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
multilingual:
{
Description: Whether the project would be used for multiple languages or not. ,
Required: False ,
}
boolean ,
description:
{
Description: The project description. ,
Required: False ,
}
string ,
language:
{
Description: The project language. This is BCP-47 representation of a language. For example, use "en" for English, "en-gb" for English (UK), "es" for Spanish etc. ,
Required: True ,
}
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 ,
}
,
}
,
}
,
}
TextAnalysisAuthoringListDeployments (updated)
Description :  Lists the deployments belonging to a project.
Reference :  Link ¶

⚶ Changes

{
  "#id": "TextAnalysisAuthoringListDeployments",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "assignedResources": {
              "$properties": {
                "@removed_14590efdbf334661a3541aea6b0a1b8a": {
                  "#name": "assignedAoaiResource",
                  "Description": "Represents the AOAI resource assigned for data generation.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "kind",
                      "Description": "Connection type for data generation settings. Currently only supports Azure Open AI.",
                      "Enum": [
                        [
                          "AzureOpenAI",
                          ""
                        ]
                      ],
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "resourceId",
                      "Description": "Resource ID for the data generation resource. Looks something like \"/subscriptions//resourceGroups//providers/Microsoft.CognitiveServices/accounts/\".",
                      "Required": true,
                      "Type": "string"
                    },
                    {
                      "#name": "deploymentName",
                      "Description": "Deployment name of model to be used for synthetic data generation.",
                      "Required": true,
                      "Type": "string"
                    }
                  ]
                }
              }
            }
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/deployments
{
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 TextAnalysisAuthoringProjectDeployment items on this page ,
Required: True ,
}
[
{
deploymentName:
{
Description: Represents deployment name. ,
Required: True ,
}
string ,
modelId:
{
Description: Represents deployment modelId. ,
Required: True ,
}
string ,
lastTrainedDateTime:
{
Description: Represents deployment last trained time. ,
Format: date-time ,
Required: True ,
}
string ,
lastDeployedDateTime:
{
Description: Represents deployment last deployed time. ,
Format: date-time ,
Required: True ,
}
string ,
deploymentExpirationDate:
{
Description: Represents deployment expiration date in the runtime. ,
Format: date ,
Required: True ,
}
string ,
modelTrainingConfigVersion:
{
Description: Represents model training config version. ,
Required: True ,
}
string ,
assignedResources:
{
Description: Represents the metadata of the assigned Azure resources. ,
Required: True ,
}
[
{
resourceId:
{
Description: Represents the Azure resource Id. ,
Required: True ,
}
string ,
region:
{
Description: Represents the 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 ,
}
,
}
,
}
,
}
TextAuthoringDeployment_GetDeployment (updated)
Description :  Gets the details of a deployment.
Reference :  Link ¶

⚶ Changes

{
  "#id": "TextAuthoringDeployment_GetDeployment",
  "$responses": {
    "200": {
      "$properties": {
        "assignedResources": {
          "$properties": {
            "@removed_51fc6ceaa75e4fa481f13f5d37a6c922": {
              "#name": "assignedAoaiResource",
              "Description": "Represents the AOAI resource assigned for data generation.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "kind",
                  "Description": "Connection type for data generation settings. Currently only supports Azure Open AI.",
                  "Enum": [
                    [
                      "AzureOpenAI",
                      ""
                    ]
                  ],
                  "Required": true,
                  "Type": "string"
                },
                {
                  "#name": "resourceId",
                  "Description": "Resource ID for the data generation resource. Looks something like \"/subscriptions//resourceGroups//providers/Microsoft.CognitiveServices/accounts/\".",
                  "Required": true,
                  "Type": "string"
                },
                {
                  "#name": "deploymentName",
                  "Description": "Deployment name of model to be used for synthetic data generation.",
                  "Required": true,
                  "Type": "string"
                }
              ]
            }
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
projectName:
{
Description: The new project name. ,
Required: True ,
}
string ,
deploymentName:
{
Description: Represents deployment name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
deploymentName:
{
Description: Represents deployment name. ,
Required: True ,
}
string ,
modelId:
{
Description: Represents deployment modelId. ,
Required: True ,
}
string ,
lastTrainedDateTime:
{
Description: Represents deployment last trained time. ,
Format: date-time ,
Required: True ,
}
string ,
lastDeployedDateTime:
{
Description: Represents deployment last deployed time. ,
Format: date-time ,
Required: True ,
}
string ,
deploymentExpirationDate:
{
Description: Represents deployment expiration date in the runtime. ,
Format: date ,
Required: True ,
}
string ,
modelTrainingConfigVersion:
{
Description: Represents model training config version. ,
Required: True ,
}
string ,
assignedResources:
{
Description: Represents the metadata of the assigned Azure resources. ,
Required: True ,
}
[
{
resourceId:
{
Description: Represents the Azure resource Id. ,
Required: True ,
}
string ,
region:
{
Description: Represents the resource region. ,
Required: True ,
}
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 ,
}
,
}
,
}
,
}
TextAuthoringDeployment_DeployProject (updated)
Description :  Creates a new deployment or replaces an existing one.
Reference :  Link ¶

⚶ Changes

{
  "#id": "TextAuthoringDeployment_DeployProject",
  "$parameters": {
    "body": {
      "$properties": {
        "@added_6f957d4390114452afc5f41f5dee6f0f": {
          "#name": "assignedResourceIds",
          "Description": "Represents the resource IDs to be assigned to the deployment. If provided, the deployment will be rolled out to the resources provided here as well as the original resource in which the project is created.",
          "Required": false,
          "Type": "array",
          "$items": {
            "Type": "string"
          }
        },
        "@removed_8467f5a458394b90b861d746ee469371": {
          "#name": "assignedResources",
          "Description": "Represents the resources to be assigned to the deployment. If provided, the deployment will be rolled out to the resources provided here as well as the original resource in which the project is created.",
          "Required": false,
          "Type": "array",
          "$items": {
            "Description": "Represents an Azure resource assigned to a deployment.",
            "Type": "object",
            "$properties": [
              {
                "#name": "resourceId",
                "Description": "Represents the Azure resource Id.",
                "Required": true,
                "Type": "string"
              },
              {
                "#name": "region",
                "Description": "Represents the resource region.",
                "Required": true,
                "Type": "string"
              },
              {
                "#name": "assignedAoaiResource",
                "Description": "Represents the AOAI resource assigned for data generation.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "kind",
                    "Description": "Connection type for data generation settings. Currently only supports Azure Open AI.",
                    "Enum": [
                      [
                        "AzureOpenAI",
                        ""
                      ]
                    ],
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "resourceId",
                    "Description": "Resource ID for the data generation resource. Looks something like \"/subscriptions//resourceGroups//providers/Microsoft.CognitiveServices/accounts/\".",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "deploymentName",
                    "Description": "Deployment name of model to be used for synthetic data generation.",
                    "Required": true,
                    "Type": "string"
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

PUT:  /authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}
{
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 new deployment info. ,
Required: True ,
}
{
trainedModelLabel:
{
Description: Represents the trained model label. ,
Required: True ,
}
string ,
assignedResourceIds:
{
Description: Represents the resource IDs to be assigned to the deployment. If provided, the deployment will be rolled out to the resources provided here as well as the original resource in which the project is created. ,
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 ,
}
,
}
,
}
,
}