ConversationAuthoringClient Class

Definition

Namespace:: Azure.AI.Language.Conversations.Authoring

Assembly:: Azure.AI.Language.Conversations.dll

Package:: Azure.AI.Language.Conversations v1.1.0

Package:: Azure.AI.Language.Conversations v2.0.0-beta.5

Source:: ConversationAuthoringClient.cs

Source:: ConversationAuthoringClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Caution

This class is obsolete and and will be removed in a future release. Find more details here: https://aka.ms/language-conversations-sdk

The ConversationAuthoring service client.

public class ConversationAuthoringClient

[System.Obsolete("This class is obsolete and and will be removed in a future release. Find more details here: https://aka.ms/language-conversations-sdk", true)]
public class ConversationAuthoringClient

type ConversationAuthoringClient = class

[<System.Obsolete("This class is obsolete and and will be removed in a future release. Find more details here: https://aka.ms/language-conversations-sdk", true)>]
type ConversationAuthoringClient = class

Public Class ConversationAuthoringClient

Inheritance: Object
ConversationAuthoringClient

Attributes: ObsoleteAttribute

Remarks

See https://learn.microsoft.com/rest/api/language/2023-04-01/conversational-analysis-authoring for more information about models you can pass to this client.

Constructors

Name	Description
ConversationAuthoringClient()	Initializes a new instance of ConversationAuthoringClient for mocking.
ConversationAuthoringClient(Uri, AzureKeyCredential, ConversationsClientOptions)	Initializes a new instance of ConversationAuthoringClient.
ConversationAuthoringClient(Uri, AzureKeyCredential)	Initializes a new instance of ConversationAuthoringClient.
ConversationAuthoringClient(Uri, TokenCredential, ConversationsClientOptions)	Initializes a new instance of ConversationAuthoringClient
ConversationAuthoringClient(Uri, TokenCredential)	Initializes a new instance of ConversationAuthoringClient.

Properties

Name	Description
Endpoint	Gets the service endpoint for this client.
Pipeline	The HTTP pipeline for sending and receiving REST requests and responses.

Methods

Name	Description
CancelTrainingJob(WaitUntil, String, String, RequestContext)	[Protocol Method] Triggers a cancellation for a running training job. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CancelTrainingJobAsync(WaitUntil, String, String, RequestContext)	[Protocol Method] Triggers a cancellation for a running training job. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateProject(String, RequestContent, RequestContext)	[Protocol Method] Creates a new project or updates an existing one.
CreateProjectAsync(String, RequestContent, RequestContext)	[Protocol Method] Creates a new project or updates an existing one.
DeleteDeployment(WaitUntil, String, String, RequestContext)	[Protocol Method] Deletes a project deployment. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteDeploymentAsync(WaitUntil, String, String, RequestContext)	[Protocol Method] Deletes a project deployment. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteProject(WaitUntil, String, RequestContext)	[Protocol Method] Deletes a project. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteProjectAsync(WaitUntil, String, RequestContext)	[Protocol Method] Deletes a project. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteTrainedModel(String, String, RequestContext)	[Protocol Method] Deletes an existing trained model. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteTrainedModelAsync(String, String, RequestContext)	[Protocol Method] Deletes an existing trained model. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeployProject(WaitUntil, String, String, RequestContent, RequestContext)	[Protocol Method] Creates a new deployment or replaces an existing one. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeployProjectAsync(WaitUntil, String, String, RequestContent, RequestContext)	[Protocol Method] Creates a new deployment or replaces an existing one. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
ExportProject(WaitUntil, String, String, String, String, String, RequestContext)	[Protocol Method] Triggers a job to export a project's data. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
ExportProjectAsync(WaitUntil, String, String, String, String, String, RequestContext)	[Protocol Method] Triggers a job to export a project's data. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetDeployment(String, String, RequestContext)	Gets the deployment details for a specified project and deployment name.
GetDeploymentAsync(String, String, RequestContext)	Asynchronously gets the deployment details for a specified project and deployment name.
GetDeploymentJobStatus(String, String, String, RequestContext)	[Protocol Method] Gets the status of an existing deployment job. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetDeploymentJobStatusAsync(String, String, String, RequestContext)	[Protocol Method] Gets the status of an existing deployment job. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetDeployments(String, RequestContext)	[Protocol Method] Lists the deployments belonging to a project. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetDeploymentsAsync(String, RequestContext)	[Protocol Method] Lists the deployments belonging to a project. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetExportProjectJobStatus(String, String, RequestContext)	[Protocol Method] Gets the status of an export job. Once job completes, returns the project metadata, and assets. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetExportProjectJobStatusAsync(String, String, RequestContext)	[Protocol Method] Gets the status of an export job. Once job completes, returns the project metadata, and assets. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetImportProjectJobStatus(String, String, RequestContext)	[Protocol Method] Gets the status for an import. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetImportProjectJobStatusAsync(String, String, RequestContext)	[Protocol Method] Gets the status for an import. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetLoadSnapshotJobStatus(String, String, String, RequestContext)	[Protocol Method] Gets the status for loading a snapshot. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetLoadSnapshotJobStatusAsync(String, String, String, RequestContext)	[Protocol Method] Gets the status for loading a snapshot. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetModelEvaluationResults(String, String, String, RequestContext)	[Protocol Method] Gets the detailed results of the evaluation for a trained model. This includes the raw inference results for the data included in the evaluation process. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetModelEvaluationResultsAsync(String, String, String, RequestContext)	[Protocol Method] Gets the detailed results of the evaluation for a trained model. This includes the raw inference results for the data included in the evaluation process. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetModelEvaluationSummary(String, String, RequestContext)	[Protocol Method] Gets the evaluation summary of a trained model. The summary includes high level performance measurements of the model e.g., F1, Precision, Recall, etc. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetModelEvaluationSummaryAsync(String, String, RequestContext)	[Protocol Method] Gets the evaluation summary of a trained model. The summary includes high level performance measurements of the model e.g., F1, Precision, Recall, etc. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetProject(String, RequestContext)	[Protocol Method] Gets the details of the projects.
GetProjectAsync(String, RequestContext)	[Protocol Method] Gets the details of the projects.
GetProjectDeletionJobStatus(String, RequestContext)	[Protocol Method] Gets the status for a project deletion job. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetProjectDeletionJobStatusAsync(String, RequestContext)	[Protocol Method] Gets the status for a project deletion job. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetProjects(RequestContext)	[Protocol Method] Lists the existing projects. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetProjectsAsync(RequestContext)	[Protocol Method] Lists the existing projects. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetSupportedLanguages(String, RequestContext)	[Protocol Method] Lists the supported languages for the given project type. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetSupportedLanguagesAsync(String, RequestContext)	[Protocol Method] Lists the supported languages for the given project type. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetSupportedPrebuiltEntities(String, Nullable<Boolean>, RequestContext)	[Protocol Method] Lists the supported prebuilt entities that can be used while creating composed entities. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetSupportedPrebuiltEntitiesAsync(String, Nullable<Boolean>, RequestContext)	[Protocol Method] Lists the supported prebuilt entities that can be used while creating composed entities. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetSwapDeploymentsJobStatus(String, String, RequestContext)	[Protocol Method] Gets the status of an existing swap deployment job. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetSwapDeploymentsJobStatusAsync(String, String, RequestContext)	[Protocol Method] Gets the status of an existing swap deployment job. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetTrainedModel(String, String, RequestContext)	[Protocol Method] Gets the details of a trained model. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetTrainedModelAsync(String, String, RequestContext)	[Protocol Method] Gets the details of a trained model. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetTrainedModels(String, RequestContext)	[Protocol Method] Lists the trained models belonging to a project. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetTrainedModelsAsync(String, RequestContext)	[Protocol Method] Lists the trained models belonging to a project. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetTrainingConfigVersions(String, RequestContext)	[Protocol Method] Lists the support training config version for a given project type. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetTrainingConfigVersionsAsync(String, RequestContext)	[Protocol Method] Lists the support training config version for a given project type. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetTrainingJobs(String, RequestContext)	[Protocol Method] Lists the non-expired training jobs created for a project. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetTrainingJobsAsync(String, RequestContext)	[Protocol Method] Lists the non-expired training jobs created for a project. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetTrainingJobStatus(String, String, RequestContext)	[Protocol Method] Gets the status for a training job. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetTrainingJobStatusAsync(String, String, RequestContext)	[Protocol Method] Gets the status for a training job. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
ImportProject(WaitUntil, String, RequestContent, String, RequestContext)	[Protocol Method] Triggers a job to import a project. If a project with the same name already exists, the data of that project is replaced. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
ImportProjectAsync(WaitUntil, String, RequestContent, String, RequestContext)	[Protocol Method] Triggers a job to import a project. If a project with the same name already exists, the data of that project is replaced. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
LoadSnapshot(WaitUntil, String, String, RequestContext)	[Protocol Method] Restores the snapshot of this trained model to be the current working directory of the project. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
LoadSnapshotAsync(WaitUntil, String, String, RequestContext)	[Protocol Method] Restores the snapshot of this trained model to be the current working directory of the project. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
SwapDeployments(WaitUntil, String, RequestContent, RequestContext)	[Protocol Method] Swaps two existing deployments with each other. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
SwapDeploymentsAsync(WaitUntil, String, RequestContent, RequestContext)	[Protocol Method] Swaps two existing deployments with each other. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
Train(WaitUntil, String, RequestContent, RequestContext)	[Protocol Method] Triggers a training job for a project. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
TrainAsync(WaitUntil, String, RequestContent, RequestContext)	[Protocol Method] Triggers a training job for a project. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

Applies to

Feedback

Was this page helpful?