根据 Postman 集合创建自定义连接器

备注

本文是有关在 Azure 逻辑应用中创建和使用自定义连接器、Microsoft Power Automate 和 Microsoft Power Apps 以及 调用连接器作为 Microsoft Copilot Studio 中的工具的教程系列教程的一部分。 请务必阅读自定义连接器概述来了解整个流程。

若要创建自定义连接器,请描述要连接到的 API,以便连接器了解 API 的作和数据结构。 在本文中,你将使用 Postman 集合 创建自定义连接器,该集合描述认知服务文本分析情绪 API(本系列的示例)。

有关描述 API 的其他方式,请转到以下主题:

先决条件

检查先决条件,确保拥有创建自定义连接器所需的一切。 您需要:

备注

Postman 是用于创建集合的一个选项,但也可以使用其他工具(如 失眠)创建集合以进行测试。 创建自定义连接器时,集合必须不超过 1 MB。*

导入 Postman Collection

现在,你已准备好使用已创建或下载的 Postman 集合。 该集合包含大部分必需的信息。 在完成自定义连接器向导时,可以查看和更新此信息。 首先导入 逻辑应用Power Automate 和 Power Apps 的 Postman 集合。

为逻辑应用导入 Postman 集合

  1. 转到 Azure 门户,打开前面在创建 Azure 逻辑应用自定义连接器中创建的逻辑应用连接器。

  2. 在连接器的菜单中,选择逻辑应用连接器,然后选择编辑

    编辑逻辑应用连接器

  3. 常规下,选择上载 Postman 集合 V1,然后导航到您创建的 Postman 集合。

    显示“上载 Postman 集合 V1”选项的屏幕截图。

    向导会导入集合,然后将其转换为名为 generatedApiDefinition.swagger.json 的 OpenAPI 定义。

备注

本教程着重介绍 REST API,但是您也可以为逻辑应用使用 SOAP API

为 Power Automate 和 Power Apps 导入 Postman 集合

  1. 转到 make.powerapps.comflow.microsoft.com

  2. 在导航窗格中,选择“更多>发现所有

  3. 在“数据”部分中,选择“ 自定义连接器”。

  4. 依次选择新建自定义连接器导入 Postman collection

  5. 输入自定义连接器的名称,导航到下载或创建的 Postman 集合,然后选择继续

    显示导入集合的步骤的屏幕截图。

    参数
    自定义连接器标题 “SentimentDemo”

    向导导入集合并将其转换为名为 generatedApiDefinition.swagger.json 的 OpenAPI 定义。

更新常规详细信息

从这一点起,本文介绍了 Power Automate UI,但所有三种技术中的步骤大多相同。 必要时突出显示差异。

  1. 常规页上,查看已从 Postman collection 导入的信息,包括 API 的宿主基 URL。 连接器使用宿主和基 URL 来确定如何调用 API。

    备注

    有关连接到本地 API 的详细信息,请参阅使用数据网关连接到本地 API

  2. 将说明更新为有意义的内容。 此说明显示在自定义连接器的详细信息中,并帮助其他用户了解连接器的用途。

    参数
    说明 “Uses the Cognitive Services Text Analytics Sentiment API to determine whether text is positive or negative”

指定身份验证类型

自定义连接器支持多个身份验证选项。 认知服务 API 使用 API 密钥身份验证。

  1. 安全页上的身份验证类型下,选择 API 密钥

  2. API 密钥下,指定参数标签、名称和位置。 选择一种富有表现力且有意义的标签。 此文本将向用户显示,可在他们使用自定义连接器建立连接时提供指导。 参数名称和位置必须与 API 预期的值(在本例中为 Postman 中指定的标头)匹配。 选择连接

    API 密钥参数

    参数
    参数标签 “API 密钥”
    参数名称 “Ocp-Apim-Subscription-Key”
    参数位置 “标头”​​
  3. 在向导顶部,请确保名称设置为“SentimentDemo”,然后选择创建连接器

查看和更新连接器定义

自定义连接器向导提供了许多选项,用于定义连接器的工作原理及其在逻辑应用、流、应用和代理中公开的方式。 本部分介绍 UI 并介绍几个选项,但你可以自行探索更多选项。

查看 UI 和定义

在执行 “定义” 页的步骤之前,请先查看用户界面。

  1. 此区域显示与连接器相关的操作、触发器(适用于逻辑应用和 Power Automate)、引用和所定义的策略。 本例演示了 Postman 集合中的 DetectSentiment 操作。 此连接器中没有任何触发器,但您可以在对 Azure 逻辑应用和 Power Automate 使用 Webhook 中了解自定义连接器的触发器。

    连接器中可定义的操作、触发器、引用和策略的屏幕截图。

  2. 常规区域显示有关当前所选操作或触发器的信息。 此信息来自 Postman collection。 可在此处编辑这些信息,包括逻辑应用或流中操作和参数的可见性属性:

    • 重要:始终先向用户显示
    • :通常在逻辑应用或流中显示
    • 高级:最初在附加菜单下隐藏
    • 内部:不向用户显示
  3. 请求区域根据 Postman 集合中包含的 HTTP 请求显示信息。 在本例中,您会看到 HTTP 谓词POST,URL 为“/text/analytics/v2.0/sentiment”(API 的完整 URL 为 <https://westus.api.cognitive.microsoft.com//text/analytics/v2.0/sentiment>)。 稍后您将仔细查看 主体 参数。

  4. 响应区域根据 Postman 集合中包含的 HTTP 响应显示信息。 在本例中,只针对“200”(成功响应)定义了一个响应,但您可以定义更多响应。

  5. 验证区域显示在 API 定义中检测到的任何问题。 在保存连接器之前,请务必检查此区域。

更新定义

现在更改一些设置,使连接器更易于在逻辑应用、Power Automate 或 Power Apps 中使用。

  1. 常规区域中,将摘要更新为“Returns a numeric score representing the sentiment detected”。

  2. 请求区域中,依次选择正文编辑

  3. 参数区域中,现在可以看到 API 预期的三个参数:idlanguagetext。 依次选择 ID编辑

  4. 架构属性区域中更新参数的值,然后选择返回

    编辑架构属性

    参数
    标题 “ID”
    说明 “An identifier for each document that you submit”
    默认值 “1”
    必需 “是”
  5. 参数区域中,依次选择语言编辑,并使用以下值重复上述过程。

    参数
    标题 “语言”
    说明 “The 2 or 4 character language code for the text”
    默认值 “en”
    必需 “是”
  6. 参数区域中,依次选择文本编辑,并使用以下值重复上述过程。

    参数
    标题 "文本"
    说明 “The text to analyze for sentiment”
    默认值 无​
    必需 “是”
  7. 参数区域中,选择返回以返回到主定义页。

  8. 在向导的右上方,选择更新连接器

测试连接器

创建连接器后,对其进行测试以确保其正常工作。 测试仅在 Power Automate 和 Power Apps 中可用。

重要提示

使用 API 密钥时,请在创建连接器后等待几分钟,然后再对其进行测试。 连接器可能尚未准备好立即连接到 API。

  1. 测试页上,选择新建连接

  2. 输入文本分析 API 中的 API 密钥,然后选择创建连接

  3. 返回到“测试”页

    • 在 Power Automate 中,将会返回到测试页。 选择刷新图标,以确保更新连接信息。
    • 在 Power Apps 中,将会转到当前环境中的可用连接列表。 选择右上角的齿轮图标,然后选择自定义连接器。 选择创建的连接器,然后返回到测试页。
  4. 测试页上的文本字段中输入一个值(其他字段使用前面设置的默认值),然后选择测试操作

  5. 连接器调用 API,您可以查看响应,其中包括情绪分数。

    连接器响应

限制

在 Power Automate 和 Power Apps 中,如果使用 Postman 集合更新现有自定义连接器,则需要在保存连接器之前重新设置任何以前的自定义项。 例如,您需要重新配置动作的参数的认证类型和默认值。

后续步骤

创建自定义连接器并定义其行为后,请使用连接器。

还可以在组织内共享连接器或获得连接器认证,以便组织外部的人员可以使用连接器。

提供反馈

我们非常感谢大家提出有关连接器平台问题或新功能想法的反馈。 要提供反馈,请转到提交问题或获取连接器帮助,然后选择反馈类型。