Azure AI 语言#

Azure AI 语言使P用户能够使用面向任务且经过优化的预训练或自定义语言模型，有效地理解和分析文档和对话。此 Prompt flow 工具是各种 Azure AI 语言 API 的包装器。当前支持的功能列表如下：

名称	描述
抽象摘要	从文档生成抽象摘要。
提取式摘要	从文档中提取摘要。
对话摘要	总结对话。
实体识别	识别和分类文档中的实体。
关键短语提取	从文档中提取关键短语。
语言检测	检测文档的语言。
PII 实体识别	识别和编辑文档中的 PII 实体。
对话 PII	识别和编辑对话中的 PII 实体。
情感分析	分析文档的情感。
对话式语言理解	预测用户话语中的意图和实体。
翻译器	翻译文档。

要求#

PyPI 包：promptflow-azure-ai-language。

对于 AzureML 用户：请按照此wiki，从准备计算会话开始。
对于本地用户
```
pip install promptflow-azure-ai-language
```
您可能还想安装用于 VS Code 扩展的 Prompt flow。

先决条件#

该工具调用 Azure AI 语言的 API。要使用它，您必须创建到 Azure AI 语言资源的连接。如果需要，请先创建语言资源。

在 Prompt flow 中，添加新的CustomConnection。
- 在secrets字段下，指定资源的 API 密钥：api_key: <Azure AI Language Resource api key>
- 在configs字段下，指定资源的终结点：endpoint: <Azure AI Language Resource endpoint>

要使用Translator工具，您必须设置到 Azure AI Translator 资源的附加连接。如果需要，请先创建 Translator 资源。

在 Prompt flow 中，添加新的CustomConnection。
- 在secrets字段下，指定资源的 API 密钥：api_key: <Azure AI Translator Resource api key>
- 在configs字段下，指定资源的终结点：endpoint: <Azure AI Translator Resource endpoint>
- 如果您的 Translator 资源是区域性而非全球性的，请同时在configs下指定其区域：region: <Azure AI Translator Resource region>

输入#

当工具参数类型为Document时，它需要符合此规范的dict对象。

示例

my_document = {
    "id": "1",
    "text": "This is some document text!",
    "language": "en"
}

当工具参数类型为Conversation时，它需要一个dict对象。

示例

my_conversation = {
    "id": "meeting_1",
    "language": "en",
    "modality": "text",
    "domain": "generic",
    "conversationItems": [
        {
            "participantId": "person1",
            "role": "generic",
            "id": "1",
            "text": "Hello!"
        },
        {
            "participantId": "person2",
            "role": "generic",
            "id": "2",
            "text": "How are you?"
        }
    ]
}

所有技能都有以下（可选）输入：

名称	类型	描述	必填
max_retries	int	HTTP 请求的最大重试次数。默认值为`5`。	No
max_wait	int	HTTP 请求之间的最大等待时间（秒）。默认值为`60`。	No
parse_response	bool	是否应解析完整的 API JSON 输出以提取单个任务结果。默认值为`False`。	No

HTTP 请求逻辑采用指数回退。请参阅以下特定于技能的输入：

名称	类型	描述	必填
连接	CustomConnection	已创建的与 Azure AI 语言资源的连接。	是
文档	`文档`	输入文档。	是
query	字符串	用于构建摘要的查询。	是
summary_length	字符串（枚举）	所需的摘要长度。枚举值为`short`、`medium`和`long`。	No

名称	类型	描述	必填
连接	CustomConnection	已创建的与 Azure AI 语言资源的连接。	是
文档	`文档`	输入文档。	是
query	字符串	用于构建摘要的查询。	是
sentence_count	int	所需的输出摘要句数。默认值为`3`。	No
sort_by	字符串（枚举）	提取式摘要结果的排序标准。枚举值为`Offset`（按文本中出现的顺序对结果进行排序）和`Rank`（按模型的重要性（即排名分数）对结果进行排序）。默认值为`Offset`。	No

名称	类型	描述	必填
连接	CustomConnection	已创建的与 Azure AI 语言资源的连接。	是
对话	`对话`	输入对话。	是
summary_aspect	字符串（枚举）	所需的摘要“方面”。枚举值为`chapterTitle`（获取任何对话的章节标题）、`issue`（获取客户服务代理和客户之间的网络聊天和服务电话记录中的问题摘要）、`narrative`（获取任何对话的通用摘要）、`resolution`（获取客户服务代理和客户之间的网络聊天和服务电话记录中的解决方案摘要）、`recap`（获取一般摘要）和`follow-up tasks`（获取后续或行动项的摘要）。	是

实体识别	名称	类型	描述	必填
	连接	CustomConnection	已创建的与 Azure AI 语言资源的连接。	是
	文档	`文档`	输入文档。	是

关键短语提取	名称	类型	描述	必填
	连接	CustomConnection	已创建的与 Azure AI 语言资源的连接。	是
	文档	`文档`	输入文档。	是

语言检测	名称	类型	描述	必填
	连接	CustomConnection	已创建的与 Azure AI 语言资源的连接。	是
	text	字符串	输入文本。	是

名称	类型	描述	必填
连接	CustomConnection	已创建的与 Azure AI 语言资源的连接。	是
文档	`文档`	输入文档。	是
域	字符串（枚举）	用于 PII 实体识别的 PII 域。枚举值为`none`（无域）或`phi`（表示应编辑个人健康域中的实体）。默认值为`none`。	No
pii_categories	列表[字符串]	描述要返回的 PII 类别。	No

名称	类型	描述	必填
连接	CustomConnection	已创建的与 Azure AI 语言资源的连接。	是
对话	`对话`	输入对话。	是
pii_categories	列表[字符串]	描述要返回的检测 PII 类别。默认值为`['Default']`。	No
redact_audio_timing	bool	是否应编辑任何检测到的实体的音频流偏移和持续时间。默认值为`False`。	No
编辑源	字符串（枚举）	对于转录对话，此参数提供有关应使用哪种内容类型进行实体检测的信息。检测到的实体的详细信息（例如偏移量、长度和文本本身）将对应于此处选择的文本类型。枚举值为`lexical`、`itn`、`maskedItn`和`text`。默认值为`lexical`。	No
exclude_pii_categories	列表[字符串]	描述要排除的检测 PII 类别。默认值为`[]`。	No

名称	类型	描述	必填
连接	CustomConnection	已创建的与 Azure AI 语言资源的连接。	是
文档	`文档`	输入文档。	是
opinion_mining	bool	是否应启用意见挖掘。默认值为`False`。	No

名称	类型	描述	必填
连接	CustomConnection	已创建的与 Azure AI 语言资源的连接。	是
语言	字符串	输入语言的 ISO 639-1 代码。	是
话语	字符串	单个用户话语或用户话语的 json 数组。	是
project_name	字符串	要调用的对话式语言理解项目。	是
deployment_name	字符串	要调用的对话式语言理解项目部署。	是

名称	类型	描述	必填
连接	CustomConnection	已创建的到 Azure AI Translator 资源的连接。	是
text	字符串	输入文本。	是
至	列表[字符串]	要将输入文本翻译成的语言。	是
source_language	字符串	输入文本的语言。	No
类别	字符串	翻译的类别（域）。此参数用于从使用自定义翻译器构建的自定义系统获取翻译。默认值为`general`。	No
text_type	字符串（枚举）	正在翻译的文本类型。可能的值为`plain`（默认）或`html`。	No

输出#

当输入参数parse_response设置为False（默认值）时，将返回完整的 API JSON 响应（作为dict对象）。
当输入参数parse_response设置为True时，将解析完整的 API JSON 响应以提取与工具给定技能相关的单个任务结果。输出将取决于技能（但仍将是dict对象）。
注意：对于对话式语言理解 (CLU)，输出将是响应列表（完整或已解析），输入中每个检测到的用户话语对应一个响应。

有关 API 响应格式、特定任务结果格式等的详细信息，请参阅 Azure AI 语言的REST API 参考。

示例流#

请在此处查找使用promptflow-azure-ai-language包的示例流。

联系方式#

如有任何问题，请联系 Azure AI 语言 (taincidents@microsoft.com)。