azure-ai-language-conversations


Nameazure-ai-language-conversations JSON
Version 1.1.0 PyPI version JSON
download
home_pagehttps://github.com/Azure/azure-sdk-for-python
SummaryMicrosoft Azure Conversational Language Understanding Client Library for Python
upload_time2023-06-14 00:40:03
maintainerNone
docs_urlNone
authorMicrosoft Corporation
requires_python>=3.7
licenseMIT License
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            [![Build Status](https://dev.azure.com/azure-sdk/public/_apis/build/status/azure-sdk-for-python.client?branchName=main)](https://dev.azure.com/azure-sdk/public/_build/latest?definitionId=46?branchName=main)

# Azure Conversational Language Understanding client library for Python
Conversational Language Understanding - aka **CLU** for short - is a cloud-based conversational AI service which provides many language understanding capabilities like:
- Conversation App: It's used in extracting intents and entities in conversations
- Workflow app: Acts like an orchestrator to select the best candidate to analyze conversations to get best response from apps like Qna, Luis, and Conversation App
- Conversational Summarization: Used to analyze conversations in the form of issues/resolution, chapter title, and narrative summarizations

[Source code][conversationallanguage_client_src]
| [Package (PyPI)][conversationallanguage_pypi_package]
| [Package (Conda)](https://anaconda.org/microsoft/azure-ai-language-conversations/)
| [API reference documentation][api_reference_documentation]
| [Samples][conversationallanguage_samples]
| [Product documentation][conversationallanguage_docs]
| [REST API documentation][conversationallanguage_restdocs]

## Getting started

### Prerequisites

* Python 3.7 or later is required to use this package.
* An [Azure subscription][azure_subscription]
* A [Language service resource][language_resource]


### Install the package

Install the Azure Conversations client library for Python with [pip][pip_link]:

```bash
pip install azure-ai-language-conversations
```

> Note: This version of the client library defaults to the 2023-04-01 version of the service

### Authenticate the client
In order to interact with the CLU service, you'll need to create an instance of the [ConversationAnalysisClient][conversationanalysisclient_class] class, or [ConversationAuthoringClient][conversationauthoringclient_class] class. You will need an **endpoint**, and an **API key** to instantiate a client object. For more information regarding authenticating with Cognitive Services, see [Authenticate requests to Azure Cognitive Services][cognitive_auth].

#### Get an API key
You can get the **endpoint** and an **API key** from the Cognitive Services resource in the [Azure Portal][azure_portal].

Alternatively, use the [Azure CLI][azure_cli] command shown below to get the API key from the Cognitive Service resource.

```powershell
az cognitiveservices account keys list --resource-group <resource-group-name> --name <resource-name>
```


#### Create ConversationAnalysisClient
Once you've determined your **endpoint** and **API key** you can instantiate a `ConversationAnalysisClient`:

```python
from azure.core.credentials import AzureKeyCredential
from azure.ai.language.conversations import ConversationAnalysisClient

endpoint = "https://<my-custom-subdomain>.cognitiveservices.azure.com/"
credential = AzureKeyCredential("<api-key>")
client = ConversationAnalysisClient(endpoint, credential)
```

#### Create ConversationAuthoringClient
Once you've determined your **endpoint** and **API key** you can instantiate a `ConversationAuthoringClient`:

```python
from azure.core.credentials import AzureKeyCredential
from azure.ai.language.conversations.authoring import ConversationAuthoringClient

endpoint = "https://<my-custom-subdomain>.cognitiveservices.azure.com/"
credential = AzureKeyCredential("<api-key>")
client = ConversationAuthoringClient(endpoint, credential)
```

#### Create a client with an Azure Active Directory Credential

To use an [Azure Active Directory (AAD) token credential][cognitive_authentication_aad],
provide an instance of the desired credential type obtained from the
[azure-identity][azure_identity_credentials] library.
Note that regional endpoints do not support AAD authentication. Create a [custom subdomain][custom_subdomain]
name for your resource in order to use this type of authentication.

Authentication with AAD requires some initial setup:

- [Install azure-identity][install_azure_identity]
- [Register a new AAD application][register_aad_app]
- [Grant access][grant_role_access] to the Language service by assigning the "Cognitive Services Language Reader" role to your service principal.

After setup, you can choose which type of [credential][azure_identity_credentials] from azure.identity to use.
As an example, [DefaultAzureCredential][default_azure_credential]
can be used to authenticate the client:

Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables:
`AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_SECRET`

Use the returned token credential to authenticate the client:

```python
from azure.ai.language.conversations import ConversationAnalysisClient
from azure.identity import DefaultAzureCredential

credential = DefaultAzureCredential()
client = ConversationAnalysisClient(endpoint="https://<my-custom-subdomain>.cognitiveservices.azure.com/", credential=credential)
```

## Key concepts

### ConversationAnalysisClient
The [ConversationAnalysisClient][conversationanalysisclient_class] is the primary interface for making predictions using your deployed Conversations models. For asynchronous operations, an async `ConversationAnalysisClient` is in the `azure.ai.language.conversation.aio` namespace.

### ConversationAuthoringClient
You can use the [ConversationAuthoringClient][conversationauthoringclient_class] to interface with the [Azure Language Portal][azure_language_portal] to carry out authoring operations on your language resource/project. For example, you can use it to create a project, populate with training data, train, test, and deploy. For asynchronous operations, an async `ConversationAuthoringClient` is in the `azure.ai.language.conversation.authoring.aio` namespace.

## Examples
The `azure-ai-language-conversation` client library provides both synchronous and asynchronous APIs.

The following examples show common scenarios using the `client` [created above](#create-conversationanalysisclient).

### Analyze Text with a Conversation App
If you would like to extract custom intents and entities from a user utterance, you can call the `client.analyze_conversation()` method with your conversation's project name as follows:


```python
# import libraries
import os
from azure.core.credentials import AzureKeyCredential
from azure.ai.language.conversations import ConversationAnalysisClient

# get secrets
clu_endpoint = os.environ["AZURE_CONVERSATIONS_ENDPOINT"]
clu_key = os.environ["AZURE_CONVERSATIONS_KEY"]
project_name = os.environ["AZURE_CONVERSATIONS_PROJECT_NAME"]
deployment_name = os.environ["AZURE_CONVERSATIONS_DEPLOYMENT_NAME"]

# analyze quey
client = ConversationAnalysisClient(clu_endpoint, AzureKeyCredential(clu_key))
with client:
    query = "Send an email to Carol about the tomorrow's demo"
    result = client.analyze_conversation(
        task={
            "kind": "Conversation",
            "analysisInput": {
                "conversationItem": {
                    "participantId": "1",
                    "id": "1",
                    "modality": "text",
                    "language": "en",
                    "text": query
                },
                "isLoggingEnabled": False
            },
            "parameters": {
                "projectName": project_name,
                "deploymentName": deployment_name,
                "verbose": True
            }
        }
    )

# view result
print("query: {}".format(result["result"]["query"]))
print("project kind: {}\n".format(result["result"]["prediction"]["projectKind"]))

print("top intent: {}".format(result["result"]["prediction"]["topIntent"]))
print("category: {}".format(result["result"]["prediction"]["intents"][0]["category"]))
print("confidence score: {}\n".format(result["result"]["prediction"]["intents"][0]["confidenceScore"]))

print("entities:")
for entity in result["result"]["prediction"]["entities"]:
    print("\ncategory: {}".format(entity["category"]))
    print("text: {}".format(entity["text"]))
    print("confidence score: {}".format(entity["confidenceScore"]))
    if "resolutions" in entity:
        print("resolutions")
        for resolution in entity["resolutions"]:
            print("kind: {}".format(resolution["resolutionKind"]))
            print("value: {}".format(resolution["value"]))
    if "extraInformation" in entity:
        print("extra info")
        for data in entity["extraInformation"]:
            print("kind: {}".format(data["extraInformationKind"]))
            if data["extraInformationKind"] == "ListKey":
                print("key: {}".format(data["key"]))
            if data["extraInformationKind"] == "EntitySubtype":
                print("value: {}".format(data["value"]))
```

### Analyze Text with an Orchestration App

If you would like to pass the user utterance to your orchestrator (worflow) app, you can call the `client.analyze_conversation()` method with your orchestration's project name. The orchestrator project simply orchestrates the submitted user utterance between your language apps (Luis, Conversation, and Question Answering) to get the best response according to the user intent. See the next example:


```python
# import libraries
import os
from azure.core.credentials import AzureKeyCredential
from azure.ai.language.conversations import ConversationAnalysisClient

# get secrets
clu_endpoint = os.environ["AZURE_CONVERSATIONS_ENDPOINT"]
clu_key = os.environ["AZURE_CONVERSATIONS_KEY"]
project_name = os.environ["AZURE_CONVERSATIONS_WORKFLOW_PROJECT_NAME"]
deployment_name = os.environ["AZURE_CONVERSATIONS_WORKFLOW_DEPLOYMENT_NAME"]

# analyze query
client = ConversationAnalysisClient(clu_endpoint, AzureKeyCredential(clu_key))
with client:
    query = "Reserve a table for 2 at the Italian restaurant"
    result = client.analyze_conversation(
        task={
            "kind": "Conversation",
            "analysisInput": {
                "conversationItem": {
                    "participantId": "1",
                    "id": "1",
                    "modality": "text",
                    "language": "en",
                    "text": query
                },
                "isLoggingEnabled": False
            },
            "parameters": {
                "projectName": project_name,
                "deploymentName": deployment_name,
                "verbose": True
            }
        }
    )

# view result
print("query: {}".format(result["result"]["query"]))
print("project kind: {}\n".format(result["result"]["prediction"]["projectKind"]))

# top intent
top_intent = result["result"]["prediction"]["topIntent"]
print("top intent: {}".format(top_intent))
top_intent_object = result["result"]["prediction"]["intents"][top_intent]
print("confidence score: {}".format(top_intent_object["confidenceScore"]))
print("project kind: {}".format(top_intent_object["targetProjectKind"]))

if top_intent_object["targetProjectKind"] == "Luis":
    print("\nluis response:")
    luis_response = top_intent_object["result"]["prediction"]
    print("top intent: {}".format(luis_response["topIntent"]))
    print("\nentities:")
    for entity in luis_response["entities"]:
        print("\n{}".format(entity))
```

### Conversational Summarization

You can use this sample if you need to summarize a conversation in the form of an issue, and final resolution. For example, a dialog from tech support:

```python
# import libraries
import os
from azure.core.credentials import AzureKeyCredential
from azure.ai.language.conversations import ConversationAnalysisClient
# get secrets
endpoint = os.environ["AZURE_CONVERSATIONS_ENDPOINT"]
key = os.environ["AZURE_CONVERSATIONS_KEY"]
# analyze query
client = ConversationAnalysisClient(endpoint, AzureKeyCredential(key))
with client:
    poller = client.begin_conversation_analysis(
        task={
            "displayName": "Analyze conversations from xxx",
            "analysisInput": {
                "conversations": [
                    {
                        "conversationItems": [
                            {
                                "text": "Hello, how can I help you?",
                                "modality": "text",
                                "id": "1",
                                "participantId": "Agent"
                            },
                            {
                                "text": "How to upgrade Office? I am getting error messages the whole day.",
                                "modality": "text",
                                "id": "2",
                                "participantId": "Customer"
                            },
                            {
                                "text": "Press the upgrade button please. Then sign in and follow the instructions.",
                                "modality": "text",
                                "id": "3",
                                "participantId": "Agent"
                            }
                        ],
                        "modality": "text",
                        "id": "conversation1",
                        "language": "en"
                    },
                ]
            },
            "tasks": [
                {
                    "taskName": "Issue task",
                    "kind": "ConversationalSummarizationTask",
                    "parameters": {
                        "summaryAspects": ["issue"]
                    }
                },
                {
                    "taskName": "Resolution task",
                    "kind": "ConversationalSummarizationTask",
                    "parameters": {
                        "summaryAspects": ["resolution"]
                    }
                },
            ]
        }
    )

    # view result
    result = poller.result()
    task_results = result["tasks"]["items"]
    for task in task_results:
        print(f"\n{task['taskName']} status: {task['status']}")
        task_result = task["results"]
        if task_result["errors"]:
            print("... errors occurred ...")
            for error in task_result["errors"]:
                print(error)
        else:
            conversation_result = task_result["conversations"][0]
            if conversation_result["warnings"]:
                print("... view warnings ...")
                for warning in conversation_result["warnings"]:
                    print(warning)
            else:
                summaries = conversation_result["summaries"]
                print("... view task result ...")
                for summary in summaries:
                    print(f"{summary['aspect']}: {summary['text']}")
```

### Import a Conversation Project
This sample shows a common scenario for the authoring part of the SDK

```python
import os
from azure.core.credentials import AzureKeyCredential
from azure.ai.language.conversations.authoring import ConversationAuthoringClient

clu_endpoint = os.environ["AZURE_CONVERSATIONS_ENDPOINT"]
clu_key = os.environ["AZURE_CONVERSATIONS_KEY"]

project_name = "test_project"

exported_project_assets = {
    "projectKind": "Conversation",
    "intents": [{"category": "Read"}, {"category": "Delete"}],
    "entities": [{"category": "Sender"}],
    "utterances": [
        {
            "text": "Open Blake's email",
            "dataset": "Train",
            "intent": "Read",
            "entities": [{"category": "Sender", "offset": 5, "length": 5}],
        },
        {
            "text": "Delete last email",
            "language": "en-gb",
            "dataset": "Test",
            "intent": "Delete",
            "entities": [],
        },
    ],
}

client = ConversationAuthoringClient(
    clu_endpoint, AzureKeyCredential(clu_key)
)
poller = client.begin_import_project(
    project_name=project_name,
    project={
        "assets": exported_project_assets,
        "metadata": {
            "projectKind": "Conversation",
            "settings": {"confidenceThreshold": 0.7},
            "projectName": "EmailApp",
            "multilingual": True,
            "description": "Trying out CLU",
            "language": "en-us",
        },
        "projectFileVersion": "2022-05-01",
    },
)
response = poller.result()
print(response)

```


## Optional Configuration

Optional keyword arguments can be passed in at the client and per-operation level. The azure-core [reference documentation][azure_core_ref_docs] describes available configurations for retries, logging, transport protocols, and more.

## Troubleshooting

### General

The Conversations client will raise exceptions defined in [Azure Core][azure_core_exceptions].

### Logging

This library uses the standard
[logging][python_logging] library for logging.
Basic information about HTTP sessions (URLs, headers, etc.) is logged at INFO
level.

Detailed DEBUG level logging, including request/response bodies and unredacted
headers, can be enabled on a client with the `logging_enable` argument.

See full SDK logging documentation with examples [here][sdk_logging_docs].

```python
import sys
import logging
from azure.core.credentials import AzureKeyCredential
from azure.ai.language.conversations import ConversationAnalysisClient

# Create a logger for the 'azure' SDK
logger = logging.getLogger('azure')
logger.setLevel(logging.DEBUG)

# Configure a console output
handler = logging.StreamHandler(stream=sys.stdout)
logger.addHandler(handler)

endpoint = "https://<my-custom-subdomain>.cognitiveservices.azure.com/"
credential = AzureKeyCredential("<my-api-key>")

# This client will log detailed information about its HTTP sessions, at DEBUG level
client = ConversationAnalysisClient(endpoint, credential, logging_enable=True)
result = client.analyze_conversation(...)
```

Similarly, `logging_enable` can enable detailed logging for a single operation, even when it isn't enabled for the client:

```python
result = client.analyze_conversation(..., logging_enable=True)
```

## Next steps

### More sample code

See the [Sample README][conversationallanguage_samples] for several code snippets illustrating common patterns used in the CLU Python API.

## Contributing

See the [CONTRIBUTING.md][contributing] for details on building, testing, and contributing to this library.

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit [cla.microsoft.com][cla].

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the [Microsoft Open Source Code of Conduct][code_of_conduct]. For more information see the [Code of Conduct FAQ][coc_faq] or contact [opencode@microsoft.com][coc_contact] with any additional questions or comments.

<!-- LINKS -->
[azure_cli]: https://docs.microsoft.com/cli/azure/
[azure_portal]: https://portal.azure.com/
[azure_subscription]: https://azure.microsoft.com/free/
[language_resource]: https://portal.azure.com/#create/Microsoft.CognitiveServicesTextAnalytics
[cla]: https://cla.microsoft.com
[coc_contact]: mailto:opencode@microsoft.com
[coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/
[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/
[cognitive_auth]: https://docs.microsoft.com/azure/cognitive-services/authentication/
[contributing]: https://github.com/Azure/azure-sdk-for-python/blob/main/CONTRIBUTING.md
[python_logging]: https://docs.python.org/3/library/logging.html
[sdk_logging_docs]: https://docs.microsoft.com/azure/developer/python/azure-sdk-logging
[azure_core_ref_docs]: https://azuresdkdocs.blob.core.windows.net/$web/python/azure-core/latest/azure.core.html
[azure_core_readme]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/README.md
[pip_link]:https://pypi.org/project/pip/
[conversationallanguage_client_src]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/cognitivelanguage/azure-ai-language-conversations
[conversationallanguage_pypi_package]: https://pypi.org/project/azure-ai-language-conversations/
[api_reference_documentation]:https://azuresdkdocs.blob.core.windows.net/$web/python/azure-ai-language-conversations/latest/azure.ai.language.conversations.html
[conversationallanguage_refdocs]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/cognitivelanguage/azure-ai-language-conversations
[conversationallanguage_docs]: https://docs.microsoft.com/azure/cognitive-services/language-service/conversational-language-understanding/overview
[conversationallanguage_samples]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/cognitivelanguage/azure-ai-language-conversations/samples/README.md
[conversationallanguage_restdocs]: https://learn.microsoft.com/rest/api/language/
[conversationanalysisclient_class]: https://azuresdkdocs.blob.core.windows.net/$web/python/azure-ai-language-conversations/latest/azure.ai.language.conversations.html#azure.ai.language.conversations.ConversationAnalysisClient
[conversationauthoringclient_class]: https://azuresdkdocs.blob.core.windows.net/$web/python/azure-ai-language-conversations/latest/azure.ai.language.conversations.html#azure.ai.language.conversations.ConversationAuthoringClient
[azure_core_exceptions]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/README.md
[azure_language_portal]: https://language.cognitive.azure.com/home
[cognitive_authentication_aad]: https://docs.microsoft.com/azure/cognitive-services/authentication#authenticate-with-azure-active-directory
[azure_identity_credentials]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#credentials
[custom_subdomain]: https://docs.microsoft.com/azure/cognitive-services/authentication#create-a-resource-with-a-custom-subdomain
[install_azure_identity]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#install-the-package
[register_aad_app]: https://docs.microsoft.com/azure/cognitive-services/authentication#assign-a-role-to-a-service-principal
[grant_role_access]: https://docs.microsoft.com/azure/cognitive-services/authentication#assign-a-role-to-a-service-principal
[default_azure_credential]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#defaultazurecredential

![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-python%2Fsdk%2Ftemplate%2Fazure-template%2FREADME.png)


# Release History

## 1.1.0 (2023-06-13)

### Features Added
- Added support for service version 2023-04-01.

### Breaking Changes

> Note: The following changes are only breaking from the previous beta. They are not breaking since version 1.0.0 when those types and members did not exist.

- Removed support for service version 2022-05-15-preview.
- Removed support for service version 2022-10-01-preview.
- Removed support for "ConversationalPIITask" analysis with `ConversationAnalysisClient`.
- Removed support for "ConversationalSentimentTask" with `ConversationAnalysisClient`.
- Removed the following methods from `ConversationAuthoringClient`:
  - `begin_assign_deployment_resources`
  - `get_assign_deployment_resources_status`
  - `begin_unassign_deployment_resources`
  - `get_unassign_deployment_resources_status`
  - `begin_delete_deployment_from_resources`
  - `get_deployment_delete_from_resources_status`
  - `list_assigned_resource_deployments`
  - `list_deployment_resources`

## 1.1.0b3 (2022-11-10)

### Features Added
- Added support for the "ConversationalSentimentTask" kind with `begin_conversation_analysis`.
- Added support for "chapterTitle" and "narrative" `summaryAspects` options for ConversationalSummarizationTasks.
- Added methods to the `ConversationAuthoringClient` to manage deployment resources:
  - `begin_assign_deployment_resources`
  - `get_assign_deployment_resources_status`
  - `begin_unassign_deployment_resources`
  - `get_unassign_deployment_resources_status`
  - `begin_delete_deployment_from_resources`
  - `get_deployment_delete_from_resources_status`
  - `begin_load_snapshot`
  - `get_load_snapshot_status`
  - `list_assigned_resource_deployments`
  - `list_deployment_resources`
- Added optional `trained_model_label` keyword argument to `begin_export_project`.

### Other Changes
* This version and all future versions will require Python 3.7+. Python 3.6 is no longer supported.

## 1.1.0b2 (2022-07-01)

### Features Added
* Added Azure Active Directory (AAD) authentication support
* Added support for authoring operations with `ConversationAuthoringClient` under the `azure.ai.language.conversations.authoring` namespace.

## 1.0.0 (2022-06-27)

### Features Added
* Added Azure Active Directory (AAD) authentication support
* Added more resolution types for entities
* Added support for authoring operations with `ConversationAuthoringClient` under the `azure.ai.language.conversations.authoring` namespace.

### Breaking Changes
* Client now uses python dictionaries for method parameters and results instead of classes.

## 1.1.0b1 (2022-05-26)

### Features Added
* Conversation summarization task (Long-running operation)
* Conversation PII extraction task (Long-running operation)

### Breaking Changes
* Client now uses python dictionaries for method parameters and results instead of classes.
* Many input and result parameter name changes in `analyze_conversation()` method

## 1.0.0b3 (2022-04-19)

### Features Added
* Entity resolutions
* Extra features

### Breaking Changes
* The `ConversationAnalysisOptions` model used as input to the `analyze_conversation` operation is now wrapped in a `CustomConversationalTask` which combines the analysis options with the project parameters into a single model.
* The `query` within the `ConversationAnalysisOptions` is now further qualified as a `TextConversationItem` with additional properties.
* The output `AnalyzeConversationResult` is now wrapped in a `CustomConversationalTaskResult` according to the input model.

### Other Changes
* Python 2.7 is no longer supported. Please use Python version 3.6 or later.

## 1.0.0b1 (2021-11-03)

### Features Added
* Initial release

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Azure/azure-sdk-for-python",
    "name": "azure-ai-language-conversations",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": null,
    "author": "Microsoft Corporation",
    "author_email": "azpysdkhelp@microsoft.com",
    "download_url": "https://files.pythonhosted.org/packages/bd/ce/f6f8b57a1dcde19465c395734ce9b9ac35f560e4383c9bbcee3011b475d7/azure-ai-language-conversations-1.1.0.zip",
    "platform": null,
    "description": "[![Build Status](https://dev.azure.com/azure-sdk/public/_apis/build/status/azure-sdk-for-python.client?branchName=main)](https://dev.azure.com/azure-sdk/public/_build/latest?definitionId=46?branchName=main)\n\n# Azure Conversational Language Understanding client library for Python\nConversational Language Understanding - aka **CLU** for short - is a cloud-based conversational AI service which provides many language understanding capabilities like:\n- Conversation App: It's used in extracting intents and entities in conversations\n- Workflow app: Acts like an orchestrator to select the best candidate to analyze conversations to get best response from apps like Qna, Luis, and Conversation App\n- Conversational Summarization: Used to analyze conversations in the form of issues/resolution, chapter title, and narrative summarizations\n\n[Source code][conversationallanguage_client_src]\n| [Package (PyPI)][conversationallanguage_pypi_package]\n| [Package (Conda)](https://anaconda.org/microsoft/azure-ai-language-conversations/)\n| [API reference documentation][api_reference_documentation]\n| [Samples][conversationallanguage_samples]\n| [Product documentation][conversationallanguage_docs]\n| [REST API documentation][conversationallanguage_restdocs]\n\n## Getting started\n\n### Prerequisites\n\n* Python 3.7 or later is required to use this package.\n* An [Azure subscription][azure_subscription]\n* A [Language service resource][language_resource]\n\n\n### Install the package\n\nInstall the Azure Conversations client library for Python with [pip][pip_link]:\n\n```bash\npip install azure-ai-language-conversations\n```\n\n> Note: This version of the client library defaults to the 2023-04-01 version of the service\n\n### Authenticate the client\nIn order to interact with the CLU service, you'll need to create an instance of the [ConversationAnalysisClient][conversationanalysisclient_class] class, or [ConversationAuthoringClient][conversationauthoringclient_class] class. You will need an **endpoint**, and an **API key** to instantiate a client object. For more information regarding authenticating with Cognitive Services, see [Authenticate requests to Azure Cognitive Services][cognitive_auth].\n\n#### Get an API key\nYou can get the **endpoint** and an **API key** from the Cognitive Services resource in the [Azure Portal][azure_portal].\n\nAlternatively, use the [Azure CLI][azure_cli] command shown below to get the API key from the Cognitive Service resource.\n\n```powershell\naz cognitiveservices account keys list --resource-group <resource-group-name> --name <resource-name>\n```\n\n\n#### Create ConversationAnalysisClient\nOnce you've determined your **endpoint** and **API key** you can instantiate a `ConversationAnalysisClient`:\n\n```python\nfrom azure.core.credentials import AzureKeyCredential\nfrom azure.ai.language.conversations import ConversationAnalysisClient\n\nendpoint = \"https://<my-custom-subdomain>.cognitiveservices.azure.com/\"\ncredential = AzureKeyCredential(\"<api-key>\")\nclient = ConversationAnalysisClient(endpoint, credential)\n```\n\n#### Create ConversationAuthoringClient\nOnce you've determined your **endpoint** and **API key** you can instantiate a `ConversationAuthoringClient`:\n\n```python\nfrom azure.core.credentials import AzureKeyCredential\nfrom azure.ai.language.conversations.authoring import ConversationAuthoringClient\n\nendpoint = \"https://<my-custom-subdomain>.cognitiveservices.azure.com/\"\ncredential = AzureKeyCredential(\"<api-key>\")\nclient = ConversationAuthoringClient(endpoint, credential)\n```\n\n#### Create a client with an Azure Active Directory Credential\n\nTo use an [Azure Active Directory (AAD) token credential][cognitive_authentication_aad],\nprovide an instance of the desired credential type obtained from the\n[azure-identity][azure_identity_credentials] library.\nNote that regional endpoints do not support AAD authentication. Create a [custom subdomain][custom_subdomain]\nname for your resource in order to use this type of authentication.\n\nAuthentication with AAD requires some initial setup:\n\n- [Install azure-identity][install_azure_identity]\n- [Register a new AAD application][register_aad_app]\n- [Grant access][grant_role_access] to the Language service by assigning the \"Cognitive Services Language Reader\" role to your service principal.\n\nAfter setup, you can choose which type of [credential][azure_identity_credentials] from azure.identity to use.\nAs an example, [DefaultAzureCredential][default_azure_credential]\ncan be used to authenticate the client:\n\nSet the values of the client ID, tenant ID, and client secret of the AAD application as environment variables:\n`AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_SECRET`\n\nUse the returned token credential to authenticate the client:\n\n```python\nfrom azure.ai.language.conversations import ConversationAnalysisClient\nfrom azure.identity import DefaultAzureCredential\n\ncredential = DefaultAzureCredential()\nclient = ConversationAnalysisClient(endpoint=\"https://<my-custom-subdomain>.cognitiveservices.azure.com/\", credential=credential)\n```\n\n## Key concepts\n\n### ConversationAnalysisClient\nThe [ConversationAnalysisClient][conversationanalysisclient_class] is the primary interface for making predictions using your deployed Conversations models. For asynchronous operations, an async `ConversationAnalysisClient` is in the `azure.ai.language.conversation.aio` namespace.\n\n### ConversationAuthoringClient\nYou can use the [ConversationAuthoringClient][conversationauthoringclient_class] to interface with the [Azure Language Portal][azure_language_portal] to carry out authoring operations on your language resource/project. For example, you can use it to create a project, populate with training data, train, test, and deploy. For asynchronous operations, an async `ConversationAuthoringClient` is in the `azure.ai.language.conversation.authoring.aio` namespace.\n\n## Examples\nThe `azure-ai-language-conversation` client library provides both synchronous and asynchronous APIs.\n\nThe following examples show common scenarios using the `client` [created above](#create-conversationanalysisclient).\n\n### Analyze Text with a Conversation App\nIf you would like to extract custom intents and entities from a user utterance, you can call the `client.analyze_conversation()` method with your conversation's project name as follows:\n\n\n```python\n# import libraries\nimport os\nfrom azure.core.credentials import AzureKeyCredential\nfrom azure.ai.language.conversations import ConversationAnalysisClient\n\n# get secrets\nclu_endpoint = os.environ[\"AZURE_CONVERSATIONS_ENDPOINT\"]\nclu_key = os.environ[\"AZURE_CONVERSATIONS_KEY\"]\nproject_name = os.environ[\"AZURE_CONVERSATIONS_PROJECT_NAME\"]\ndeployment_name = os.environ[\"AZURE_CONVERSATIONS_DEPLOYMENT_NAME\"]\n\n# analyze quey\nclient = ConversationAnalysisClient(clu_endpoint, AzureKeyCredential(clu_key))\nwith client:\n    query = \"Send an email to Carol about the tomorrow's demo\"\n    result = client.analyze_conversation(\n        task={\n            \"kind\": \"Conversation\",\n            \"analysisInput\": {\n                \"conversationItem\": {\n                    \"participantId\": \"1\",\n                    \"id\": \"1\",\n                    \"modality\": \"text\",\n                    \"language\": \"en\",\n                    \"text\": query\n                },\n                \"isLoggingEnabled\": False\n            },\n            \"parameters\": {\n                \"projectName\": project_name,\n                \"deploymentName\": deployment_name,\n                \"verbose\": True\n            }\n        }\n    )\n\n# view result\nprint(\"query: {}\".format(result[\"result\"][\"query\"]))\nprint(\"project kind: {}\\n\".format(result[\"result\"][\"prediction\"][\"projectKind\"]))\n\nprint(\"top intent: {}\".format(result[\"result\"][\"prediction\"][\"topIntent\"]))\nprint(\"category: {}\".format(result[\"result\"][\"prediction\"][\"intents\"][0][\"category\"]))\nprint(\"confidence score: {}\\n\".format(result[\"result\"][\"prediction\"][\"intents\"][0][\"confidenceScore\"]))\n\nprint(\"entities:\")\nfor entity in result[\"result\"][\"prediction\"][\"entities\"]:\n    print(\"\\ncategory: {}\".format(entity[\"category\"]))\n    print(\"text: {}\".format(entity[\"text\"]))\n    print(\"confidence score: {}\".format(entity[\"confidenceScore\"]))\n    if \"resolutions\" in entity:\n        print(\"resolutions\")\n        for resolution in entity[\"resolutions\"]:\n            print(\"kind: {}\".format(resolution[\"resolutionKind\"]))\n            print(\"value: {}\".format(resolution[\"value\"]))\n    if \"extraInformation\" in entity:\n        print(\"extra info\")\n        for data in entity[\"extraInformation\"]:\n            print(\"kind: {}\".format(data[\"extraInformationKind\"]))\n            if data[\"extraInformationKind\"] == \"ListKey\":\n                print(\"key: {}\".format(data[\"key\"]))\n            if data[\"extraInformationKind\"] == \"EntitySubtype\":\n                print(\"value: {}\".format(data[\"value\"]))\n```\n\n### Analyze Text with an Orchestration App\n\nIf you would like to pass the user utterance to your orchestrator (worflow) app, you can call the `client.analyze_conversation()` method with your orchestration's project name. The orchestrator project simply orchestrates the submitted user utterance between your language apps (Luis, Conversation, and Question Answering) to get the best response according to the user intent. See the next example:\n\n\n```python\n# import libraries\nimport os\nfrom azure.core.credentials import AzureKeyCredential\nfrom azure.ai.language.conversations import ConversationAnalysisClient\n\n# get secrets\nclu_endpoint = os.environ[\"AZURE_CONVERSATIONS_ENDPOINT\"]\nclu_key = os.environ[\"AZURE_CONVERSATIONS_KEY\"]\nproject_name = os.environ[\"AZURE_CONVERSATIONS_WORKFLOW_PROJECT_NAME\"]\ndeployment_name = os.environ[\"AZURE_CONVERSATIONS_WORKFLOW_DEPLOYMENT_NAME\"]\n\n# analyze query\nclient = ConversationAnalysisClient(clu_endpoint, AzureKeyCredential(clu_key))\nwith client:\n    query = \"Reserve a table for 2 at the Italian restaurant\"\n    result = client.analyze_conversation(\n        task={\n            \"kind\": \"Conversation\",\n            \"analysisInput\": {\n                \"conversationItem\": {\n                    \"participantId\": \"1\",\n                    \"id\": \"1\",\n                    \"modality\": \"text\",\n                    \"language\": \"en\",\n                    \"text\": query\n                },\n                \"isLoggingEnabled\": False\n            },\n            \"parameters\": {\n                \"projectName\": project_name,\n                \"deploymentName\": deployment_name,\n                \"verbose\": True\n            }\n        }\n    )\n\n# view result\nprint(\"query: {}\".format(result[\"result\"][\"query\"]))\nprint(\"project kind: {}\\n\".format(result[\"result\"][\"prediction\"][\"projectKind\"]))\n\n# top intent\ntop_intent = result[\"result\"][\"prediction\"][\"topIntent\"]\nprint(\"top intent: {}\".format(top_intent))\ntop_intent_object = result[\"result\"][\"prediction\"][\"intents\"][top_intent]\nprint(\"confidence score: {}\".format(top_intent_object[\"confidenceScore\"]))\nprint(\"project kind: {}\".format(top_intent_object[\"targetProjectKind\"]))\n\nif top_intent_object[\"targetProjectKind\"] == \"Luis\":\n    print(\"\\nluis response:\")\n    luis_response = top_intent_object[\"result\"][\"prediction\"]\n    print(\"top intent: {}\".format(luis_response[\"topIntent\"]))\n    print(\"\\nentities:\")\n    for entity in luis_response[\"entities\"]:\n        print(\"\\n{}\".format(entity))\n```\n\n### Conversational Summarization\n\nYou can use this sample if you need to summarize a conversation in the form of an issue, and final resolution. For example, a dialog from tech support:\n\n```python\n# import libraries\nimport os\nfrom azure.core.credentials import AzureKeyCredential\nfrom azure.ai.language.conversations import ConversationAnalysisClient\n# get secrets\nendpoint = os.environ[\"AZURE_CONVERSATIONS_ENDPOINT\"]\nkey = os.environ[\"AZURE_CONVERSATIONS_KEY\"]\n# analyze query\nclient = ConversationAnalysisClient(endpoint, AzureKeyCredential(key))\nwith client:\n    poller = client.begin_conversation_analysis(\n        task={\n            \"displayName\": \"Analyze conversations from xxx\",\n            \"analysisInput\": {\n                \"conversations\": [\n                    {\n                        \"conversationItems\": [\n                            {\n                                \"text\": \"Hello, how can I help you?\",\n                                \"modality\": \"text\",\n                                \"id\": \"1\",\n                                \"participantId\": \"Agent\"\n                            },\n                            {\n                                \"text\": \"How to upgrade Office? I am getting error messages the whole day.\",\n                                \"modality\": \"text\",\n                                \"id\": \"2\",\n                                \"participantId\": \"Customer\"\n                            },\n                            {\n                                \"text\": \"Press the upgrade button please. Then sign in and follow the instructions.\",\n                                \"modality\": \"text\",\n                                \"id\": \"3\",\n                                \"participantId\": \"Agent\"\n                            }\n                        ],\n                        \"modality\": \"text\",\n                        \"id\": \"conversation1\",\n                        \"language\": \"en\"\n                    },\n                ]\n            },\n            \"tasks\": [\n                {\n                    \"taskName\": \"Issue task\",\n                    \"kind\": \"ConversationalSummarizationTask\",\n                    \"parameters\": {\n                        \"summaryAspects\": [\"issue\"]\n                    }\n                },\n                {\n                    \"taskName\": \"Resolution task\",\n                    \"kind\": \"ConversationalSummarizationTask\",\n                    \"parameters\": {\n                        \"summaryAspects\": [\"resolution\"]\n                    }\n                },\n            ]\n        }\n    )\n\n    # view result\n    result = poller.result()\n    task_results = result[\"tasks\"][\"items\"]\n    for task in task_results:\n        print(f\"\\n{task['taskName']} status: {task['status']}\")\n        task_result = task[\"results\"]\n        if task_result[\"errors\"]:\n            print(\"... errors occurred ...\")\n            for error in task_result[\"errors\"]:\n                print(error)\n        else:\n            conversation_result = task_result[\"conversations\"][0]\n            if conversation_result[\"warnings\"]:\n                print(\"... view warnings ...\")\n                for warning in conversation_result[\"warnings\"]:\n                    print(warning)\n            else:\n                summaries = conversation_result[\"summaries\"]\n                print(\"... view task result ...\")\n                for summary in summaries:\n                    print(f\"{summary['aspect']}: {summary['text']}\")\n```\n\n### Import a Conversation Project\nThis sample shows a common scenario for the authoring part of the SDK\n\n```python\nimport os\nfrom azure.core.credentials import AzureKeyCredential\nfrom azure.ai.language.conversations.authoring import ConversationAuthoringClient\n\nclu_endpoint = os.environ[\"AZURE_CONVERSATIONS_ENDPOINT\"]\nclu_key = os.environ[\"AZURE_CONVERSATIONS_KEY\"]\n\nproject_name = \"test_project\"\n\nexported_project_assets = {\n    \"projectKind\": \"Conversation\",\n    \"intents\": [{\"category\": \"Read\"}, {\"category\": \"Delete\"}],\n    \"entities\": [{\"category\": \"Sender\"}],\n    \"utterances\": [\n        {\n            \"text\": \"Open Blake's email\",\n            \"dataset\": \"Train\",\n            \"intent\": \"Read\",\n            \"entities\": [{\"category\": \"Sender\", \"offset\": 5, \"length\": 5}],\n        },\n        {\n            \"text\": \"Delete last email\",\n            \"language\": \"en-gb\",\n            \"dataset\": \"Test\",\n            \"intent\": \"Delete\",\n            \"entities\": [],\n        },\n    ],\n}\n\nclient = ConversationAuthoringClient(\n    clu_endpoint, AzureKeyCredential(clu_key)\n)\npoller = client.begin_import_project(\n    project_name=project_name,\n    project={\n        \"assets\": exported_project_assets,\n        \"metadata\": {\n            \"projectKind\": \"Conversation\",\n            \"settings\": {\"confidenceThreshold\": 0.7},\n            \"projectName\": \"EmailApp\",\n            \"multilingual\": True,\n            \"description\": \"Trying out CLU\",\n            \"language\": \"en-us\",\n        },\n        \"projectFileVersion\": \"2022-05-01\",\n    },\n)\nresponse = poller.result()\nprint(response)\n\n```\n\n\n## Optional Configuration\n\nOptional keyword arguments can be passed in at the client and per-operation level. The azure-core [reference documentation][azure_core_ref_docs] describes available configurations for retries, logging, transport protocols, and more.\n\n## Troubleshooting\n\n### General\n\nThe Conversations client will raise exceptions defined in [Azure Core][azure_core_exceptions].\n\n### Logging\n\nThis library uses the standard\n[logging][python_logging] library for logging.\nBasic information about HTTP sessions (URLs, headers, etc.) is logged at INFO\nlevel.\n\nDetailed DEBUG level logging, including request/response bodies and unredacted\nheaders, can be enabled on a client with the `logging_enable` argument.\n\nSee full SDK logging documentation with examples [here][sdk_logging_docs].\n\n```python\nimport sys\nimport logging\nfrom azure.core.credentials import AzureKeyCredential\nfrom azure.ai.language.conversations import ConversationAnalysisClient\n\n# Create a logger for the 'azure' SDK\nlogger = logging.getLogger('azure')\nlogger.setLevel(logging.DEBUG)\n\n# Configure a console output\nhandler = logging.StreamHandler(stream=sys.stdout)\nlogger.addHandler(handler)\n\nendpoint = \"https://<my-custom-subdomain>.cognitiveservices.azure.com/\"\ncredential = AzureKeyCredential(\"<my-api-key>\")\n\n# This client will log detailed information about its HTTP sessions, at DEBUG level\nclient = ConversationAnalysisClient(endpoint, credential, logging_enable=True)\nresult = client.analyze_conversation(...)\n```\n\nSimilarly, `logging_enable` can enable detailed logging for a single operation, even when it isn't enabled for the client:\n\n```python\nresult = client.analyze_conversation(..., logging_enable=True)\n```\n\n## Next steps\n\n### More sample code\n\nSee the [Sample README][conversationallanguage_samples] for several code snippets illustrating common patterns used in the CLU Python API.\n\n## Contributing\n\nSee the [CONTRIBUTING.md][contributing] for details on building, testing, and contributing to this library.\n\nThis project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit [cla.microsoft.com][cla].\n\nWhen you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.\n\nThis project has adopted the [Microsoft Open Source Code of Conduct][code_of_conduct]. For more information see the [Code of Conduct FAQ][coc_faq] or contact [opencode@microsoft.com][coc_contact] with any additional questions or comments.\n\n<!-- LINKS -->\n[azure_cli]: https://docs.microsoft.com/cli/azure/\n[azure_portal]: https://portal.azure.com/\n[azure_subscription]: https://azure.microsoft.com/free/\n[language_resource]: https://portal.azure.com/#create/Microsoft.CognitiveServicesTextAnalytics\n[cla]: https://cla.microsoft.com\n[coc_contact]: mailto:opencode@microsoft.com\n[coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/\n[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/\n[cognitive_auth]: https://docs.microsoft.com/azure/cognitive-services/authentication/\n[contributing]: https://github.com/Azure/azure-sdk-for-python/blob/main/CONTRIBUTING.md\n[python_logging]: https://docs.python.org/3/library/logging.html\n[sdk_logging_docs]: https://docs.microsoft.com/azure/developer/python/azure-sdk-logging\n[azure_core_ref_docs]: https://azuresdkdocs.blob.core.windows.net/$web/python/azure-core/latest/azure.core.html\n[azure_core_readme]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/README.md\n[pip_link]:https://pypi.org/project/pip/\n[conversationallanguage_client_src]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/cognitivelanguage/azure-ai-language-conversations\n[conversationallanguage_pypi_package]: https://pypi.org/project/azure-ai-language-conversations/\n[api_reference_documentation]:https://azuresdkdocs.blob.core.windows.net/$web/python/azure-ai-language-conversations/latest/azure.ai.language.conversations.html\n[conversationallanguage_refdocs]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/cognitivelanguage/azure-ai-language-conversations\n[conversationallanguage_docs]: https://docs.microsoft.com/azure/cognitive-services/language-service/conversational-language-understanding/overview\n[conversationallanguage_samples]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/cognitivelanguage/azure-ai-language-conversations/samples/README.md\n[conversationallanguage_restdocs]: https://learn.microsoft.com/rest/api/language/\n[conversationanalysisclient_class]: https://azuresdkdocs.blob.core.windows.net/$web/python/azure-ai-language-conversations/latest/azure.ai.language.conversations.html#azure.ai.language.conversations.ConversationAnalysisClient\n[conversationauthoringclient_class]: https://azuresdkdocs.blob.core.windows.net/$web/python/azure-ai-language-conversations/latest/azure.ai.language.conversations.html#azure.ai.language.conversations.ConversationAuthoringClient\n[azure_core_exceptions]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/README.md\n[azure_language_portal]: https://language.cognitive.azure.com/home\n[cognitive_authentication_aad]: https://docs.microsoft.com/azure/cognitive-services/authentication#authenticate-with-azure-active-directory\n[azure_identity_credentials]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#credentials\n[custom_subdomain]: https://docs.microsoft.com/azure/cognitive-services/authentication#create-a-resource-with-a-custom-subdomain\n[install_azure_identity]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#install-the-package\n[register_aad_app]: https://docs.microsoft.com/azure/cognitive-services/authentication#assign-a-role-to-a-service-principal\n[grant_role_access]: https://docs.microsoft.com/azure/cognitive-services/authentication#assign-a-role-to-a-service-principal\n[default_azure_credential]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/identity/azure-identity#defaultazurecredential\n\n![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-python%2Fsdk%2Ftemplate%2Fazure-template%2FREADME.png)\n\n\n# Release History\n\n## 1.1.0 (2023-06-13)\n\n### Features Added\n- Added support for service version 2023-04-01.\n\n### Breaking Changes\n\n> Note: The following changes are only breaking from the previous beta. They are not breaking since version 1.0.0 when those types and members did not exist.\n\n- Removed support for service version 2022-05-15-preview.\n- Removed support for service version 2022-10-01-preview.\n- Removed support for \"ConversationalPIITask\" analysis with `ConversationAnalysisClient`.\n- Removed support for \"ConversationalSentimentTask\" with `ConversationAnalysisClient`.\n- Removed the following methods from `ConversationAuthoringClient`:\n  - `begin_assign_deployment_resources`\n  - `get_assign_deployment_resources_status`\n  - `begin_unassign_deployment_resources`\n  - `get_unassign_deployment_resources_status`\n  - `begin_delete_deployment_from_resources`\n  - `get_deployment_delete_from_resources_status`\n  - `list_assigned_resource_deployments`\n  - `list_deployment_resources`\n\n## 1.1.0b3 (2022-11-10)\n\n### Features Added\n- Added support for the \"ConversationalSentimentTask\" kind with `begin_conversation_analysis`.\n- Added support for \"chapterTitle\" and \"narrative\" `summaryAspects` options for ConversationalSummarizationTasks.\n- Added methods to the `ConversationAuthoringClient` to manage deployment resources:\n  - `begin_assign_deployment_resources`\n  - `get_assign_deployment_resources_status`\n  - `begin_unassign_deployment_resources`\n  - `get_unassign_deployment_resources_status`\n  - `begin_delete_deployment_from_resources`\n  - `get_deployment_delete_from_resources_status`\n  - `begin_load_snapshot`\n  - `get_load_snapshot_status`\n  - `list_assigned_resource_deployments`\n  - `list_deployment_resources`\n- Added optional `trained_model_label` keyword argument to `begin_export_project`.\n\n### Other Changes\n* This version and all future versions will require Python 3.7+. Python 3.6 is no longer supported.\n\n## 1.1.0b2 (2022-07-01)\n\n### Features Added\n* Added Azure Active Directory (AAD) authentication support\n* Added support for authoring operations with `ConversationAuthoringClient` under the `azure.ai.language.conversations.authoring` namespace.\n\n## 1.0.0 (2022-06-27)\n\n### Features Added\n* Added Azure Active Directory (AAD) authentication support\n* Added more resolution types for entities\n* Added support for authoring operations with `ConversationAuthoringClient` under the `azure.ai.language.conversations.authoring` namespace.\n\n### Breaking Changes\n* Client now uses python dictionaries for method parameters and results instead of classes.\n\n## 1.1.0b1 (2022-05-26)\n\n### Features Added\n* Conversation summarization task (Long-running operation)\n* Conversation PII extraction task (Long-running operation)\n\n### Breaking Changes\n* Client now uses python dictionaries for method parameters and results instead of classes.\n* Many input and result parameter name changes in `analyze_conversation()` method\n\n## 1.0.0b3 (2022-04-19)\n\n### Features Added\n* Entity resolutions\n* Extra features\n\n### Breaking Changes\n* The `ConversationAnalysisOptions` model used as input to the `analyze_conversation` operation is now wrapped in a `CustomConversationalTask` which combines the analysis options with the project parameters into a single model.\n* The `query` within the `ConversationAnalysisOptions` is now further qualified as a `TextConversationItem` with additional properties.\n* The output `AnalyzeConversationResult` is now wrapped in a `CustomConversationalTaskResult` according to the input model.\n\n### Other Changes\n* Python 2.7 is no longer supported. Please use Python version 3.6 or later.\n\n## 1.0.0b1 (2021-11-03)\n\n### Features Added\n* Initial release\n",
    "bugtrack_url": null,
    "license": "MIT License",
    "summary": "Microsoft Azure Conversational Language Understanding Client Library for Python",
    "version": "1.1.0",
    "project_urls": {
        "Bug Reports": "https://github.com/Azure/azure-sdk-for-python/issues",
        "Homepage": "https://github.com/Azure/azure-sdk-for-python",
        "Source": "https://github.com/Azure/azure-sdk-python"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "63cb205b421614d23e90df92eb9aceae7584ff5ebbb9866589a01e8b9a78e444",
                "md5": "fd4160a74aa136fb9091cfb51f5b8735",
                "sha256": "b96797bbc46f8a03fd5807d225b765d474b67a271727ee2bd6387a450e383c2b"
            },
            "downloads": -1,
            "filename": "azure_ai_language_conversations-1.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "fd4160a74aa136fb9091cfb51f5b8735",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 121979,
            "upload_time": "2023-06-14T00:40:05",
            "upload_time_iso_8601": "2023-06-14T00:40:05.716391Z",
            "url": "https://files.pythonhosted.org/packages/63/cb/205b421614d23e90df92eb9aceae7584ff5ebbb9866589a01e8b9a78e444/azure_ai_language_conversations-1.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "bdcef6f8b57a1dcde19465c395734ce9b9ac35f560e4383c9bbcee3011b475d7",
                "md5": "b9d14f4850bca2260b621f944d3ff9b4",
                "sha256": "d3b996bd7134da32db8ade1d5371fac7143b968572ed4c0fa62768d7494b831f"
            },
            "downloads": -1,
            "filename": "azure-ai-language-conversations-1.1.0.zip",
            "has_sig": false,
            "md5_digest": "b9d14f4850bca2260b621f944d3ff9b4",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 186242,
            "upload_time": "2023-06-14T00:40:03",
            "upload_time_iso_8601": "2023-06-14T00:40:03.145149Z",
            "url": "https://files.pythonhosted.org/packages/bd/ce/f6f8b57a1dcde19465c395734ce9b9ac35f560e4383c9bbcee3011b475d7/azure-ai-language-conversations-1.1.0.zip",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-06-14 00:40:03",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Azure",
    "github_project": "azure-sdk-for-python",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "lcname": "azure-ai-language-conversations"
}
        
Elapsed time: 0.21148s