Microsoft Cognitive Language Service - Analyze Conversations Authoring (preview:2024-11-15)

2025/03/24 • 10 new methods

ConversationAuthoringListProjects (new)
Description :  Lists the existing projects.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-conversations/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 AnalyzeConversationAuthoringProjectMetadata items on this page ,
Required: True ,
}
[
{
createdDateTime:
{
Description: Represents the project creation datetime. ,
Format: date-time ,
Required: True ,
}
string ,
lastModifiedDateTime:
{
Description: Represents the project creation datetime. ,
Format: date-time ,
Required: True ,
}
string ,
lastTrainedDateTime:
{
Description: Represents the project last trained datetime. ,
Format: date-time ,
Required: False ,
}
string ,
lastDeployedDateTime:
{
Description: Represents the project last deployed datetime. ,
Format: date-time ,
Required: False ,
}
string ,
projectKind:
{
Description: Represents the project kind. ,
Enum:
{
Conversation: A project to build natural language into apps, bots, and IoT devices. ,
Orchestration: A project to connect and orchestrate Conversation, Custom question answering and LUIS projects together in one single project. ,
CustomConversationSummarization: A project to build conversation summarization models which are able to summarize long conversations. ,
}
,
Required: True ,
}
enum ,
settings:
{
Description: The project settings. ,
Required: False ,
}
{
confidenceThreshold:
{
Description: The threshold of the intent 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: True ,
}
number ,
}
,
storageInputContainerName:
{
Description: The storage container name in case of conversation summarization. ,
Required: False ,
}
string ,
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 ,
}
,
}
,
}
,
}
ConversationAuthoringListDeployments (new)
Description :  Lists the deployments belonging to a project.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-conversations/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 AnalyzeConversationAuthoringProjectDeployment 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 ,
}
,
}
,
}
,
}
ConversationAuthoringListExportedModels (new)
Description :  Lists the exported models belonging to a project.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-conversations/projects/{projectName}/exported-models
{
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 AnalyzeConversationAuthoringExportedTrainedModel items on this page ,
Required: True ,
}
[
{
exportedModelName:
{
Description: The exported model name. ,
Required: True ,
}
string ,
modelId:
{
Description: The model ID. ,
Required: True ,
}
string ,
lastTrainedDateTime:
{
Description: The last trained date time of the model. ,
Format: date-time ,
Required: True ,
}
string ,
lastExportedModelDateTime:
{
Description: The last exported date time of the model. ,
Format: date-time ,
Required: True ,
}
string ,
modelExpirationDate:
{
Description: The model expiration date. ,
Format: date ,
Required: True ,
}
string ,
modelTrainingConfigVersion:
{
Description: The model training config version. ,
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 ,
}
,
}
,
}
,
}
ConversationAuthoringListTrainedModels (new)
Description :  Lists the trained models belonging to a project.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-conversations/projects/{projectName}/models
{
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 AnalyzeConversationAuthoringProjectTrainedModel items on this page ,
Required: True ,
}
[
{
label:
{
Description: The trained model label. ,
Required: True ,
}
string ,
modelId:
{
Description: The model ID. ,
Required: True ,
}
string ,
lastTrainedDateTime:
{
Description: The last trained date time of the model. ,
Format: date-time ,
Required: True ,
}
string ,
lastTrainingDurationInSeconds:
{
Description: The duration of the model's last training request in seconds. ,
Format: int32 ,
Required: True ,
}
integer ,
modelExpirationDate:
{
Description: The model expiration date. ,
Format: date ,
Required: True ,
}
string ,
modelTrainingConfigVersion:
{
Description: The model training config version. ,
Required: True ,
}
string ,
hasSnapshot:
{
Description: The flag to indicate if the trained model has a snapshot ready. ,
Required: True ,
}
boolean ,
}
,
]
,
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 ,
}
,
}
,
}
,
}
ConversationAuthoringListDeploymentResources (new)
Description :  Lists the deployments resources assigned to the project.
Reference :  Link ¶

⚼ 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 resource ID. ,
Required: True ,
}
string ,
region:
{
Description: 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 ,
}
,
}
,
}
,
}
ConversationAuthoringListTrainingJobs (new)
Description :  Lists the non-expired training jobs created for a project.
Reference :  Link ¶

⚼ 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 ,
}
,
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 ,
}
,
}
,
}
,
}
ConversationAuthoringListAssignedResourceDeployments (new)
Description :  Lists the deployments to which an Azure resource is assigned. This doesn't return deployments belonging to projects owned by this resource. It only returns deployments belonging to projects owned by other resources.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-conversations/projects/global/deployments/resources
{
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 AnalyzeConversationAuthoringAssignedProjectDeploymentsMetadata items on this page ,
Required: True ,
}
[
{
projectName:
{
Description: Represents the project name. ,
Required: True ,
}
string ,
deploymentsMetadata:
{
Description: Represents the resource region. ,
Required: True ,
}
[
{
deploymentName:
{
Description: Represents the deployment name. ,
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 ,
}
,
]
,
}
,
]
,
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 ,
}
,
}
,
}
,
}
ConversationAuthoringListSupportedLanguages (new)
Description :  Lists the supported languages for the given project type.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-conversations/projects/global/languages
{
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 ,
projectKind:
{
Description: The project kind. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The AnalyzeConversationAuthoringSupportedLanguage items on this page ,
Required: True ,
}
[
{
languageName:
{
Description: The language name. ,
Required: True ,
}
string ,
languageCode:
{
Description: The language code. This is BCP-47 representation of a language. For example, "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 ,
}
,
}
,
}
,
}
ConversationAuthoringListSupportedPrebuiltEntities (new)
Description :  Lists the supported prebuilt entities that can be used while creating composed entities.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-conversations/projects/global/prebuilt-entities
{
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 ,
language:
{
Description: The language to get supported prebuilt entities for. Required if multilingual is false. This is BCP-47 representation of a language. For example, use "en" for English, "en-gb" for English (UK), "es" for Spanish etc. ,
Required: False ,
}
string ,
multilingual:
{
Description: Whether to get the support prebuilt entities for multilingual or monolingual projects. If true, the language parameter is ignored. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The AnalyzeConversationAuthoringPrebuiltEntity items on this page ,
Required: True ,
}
[
{
category:
{
Description: The prebuilt entity category. ,
Required: True ,
}
string ,
description:
{
Description: The description. ,
Required: True ,
}
string ,
examples:
{
Description: English examples for the entity. ,
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 ,
}
,
}
,
}
,
}
ConversationAuthoringListTrainingConfigVersions (new)
Description :  Lists the support training config version for a given project type.
Reference :  Link ¶

⚼ Request

GET:  /authoring/analyze-conversations/projects/global/training-config-versions
{
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 ,
projectKind:
{
Description: The project kind. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The AnalyzeConversationAuthoringTrainingConfigVersion items on this page ,
Required: True ,
}
[
{
trainingConfigVersion:
{
Description: Represents the version of the config. ,
Required: True ,
}
string ,
modelExpirationDate:
{
Description: Represents the training config version expiration date. ,
Format: date ,
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 ,
}
,
}
,
}
,
}