azure.ai.language.conversations.authoring.operations package

class azure.ai.language.conversations.authoring.operations.DeploymentOperations(*args, **kwargs)[source]

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ConversationAuthoringProjectClient’s deployment attribute.

begin_delete_deployment(deployment_name: str, **kwargs: Any) → LROPoller[None][source]

Deletes a project deployment.

Parameters:: deployment_name (str) – The name of the specific deployment of the project to use. Required.
Returns:: An instance of LROPoller that returns None
Return type:: LROPoller[None]
Raises:: HttpResponseError –

begin_delete_deployment_from_resources(deployment_name: str, body: ProjectResourceIds | MutableMapping[str, Any] | IO[bytes], **kwargs: Any) → LROPoller[None][source]

Deletes a deployment from the specified project-assigned resources.

Parameters:

deployment_name (str) – The name of the specific deployment of the project to use. Required.
body (ProjectResourceIds or JSON or IO[bytes]) – The Language or AIService resource list for deleting the deployment.rn The deployment will only be deleted from the specified resources, and will remain for the rest. Is one of the following types: ProjectResourceIds, JSON, IO[bytes] Required.

Returns:

An instance of LROPoller that returns None

Return type:

LROPoller[None]

Raises:

HttpResponseError –

begin_deploy_project(deployment_name: str, body: CreateDeploymentDetails | MutableMapping[str, Any] | IO[bytes], **kwargs: Any) → LROPoller[None][source]

Creates a new deployment or replaces an existing one.

Parameters:

deployment_name (str) – The name of the specific deployment of the project to use. Required.
body (CreateDeploymentDetails or JSON or IO[bytes]) – The new deployment info. Is one of the following types: CreateDeploymentDetails, JSON, IO[bytes] Required.

Returns:

An instance of LROPoller that returns None

Return type:

LROPoller[None]

Raises:

HttpResponseError –

get_deployment(deployment_name: str, **kwargs: Any) → ProjectDeployment[source]

Gets the details of a deployment.

Parameters:: deployment_name (str) – Represents deployment name. Required.
Returns:: ProjectDeployment. The ProjectDeployment is compatible with MutableMapping
Return type:: ProjectDeployment
Raises:: HttpResponseError –

get_deployment_delete_from_resources_status(deployment_name: str, job_id: str, **kwargs: Any) → DeploymentDeleteFromResourcesState[source]

Gets the status of an existing delete deployment from specific resources job.

Parameters:

deployment_name (str) – Represents deployment name. Required.
job_id (str) – The job ID. Required.

Returns:

DeploymentDeleteFromResourcesState. The DeploymentDeleteFromResourcesState is compatible with MutableMapping

Return type:

DeploymentDeleteFromResourcesState

Raises:

HttpResponseError –

get_deployment_status(deployment_name: str, job_id: str, **kwargs: Any) → DeploymentState[source]

Gets the status of an existing deployment job.

Parameters:

deployment_name (str) – Represents deployment name. Required.
job_id (str) – The job ID. Required.

Returns:

DeploymentState. The DeploymentState is compatible with MutableMapping

Return type:

DeploymentState

Raises:

HttpResponseError –

class azure.ai.language.conversations.authoring.operations.ExportedModelOperations(*args, **kwargs)[source]

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ConversationAuthoringProjectClient’s exported_model attribute.

begin_create_or_update_exported_model(exported_model_name: str, body: ExportedModelDetails | MutableMapping[str, Any] | IO[bytes], **kwargs: Any) → LROPoller[None][source]

Creates a new exported model or replaces an existing one.

Parameters:

exported_model_name (str) – The exported model name. Required.
body (ExportedModelDetails or JSON or IO[bytes]) – The exported model info. Is one of the following types: ExportedModelDetails, JSON, IO[bytes] Required.

Returns:

An instance of LROPoller that returns None

Return type:

LROPoller[None]

Raises:

HttpResponseError –

begin_delete_exported_model(exported_model_name: str, **kwargs: Any) → LROPoller[None][source]

Deletes an existing exported model.

Parameters:: exported_model_name (str) – The exported model name. Required.
Returns:: An instance of LROPoller that returns None
Return type:: LROPoller[None]
Raises:: HttpResponseError –

get_exported_model(exported_model_name: str, **kwargs: Any) → ExportedTrainedModel[source]

Gets the details of an exported model.

Parameters:: exported_model_name (str) – The exported model name. Required.
Returns:: ExportedTrainedModel. The ExportedTrainedModel is compatible with MutableMapping
Return type:: ExportedTrainedModel
Raises:: HttpResponseError –

get_exported_model_job_status(exported_model_name: str, job_id: str, **kwargs: Any) → ExportedModelState[source]

Gets the status for an existing job to create or update an exported model.

Parameters:

exported_model_name (str) – The exported model name. Required.
job_id (str) – The job ID. Required.

Returns:

ExportedModelState. The ExportedModelState is compatible with MutableMapping

Return type:

ExportedModelState

Raises:

HttpResponseError –

class azure.ai.language.conversations.authoring.operations.ProjectOperations(*args, **kwargs)[source]

begin_assign_project_resources(body: AssignProjectResourcesDetails | MutableMapping[str, Any] | IO[bytes], **kwargs: Any) → LROPoller[None][source]

Assign new Language or AIService Azure resources to a project to allowing deployment to them. This API is available only via AAD authentication and not supported via subscription key authentication. For more details about AAD authentication, check here: https://learn.microsoft.com/en-us/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-azure-active-directory.

Parameters:: body (AssignProjectResourcesDetails or JSON or IO[bytes]) – The new project resources to be assigned. Is one of the following types: AssignProjectResourcesDetails, JSON, IO[bytes] Required.
Returns:: An instance of LROPoller that returns None
Return type:: LROPoller[None]
Raises:: HttpResponseError –

begin_cancel_training_job(job_id: str, **kwargs: Any) → LROPoller[TrainingJobResult][source]

Cancel a training job without requiring project_name explicitly.

Parameters:: job_id (str) – The identifier of the training job to cancel. Required.
Returns:: An instance of LROPoller that returns TrainingJobResult.
Return type:: LROPoller[TrainingJobResult]

begin_copy_project(body: CopyProjectDetails | MutableMapping[str, Any] | IO[bytes], **kwargs: Any) → LROPoller[None][source]

Copies an existing project to another Azure resource.

Parameters:: body (CopyProjectDetails or JSON or IO[bytes]) – The copy project info. Is one of the following types: CopyProjectDetails, JSON, IO[bytes] Required.
Returns:: An instance of LROPoller that returns None
Return type:: LROPoller[None]
Raises:: HttpResponseError –

Triggers a job to export a project’s data.

Keyword Arguments:

string_index_type (str or StringIndexType) – Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets. Known values are: “Utf16CodeUnit”, “Utf8CodeUnit”, and “Utf32CodeUnit”. Required.
exported_project_format (str or ExportedProjectFormat) – The format of the exported project file to use. Known values are: “Conversation” and “Luis”. Default value is None.
asset_kind (str) – Kind of asset to export. Default value is None.
trained_model_label (str) – Trained model label to export. If the trainedModelLabel is null, the default behavior is to export the current working copy. Default value is None.

Returns:

An instance of LROPoller that returns None

Return type:

LROPoller[None]

Raises:

HttpResponseError –

begin_import(body: ExportedProject | MutableMapping[str, Any] | IO[bytes], *, exported_project_format: str | ExportedProjectFormat | None = None, **kwargs: Any) → LROPoller[None][source]

Triggers a job to import a project. If a project with the same name already exists, the data of that project is replaced.

Parameters:: body (ExportedProject or JSON or IO[bytes]) – The project data to import. Is one of the following types: ExportedProject, JSON, IO[bytes] Required.
Keyword Arguments:: exported_project_format (str or ExportedProjectFormat) – The format of the exported project file to use. Known values are: “Conversation” and “Luis”. Default value is None.
Returns:: An instance of LROPoller that returns None
Return type:: LROPoller[None]
Raises:: HttpResponseError –

begin_swap_deployments(body: SwapDeploymentsDetails | MutableMapping[str, Any] | IO[bytes], **kwargs: Any) → LROPoller[None][source]

Swaps two existing deployments with each other.

Parameters:: body (SwapDeploymentsDetails or JSON or IO[bytes]) – The job object to swap two deployments. Is one of the following types: SwapDeploymentsDetails, JSON, IO[bytes] Required.
Returns:: An instance of LROPoller that returns None
Return type:: LROPoller[None]
Raises:: HttpResponseError –

begin_train(body: TrainingJobDetails | MutableMapping[str, Any] | IO[bytes], **kwargs: Any) → LROPoller[TrainingJobResult][source]

Triggers a training job for a project.

Parameters:: body (TrainingJobDetails or JSON or IO[bytes]) – The training input parameters. Is one of the following types: TrainingJobDetails, JSON, IO[bytes] Required.
Returns:: An instance of LROPoller that returns TrainingJobResult. The TrainingJobResult is compatible with MutableMapping
Return type:: LROPoller[TrainingJobResult]
Raises:: HttpResponseError –

begin_unassign_project_resources(body: ProjectResourceIds | MutableMapping[str, Any] | IO[bytes], **kwargs: Any) → LROPoller[None][source]

Unassign resources from a project. This disallows deployment to these resources.

Parameters:: body (ProjectResourceIds or JSON or IO[bytes]) – The list of Language or AIService Azure resource IDs to be unassigned. Is one of the following types: ProjectResourceIds, JSON, IO[bytes] Required.
Returns:: An instance of LROPoller that returns None
Return type:: LROPoller[None]
Raises:: HttpResponseError –

copy_project_authorization(body: ~collections.abc.MutableMapping[str, ~typing.Any] | ~typing.IO[bytes] = <object object>, *, project_kind: str | ~azure.ai.language.conversations.authoring.models._enums.ProjectKind = <object object>, storage_input_container_name: str | None = None, allow_overwrite: bool | None = None, **kwargs: ~typing.Any) → CopyProjectDetails[source]

Generates a copy project operation authorization to the current target Azure resource.

Parameters:

body (JSON or IO[bytes]) – Is either a JSON type or a IO[bytes] type. Required.

Keyword Arguments:

project_kind (str or ProjectKind) – Represents the project kind. Known values are: “Conversation”, “Orchestration”, and “CustomConversationSummarization”. Required.
storage_input_container_name (str) – The name of the storage container. Default value is None.
allow_overwrite (bool) – Whether to allow an existing project to be overwritten using the resulting copy authorization. Default value is None.

Returns:

CopyProjectDetails. The CopyProjectDetails is compatible with MutableMapping

Return type:

CopyProjectDetails

Raises:

HttpResponseError –

get_assign_project_resources_status(job_id: str, **kwargs: Any) → ProjectResourcesState[source]

Gets the status of an existing assign project resources job.

Parameters:: job_id (str) – The job ID. Required.
Returns:: ProjectResourcesState. The ProjectResourcesState is compatible with MutableMapping
Return type:: ProjectResourcesState
Raises:: HttpResponseError –

get_copy_project_status(job_id: str, **kwargs: Any) → CopyProjectState[source]

Gets the status of an existing copy project job.

Parameters:: job_id (str) – The job ID. Required.
Returns:: CopyProjectState. The CopyProjectState is compatible with MutableMapping
Return type:: CopyProjectState
Raises:: HttpResponseError –

get_export_status(job_id: str, **kwargs: Any) → ExportProjectState[source]

Gets the status of an export job. Once job completes, returns the project metadata, and assets.

Parameters:: job_id (str) – The job ID. Required.
Returns:: ExportProjectState. The ExportProjectState is compatible with MutableMapping
Return type:: ExportProjectState
Raises:: HttpResponseError –

get_project(**kwargs: Any) → ProjectDetails[source]

Gets the details of a project.

Returns:: ProjectDetails. The ProjectDetails is compatible with MutableMapping
Return type:: ProjectDetails
Raises:: HttpResponseError –

get_project_deletion_status(job_id: str, **kwargs: Any) → ProjectDeletionState[source]

Gets the status for a project deletion job.

Parameters:: job_id (str) – The job ID. Required.
Returns:: ProjectDeletionState. The ProjectDeletionState is compatible with MutableMapping
Return type:: ProjectDeletionState
Raises:: HttpResponseError –

get_swap_deployments_status(job_id: str, **kwargs: Any) → SwapDeploymentsState[source]

Gets the status of an existing swap deployment job.

Parameters:: job_id (str) – The job ID. Required.
Returns:: SwapDeploymentsState. The SwapDeploymentsState is compatible with MutableMapping
Return type:: SwapDeploymentsState
Raises:: HttpResponseError –

get_training_status(job_id: str, **kwargs: Any) → TrainingState[source]

Gets the status for a training job.

Parameters:: job_id (str) – The job ID. Required.
Returns:: TrainingState. The TrainingState is compatible with MutableMapping
Return type:: TrainingState
Raises:: HttpResponseError –

get_unassign_project_resources_status(job_id: str, **kwargs: Any) → ProjectResourcesState[source]

Gets the status of an existing unassign project resources job.

Parameters:: job_id (str) – The job ID. Required.
Returns:: ProjectResourcesState. The ProjectResourcesState is compatible with MutableMapping
Return type:: ProjectResourcesState
Raises:: HttpResponseError –

list_deployments(*, top: int | None = None, skip: int | None = None, **kwargs: Any) → ItemPaged[ProjectDeployment][source]

Lists the deployments belonging to a project.

Keyword Arguments:

top (int) – The number of result items to return. Default value is None.
skip (int) – The number of result items to skip. Default value is None.

Returns:

An iterator like instance of ProjectDeployment

Return type:

ItemPaged[ProjectDeployment]

Raises:

HttpResponseError –

list_exported_models(*, top: int | None = None, skip: int | None = None, **kwargs: Any) → ItemPaged[ExportedTrainedModel][source]

Lists the exported models belonging to a project.

Keyword Arguments:

top (int) – The number of result items to return. Default value is None.
skip (int) – The number of result items to skip. Default value is None.

Returns:

An iterator like instance of ExportedTrainedModel

Return type:

ItemPaged[ExportedTrainedModel]

Raises:

HttpResponseError –

list_project_resources(*, top: int | None = None, skip: int | None = None, **kwargs: Any) → ItemPaged[AssignedProjectResource][source]

Lists the Language or AIService resources assigned to the project.

Keyword Arguments:

top (int) – The number of result items to return. Default value is None.
skip (int) – The number of result items to skip. Default value is None.

Returns:

An iterator like instance of AssignedProjectResource

Return type:

ItemPaged[AssignedProjectResource]

Raises:

HttpResponseError –

list_trained_models(*, top: int | None = None, skip: int | None = None, **kwargs: Any) → ItemPaged[ProjectTrainedModel][source]

Lists the trained models belonging to a project.

Keyword Arguments:

top (int) – The number of result items to return. Default value is None.
skip (int) – The number of result items to skip. Default value is None.

Returns:

An iterator like instance of ProjectTrainedModel

Return type:

ItemPaged[ProjectTrainedModel]

Raises:

HttpResponseError –

list_training_jobs(*, top: int | None = None, skip: int | None = None, **kwargs: Any) → ItemPaged[TrainingState][source]

Lists the non-expired training jobs created for a project.

Keyword Arguments:

top (int) – The number of result items to return. Default value is None.
skip (int) – The number of result items to skip. Default value is None.

Returns:

An iterator like instance of TrainingState

Return type:

ItemPaged[TrainingState]

Raises:

HttpResponseError –

class azure.ai.language.conversations.authoring.operations.TrainedModelOperations(*args, **kwargs)[source]

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ConversationAuthoringProjectClient’s trained_model attribute.

begin_evaluate_model(trained_model_label: str, body: EvaluationDetails | MutableMapping[str, Any] | IO[bytes], **kwargs: Any) → LROPoller[EvaluationJobResult][source]

Triggers evaluation operation on a trained model.

Parameters:

trained_model_label (str) – The trained model label. Required.
body (EvaluationDetails or JSON or IO[bytes]) – The training input parameters. Is one of the following types: EvaluationDetails, JSON, IO[bytes] Required.

Returns:

An instance of LROPoller that returns EvaluationJobResult. The EvaluationJobResult is compatible with MutableMapping

Return type:

LROPoller[EvaluationJobResult]

Raises:

HttpResponseError –

begin_load_snapshot(trained_model_label: str, **kwargs: Any) → LROPoller[None][source]

Restores the snapshot of this trained model to be the current working directory of the project.

Parameters:: trained_model_label (str) – The trained model label. Required.
Returns:: An instance of LROPoller that returns None
Return type:: LROPoller[None]
Raises:: HttpResponseError –

delete_trained_model(trained_model_label: str, **kwargs: Any) → None[source]

Deletes an existing trained model.

Parameters:: trained_model_label (str) – The trained model label. Required.
Returns:: None
Return type:: None
Raises:: HttpResponseError –

get_evaluation_status(trained_model_label: str, job_id: str, **kwargs: Any) → EvaluationState[source]

Gets the status for an evaluation job.

Parameters:

trained_model_label (str) – The trained model label. Required.
job_id (str) – The job ID. Required.

Returns:

EvaluationState. The EvaluationState is compatible with MutableMapping

Return type:

EvaluationState

Raises:

HttpResponseError –

get_load_snapshot_status(trained_model_label: str, job_id: str, **kwargs: Any) → LoadSnapshotState[source]

Gets the status for loading a snapshot.

Parameters:

trained_model_label (str) – The trained model label. Required.
job_id (str) – The job ID. Required.

Returns:

LoadSnapshotState. The LoadSnapshotState is compatible with MutableMapping

Return type:

LoadSnapshotState

Raises:

HttpResponseError –

get_model_evaluation_results(trained_model_label: str, *, string_index_type: str | StringIndexType, top: int | None = None, skip: int | None = None, **kwargs: Any) → ItemPaged[UtteranceEvaluationResult][source]

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.

Parameters:

trained_model_label (str) – The trained model label. Required.

Keyword Arguments:

string_index_type (str or StringIndexType) –
Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets. Known values are: “Utf16CodeUnit”, “Utf8CodeUnit”, and “Utf32CodeUnit”. Required.
top (int) – The number of result items to return. Default value is None.
skip (int) – The number of result items to skip. Default value is None.

Returns:

An iterator like instance of UtteranceEvaluationResult

Return type:

ItemPaged[UtteranceEvaluationResult]

Raises:

HttpResponseError –

get_model_evaluation_summary(trained_model_label: str, **kwargs: Any) → EvalSummary[source]

Gets the evaluation summary of a trained model. The summary includes high level performance measurements of the model e.g., F1, Precision, Recall, etc.

Parameters:: trained_model_label (str) – The trained model label. Required.
Returns:: EvalSummary. The EvalSummary is compatible with MutableMapping
Return type:: EvalSummary
Raises:: HttpResponseError –

get_trained_model(trained_model_label: str, **kwargs: Any) → ProjectTrainedModel[source]

Gets the details of a trained model.

Parameters:: trained_model_label (str) – The trained model label. Required.
Returns:: ProjectTrainedModel. The ProjectTrainedModel is compatible with MutableMapping
Return type:: ProjectTrainedModel
Raises:: HttpResponseError –