TextAuthoringProject Class

Definition

Namespace:: Azure.AI.Language.Text.Authoring

Assembly:: Azure.AI.Language.Text.Authoring.dll

Package:: Azure.AI.Language.Text.Authoring v1.0.0-beta.1

Source:: TextAuthoringProject.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.

The TextAuthoringProject sub-client.

public class TextAuthoringProject

type TextAuthoringProject = class

Public Class TextAuthoringProject

Inheritance: Object
TextAuthoringProject

Constructors

TextAuthoringProject()

Initializes a new instance of TextAuthoringProject for mocking.

Properties

Pipeline

The HTTP pipeline for sending and receiving REST requests and responses.

Methods

AssignDeploymentResources(WaitUntil, RequestContent, RequestContext)	[Protocol Method] 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 This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler AssignDeploymentResources(WaitUntil, TextAuthoringAssignDeploymentResourcesDetails, CancellationToken) convenience overload with strongly typed models first.
AssignDeploymentResources(WaitUntil, TextAuthoringAssignDeploymentResourcesDetails, CancellationToken)	Assign new Azure resources to a project to allow deploying new deployments to them.
AssignDeploymentResourcesAsync(WaitUntil, RequestContent, RequestContext)	[Protocol Method] 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 This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler AssignDeploymentResourcesAsync(WaitUntil, TextAuthoringAssignDeploymentResourcesDetails, CancellationToken) convenience overload with strongly typed models first.
AssignDeploymentResourcesAsync(WaitUntil, TextAuthoringAssignDeploymentResourcesDetails, CancellationToken)	Assign new Azure resources to a project to allow deploying new deployments to them.
AuthorizeProjectCopy(RequestContent, RequestContext)	[Protocol Method] Generates a copy project operation authorization to the current target Azure resource. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler AuthorizeProjectCopy(TextAuthoringProjectKind, String, Nullable<Boolean>, CancellationToken) convenience overload with strongly typed models first.
AuthorizeProjectCopy(TextAuthoringProjectKind, String, Nullable<Boolean>, CancellationToken)	Generates a copy project operation authorization to the current target Azure resource.
AuthorizeProjectCopyAsync(RequestContent, RequestContext)	[Protocol Method] Generates a copy project operation authorization to the current target Azure resource. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler AuthorizeProjectCopyAsync(TextAuthoringProjectKind, String, Nullable<Boolean>, CancellationToken) convenience overload with strongly typed models first.
AuthorizeProjectCopyAsync(TextAuthoringProjectKind, String, Nullable<Boolean>, CancellationToken)	Generates a copy project operation authorization to the current target Azure resource.
CancelTrainingJob(WaitUntil, String, CancellationToken)	Triggers a cancellation for a running training job.
CancelTrainingJob(WaitUntil, 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. Please try the simpler CancelTrainingJob(WaitUntil, String, CancellationToken) convenience overload with strongly typed models first.
CancelTrainingJobAsync(WaitUntil, String, CancellationToken)	Triggers a cancellation for a running training job.
CancelTrainingJobAsync(WaitUntil, 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. Please try the simpler CancelTrainingJobAsync(WaitUntil, String, CancellationToken) convenience overload with strongly typed models first.
CopyProject(WaitUntil, RequestContent, RequestContext)	[Protocol Method] Copies an existing project to another Azure resource. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler CopyProject(WaitUntil, TextAuthoringCopyProjectDetails, CancellationToken) convenience overload with strongly typed models first.
CopyProject(WaitUntil, TextAuthoringCopyProjectDetails, CancellationToken)	Copies an existing project to another Azure resource.
CopyProjectAsync(WaitUntil, RequestContent, RequestContext)	[Protocol Method] Copies an existing project to another Azure resource. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler CopyProjectAsync(WaitUntil, TextAuthoringCopyProjectDetails, CancellationToken) convenience overload with strongly typed models first.
CopyProjectAsync(WaitUntil, TextAuthoringCopyProjectDetails, CancellationToken)	Copies an existing project to another Azure resource.
CreateProject(RequestContent, RequestContext)	[Protocol Method] Creates a new project or updates an existing one.
CreateProject(TextAuthoringCreateProjectDetails, CancellationToken)	Creates a new deployment or replaces an existing one.
CreateProjectAsync(RequestContent, RequestContext)	[Protocol Method] Creates a new project or updates an existing one.
CreateProjectAsync(TextAuthoringCreateProjectDetails, CancellationToken)	Creates a new deployment or replaces an existing one.
DeleteProject(WaitUntil, RequestContext)	[Protocol Method] Deletes a project.
DeleteProjectAsync(WaitUntil, RequestContext)	[Protocol Method] Deletes a project.
Export(WaitUntil, 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. Please try the simpler Export(WaitUntil, StringIndexType, String, String, CancellationToken) convenience overload with strongly typed models first.
Export(WaitUntil, StringIndexType, String, String, CancellationToken)	Triggers a job to export a project's data.
ExportAsync(WaitUntil, 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. Please try the simpler ExportAsync(WaitUntil, StringIndexType, String, String, CancellationToken) convenience overload with strongly typed models first.
ExportAsync(WaitUntil, StringIndexType, String, String, CancellationToken)	Triggers a job to export a project's data.
GetAssignDeploymentResourcesStatus(String, CancellationToken)	Gets the status of an existing assign deployment resources job.
GetAssignDeploymentResourcesStatus(String, RequestContext)	[Protocol Method] Gets the status of an existing assign deployment resources job. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetAssignDeploymentResourcesStatus(String, CancellationToken) convenience overload with strongly typed models first.
GetAssignDeploymentResourcesStatusAsync(String, CancellationToken)	Gets the status of an existing assign deployment resources job.
GetAssignDeploymentResourcesStatusAsync(String, RequestContext)	[Protocol Method] Gets the status of an existing assign deployment resources job. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetAssignDeploymentResourcesStatusAsync(String, CancellationToken) convenience overload with strongly typed models first.
GetCopyProjectStatus(String, CancellationToken)	Gets the status of an existing copy project job.
GetCopyProjectStatus(String, RequestContext)	[Protocol Method] Gets the status of an existing copy project job. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetCopyProjectStatus(String, CancellationToken) convenience overload with strongly typed models first.
GetCopyProjectStatusAsync(String, CancellationToken)	Gets the status of an existing copy project job.
GetCopyProjectStatusAsync(String, RequestContext)	[Protocol Method] Gets the status of an existing copy project job. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetCopyProjectStatusAsync(String, CancellationToken) convenience overload with strongly typed models first.
GetExportStatus(String, CancellationToken)	Gets the status of an export job. Once job completes, returns the project metadata, and assets.
GetExportStatus(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. Please try the simpler GetExportStatus(String, CancellationToken) convenience overload with strongly typed models first.
GetExportStatusAsync(String, CancellationToken)	Gets the status of an export job. Once job completes, returns the project metadata, and assets.
GetExportStatusAsync(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. Please try the simpler GetExportStatusAsync(String, CancellationToken) convenience overload with strongly typed models first.
GetImportStatus(String, CancellationToken)	Gets the status for an import.
GetImportStatus(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. Please try the simpler GetImportStatus(String, CancellationToken) convenience overload with strongly typed models first.
GetImportStatusAsync(String, CancellationToken)	Gets the status for an import.
GetImportStatusAsync(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. Please try the simpler GetImportStatusAsync(String, CancellationToken) convenience overload with strongly typed models first.
GetProject(CancellationToken)	Gets the details of a project.
GetProject(RequestContext)	[Protocol Method] Gets the details of a project. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetProject(CancellationToken) convenience overload with strongly typed models first.
GetProjectAsync(CancellationToken)	Gets the details of a project.
GetProjectAsync(RequestContext)	[Protocol Method] Gets the details of a project. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetProjectAsync(CancellationToken) convenience overload with strongly typed models first.
GetProjectDeletionStatus(String, CancellationToken)	Gets the status for a project deletion job.
GetProjectDeletionStatus(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. Please try the simpler GetProjectDeletionStatus(String, CancellationToken) convenience overload with strongly typed models first.
GetProjectDeletionStatusAsync(String, CancellationToken)	Gets the status for a project deletion job.
GetProjectDeletionStatusAsync(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. Please try the simpler GetProjectDeletionStatusAsync(String, CancellationToken) convenience overload with strongly typed models first.
GetSwapDeploymentsStatus(String, CancellationToken)	Gets the status of an existing swap deployment job.
GetSwapDeploymentsStatus(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. Please try the simpler GetSwapDeploymentsStatus(String, CancellationToken) convenience overload with strongly typed models first.
GetSwapDeploymentsStatusAsync(String, CancellationToken)	Gets the status of an existing swap deployment job.
GetSwapDeploymentsStatusAsync(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. Please try the simpler GetSwapDeploymentsStatusAsync(String, CancellationToken) convenience overload with strongly typed models first.
GetTrainingStatus(String, CancellationToken)	Gets the status for a training job.
GetTrainingStatus(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. Please try the simpler GetTrainingStatus(String, CancellationToken) convenience overload with strongly typed models first.
GetTrainingStatusAsync(String, CancellationToken)	Gets the status for a training job.
GetTrainingStatusAsync(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. Please try the simpler GetTrainingStatusAsync(String, CancellationToken) convenience overload with strongly typed models first.
GetUnassignDeploymentResourcesStatus(String, CancellationToken)	Gets the status of an existing unassign deployment resources job.
GetUnassignDeploymentResourcesStatus(String, RequestContext)	[Protocol Method] Gets the status of an existing unassign deployment resources job. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetUnassignDeploymentResourcesStatus(String, CancellationToken) convenience overload with strongly typed models first.
GetUnassignDeploymentResourcesStatusAsync(String, CancellationToken)	Gets the status of an existing unassign deployment resources job.
GetUnassignDeploymentResourcesStatusAsync(String, RequestContext)	[Protocol Method] Gets the status of an existing unassign deployment resources job. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler GetUnassignDeploymentResourcesStatusAsync(String, CancellationToken) convenience overload with strongly typed models first.
Import(WaitUntil, 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. Please try the simpler Import(WaitUntil, TextAuthoringExportedProject, String, CancellationToken) convenience overload with strongly typed models first.
Import(WaitUntil, TextAuthoringExportedProject, String, CancellationToken)	Triggers a job to import a project. If a project with the same name already exists, the data of that project is replaced.
ImportAsync(WaitUntil, 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. Please try the simpler ImportAsync(WaitUntil, TextAuthoringExportedProject, String, CancellationToken) convenience overload with strongly typed models first.
ImportAsync(WaitUntil, TextAuthoringExportedProject, String, CancellationToken)	Triggers a job to import a project. If a project with the same name already exists, the data of that project is replaced.
SwapDeployments(WaitUntil, 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. Please try the simpler SwapDeployments(WaitUntil, TextAuthoringSwapDeploymentsDetails, CancellationToken) convenience overload with strongly typed models first.
SwapDeployments(WaitUntil, TextAuthoringSwapDeploymentsDetails, CancellationToken)	Swaps two existing deployments with each other.
SwapDeploymentsAsync(WaitUntil, 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. Please try the simpler SwapDeploymentsAsync(WaitUntil, TextAuthoringSwapDeploymentsDetails, CancellationToken) convenience overload with strongly typed models first.
SwapDeploymentsAsync(WaitUntil, TextAuthoringSwapDeploymentsDetails, CancellationToken)	Swaps two existing deployments with each other.
Train(WaitUntil, 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. Please try the simpler Train(WaitUntil, TextAuthoringTrainingJobDetails, CancellationToken) convenience overload with strongly typed models first.
Train(WaitUntil, TextAuthoringTrainingJobDetails, CancellationToken)	Triggers a training job for a project.
TrainAsync(WaitUntil, 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. Please try the simpler TrainAsync(WaitUntil, TextAuthoringTrainingJobDetails, CancellationToken) convenience overload with strongly typed models first.
TrainAsync(WaitUntil, TextAuthoringTrainingJobDetails, CancellationToken)	Triggers a training job for a project.
UnassignDeploymentResources(WaitUntil, RequestContent, RequestContext)	[Protocol Method] Unassign resources from a project. This disallows deploying new deployments to these resources, and deletes existing deployments assigned to them. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler UnassignDeploymentResources(WaitUntil, TextAuthoringUnassignDeploymentResourcesDetails, CancellationToken) convenience overload with strongly typed models first.
UnassignDeploymentResources(WaitUntil, TextAuthoringUnassignDeploymentResourcesDetails, CancellationToken)	Unassign resources from a project. This disallows deploying new deployments to these resources, and deletes existing deployments assigned to them.
UnassignDeploymentResourcesAsync(WaitUntil, RequestContent, RequestContext)	[Protocol Method] Unassign resources from a project. This disallows deploying new deployments to these resources, and deletes existing deployments assigned to them. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler UnassignDeploymentResourcesAsync(WaitUntil, TextAuthoringUnassignDeploymentResourcesDetails, CancellationToken) convenience overload with strongly typed models first.
UnassignDeploymentResourcesAsync(WaitUntil, TextAuthoringUnassignDeploymentResourcesDetails, CancellationToken)	Unassign resources from a project. This disallows deploying new deployments to these resources, and deletes existing deployments assigned to them.

Applies to