azure.ai.language.conversations.authoring package

class azure.ai.language.conversations.authoring.ConversationAuthoringClient(endpoint: str, credential: AzureKeyCredential | TokenCredential, *, api_version: str | None = None, **kwargs: Any)[source]

Create a ConversationAuthoringClient.

Parameters:

  • endpoint (str) – Supported Cognitive Services endpoint, e.g. https://<resource-name>.api.cognitiveservices.azure.com.

  • credential (AzureKeyCredential or TokenCredential) – Key or token credential.

Keyword Arguments:

api_version (str) – The API version to use for this operation. Default value is 2025-11-15-preview. Note that overriding this default value may result in unsupported behavior.

begin_delete_project(project_name: str, **kwargs: Any) → LROPoller[None]

Deletes a project.

Parameters:

project_name (str) – The name of the project to use. Required.

Returns:

An instance of LROPoller that returns None

Return type:

LROPoller[None]

Raises:

HttpResponseError –

close() → None[source]
create_project(project_name: str, body: CreateProjectOptions | MutableMapping[str, Any] | IO[bytes], **kwargs: Any) → ProjectDetails

Creates a new project or updates an existing one.

Parameters:

  • project_name (str) – The new project name. Required.

  • body (CreateProjectOptions or JSON or IO[bytes]) – The request body. Is one of the following types: CreateProjectOptions, JSON, IO[bytes] Required.

Returns:

ProjectDetails. The ProjectDetails is compatible with MutableMapping

Return type:

ProjectDetails

Raises:

HttpResponseError –

get_export_status(project_name: str, job_id: str, **kwargs: Any) → ExportProjectState

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

Parameters:

  • project_name (str) – The new project name. Required.

  • job_id (str) – The job ID. Required.

Returns:

ExportProjectState. The ExportProjectState is compatible with MutableMapping

Return type:

ExportProjectState

Raises:

HttpResponseError –

get_import_status(project_name: str, job_id: str, **kwargs: Any) → ImportProjectState

Gets the status for an import.

Parameters:

  • project_name (str) – The new project name. Required.

  • job_id (str) – The job ID. Required.

Returns:

ImportProjectState. The ImportProjectState is compatible with MutableMapping

Return type:

ImportProjectState

Raises:

HttpResponseError –

get_project(project_name: str, **kwargs: Any) → ProjectDetails

Gets the details of a project.

Parameters:

project_name (str) – The new project name. Required.

Returns:

ProjectDetails. The ProjectDetails is compatible with MutableMapping

Return type:

ProjectDetails

Raises:

HttpResponseError –

get_project_client(project_name: str) → ConversationAuthoringProjectClient[source]
list_assigned_resource_deployments(*, top: int | None = None, skip: int | None = None, **kwargs: Any) → ItemPaged[AssignedProjectDeploymentsMetadata]

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.

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 AssignedProjectDeploymentsMetadata

Return type:

ItemPaged[AssignedProjectDeploymentsMetadata]

Raises:

HttpResponseError –

list_projects(*, top: int | None = None, skip: int | None = None, **kwargs: Any) → ItemPaged[ProjectDetails]

Lists the existing projects.

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 ProjectDetails

Return type:

ItemPaged[ProjectDetails]

Raises:

HttpResponseError –

list_supported_languages(*, project_kind: str | ProjectKind, top: int | None = None, skip: int | None = None, **kwargs: Any) → ItemPaged[SupportedLanguage]

Lists the supported languages for the given project type.

Keyword Arguments:

  • project_kind (str or ProjectKind) – The project kind. Known values are: “Conversation”, “Orchestration”, and “CustomConversationSummarization”. 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 SupportedLanguage

Return type:

ItemPaged[SupportedLanguage]

Raises:

HttpResponseError –

list_supported_prebuilt_entities(*, top: int | None = None, skip: int | None = None, language: str | None = None, multilingual: str | None = None, **kwargs: Any) → ItemPaged[PrebuiltEntity]

Lists the supported prebuilt entities that can be used while creating composed entities.

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.

  • language (str) – 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. Default value is None.

  • multilingual (str) – Whether to get the support prebuilt entities for multilingual or monolingual projects. If true, the language parameter is ignored. Default value is None.

Returns:

An iterator like instance of PrebuiltEntity

Return type:

ItemPaged[PrebuiltEntity]

Raises:

HttpResponseError –

list_training_config_versions(*, project_kind: str | ProjectKind, top: int | None = None, skip: int | None = None, **kwargs: Any) → ItemPaged[TrainingConfigVersion]

Lists the support training config version for a given project type.

Keyword Arguments:

  • project_kind (str or ProjectKind) – The project kind. Known values are: “Conversation”, “Orchestration”, and “CustomConversationSummarization”. 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 TrainingConfigVersion

Return type:

ItemPaged[TrainingConfigVersion]

Raises:

HttpResponseError –

send_request(request: HttpRequest, *, stream: bool = False, **kwargs: Any) → HttpResponse[source]

Runs the network request through the client’s chained policies.

>>> from azure.core.rest import HttpRequest
>>> request = HttpRequest("GET", "https://www.example.org/")
<HttpRequest [GET], url: 'https://www.example.org/'>
>>> response = client.send_request(request)
<HttpResponse: 200 OK>

For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request

Parameters:

request (HttpRequest) – The network request you want to make. Required.

Keyword Arguments:

stream (bool) – Whether the response payload will be streamed. Defaults to False.

Returns:

The response of your network call. Does not do error handling on your response.

Return type:

HttpResponse

class azure.ai.language.conversations.authoring.ConversationAuthoringProjectClient(endpoint: str, credential: AzureKeyCredential | TokenCredential, *, api_version: str | None = None, project_name: str, **kwargs: Any)[source]

Initialize a ConversationAuthoringProjectClient.

Parameters:

  • endpoint (str) – Supported Cognitive Services endpoint, e.g. https://<resource>.cognitiveservices.azure.com.

  • credential (AzureKeyCredential or TokenCredential) – Credential used to authenticate requests to the service.

Keyword Arguments:

  • api_version (str) – The API version to use for this operation. Default value is 2025-11-15-preview. Note that overriding this default value may result in unsupported behavior.

  • project_name (str) – The name of the project to scope operations. Required.

close() → None[source]
send_request(request: HttpRequest, *, stream: bool = False, **kwargs: Any) → HttpResponse[source]

Runs the network request through the client’s chained policies.

>>> from azure.core.rest import HttpRequest
>>> request = HttpRequest("GET", "https://www.example.org/")
<HttpRequest [GET], url: 'https://www.example.org/'>
>>> response = client.send_request(request)
<HttpResponse: 200 OK>

For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request

Parameters:

request (HttpRequest) – The network request you want to make. Required.

Keyword Arguments:

stream (bool) – Whether the response payload will be streamed. Defaults to False.

Returns:

The response of your network call. Does not do error handling on your response.

Return type:

HttpResponse

deployment: DeploymentOperations

Deployment operations group

exported_model: ExportedModelOperations

Exported model operations group

project: ProjectOperations

Project operations group

trained_model: TrainedModelOperations

Trained model operations group

Subpackages