整合生成器是一个功能强大的无代码工具，使您可以将人工智能专员连接到任何 API 或数据源，而无需大量技术或编程技能。通过动态内容，个性化您的在线交谈体验并提高自动解决率。
想象一下，一个人工智能专员可以从您的后台系统无缝访问客户信息，从任何其他外部数据源检索数据，或与第三方应用程序交互，而无需您编写任何代码。
凭借动态内容功能，整合生成器可以进行实时数据检索、分析和转换，使您的人工智能专员能够根据个人用户需求提供量身定制的回复、建议和解决方案。
整合生成器凭借其友好的界面、直观的功能和无代码功能，提供了充分的灵活性和自定义性，用户无需具备丰富的技术知识。
在本文章中，我们将探讨整合生成器的主要功能和优势，并逐步指导如何利用其功能将人工智能专员连接到任意 API 或数据源。
入门
要访问整合生成器，只需单击侧导航菜单中的“API 整合”。这将带您进入一个概览列表，您将来所有的整合都将列在其中，方便您访问。最初，您可以选择没有 API 整合或有示例 API 整合，具体取决于您的入门旅程。
要创建新整合，单击右上角的“添加整合”。
为整合提供一个名称，
添加带有更多背景信息的简短描述。
完成后，单击“保存”以前往整合配置页面。
如果您在侧导航栏中没有看到 API 整合，这很可能意味着您不是客户端管理员。我们目前仅限客户端管理员访问整合生成器。在这种情况下，请联系您的客户服务经理讨论您的访问权限。
如果您更喜欢通过视频和音频输入进行学习，可以观看下面由我们自定义工程团队成员 Chloe 制作的介绍视频。
请求参数
首先，您需要配置必要的请求参数，以确保 API 成功响应。这些请求参数包含来自对话的信息，用于定义 API 请求的详情。例如，如果您打算检索要在对话期间显示的特定用户信息，则在请求中包含用户 ID 至关重要。这可确保 API 响应包含与当前参与在线交谈的用户或访问者相关的数据。
以下是已配置请求参数的示例。
除了指定密钥和请求参数类型之外，您还可以选择设置测试值。强烈建议这样做，因为在配置期间使用右上角的测试功能时，将使用此测试值。在实际的实时对话中，该值将在发出请求之前被传递到 API 整合。但是，由于我们缺乏当前实时对话的背景信息，因此有必要设置一个测试值以成功执行 API 调用。
勾选“必填”复选框可以确定请求参数是可选的，还是需要在对话中调用 API 整合之前收集（如果尚未在会话中保存）。
是否包含请求参数取决于被调用 API 的特定要求。对于某些 API，请求参数会附加在 URL 后，而对于另一些 API，请求参数则包含在请求的标头或正文中。请查阅 API 文档以确定应在哪里添加请求参数。识别后，您可以将请求参数添加到 URL、标头或正文，只需引用双花括号括起来的键值 - {{userID}}.
环境
添加请求参数后，即可在环境部分进行 API 调用的主要设置。在整合测试期间或在对话生成器中引用显示的环境名称旁边，您需要根据基础 API 文档选择方法、URL 和授权类型。
授权类型
我们提供以下授权类型：
| 授权类型 | 描述 | 示例 |
| API 密钥 | 应由 API 所有者提供的简单 API 密钥。 |  |
| 不记名密钥 | 应由 API 所有者提供的另一个密钥。 |  |
| 基本身份验证 | 用户名和密码用于向 API 进行身份验证。 |  |
| OAuth 2.0 | 根据授权类型，需要多个身份验证信息 |  |
| 自定义 | 通过过期密钥授权 | 请参阅 通过整合生成器使用自定义授权。 |
请记得在请求中包含身份验证密钥，将其添加为 {{apiToken}} 添加到所有授权类型的标头（不授权除外）。示例参见页首部分。
标头
标头包含关于请求或客户端与服务器相互通信的其他信息。它们是包含在请求标头部分的键值对。常用的标头包括：
- 内容类型：表示请求正文中数据的格式（例如 JSON、XML、表格数据）。
- 授权：提供凭证或密钥，对发出请求的客户端进行身份验证。
- 用户代理：指定发起请求的用户代理，通常是网络浏览器或客户端应用程序。
- 接受：通知服务器客户端接受的响应格式。
- 缓存控制：定义服务器或中间缓存的缓存指令。
- X-Requested-with：识别客户端发出的请求类型（例如 XMLHTTPRequest、Fetch API）。
正文
API 请求的正文包含发送到 API 的数据。它通常用于需要输入数据以在 API 端进行处理或数据操作的请求。正文可包含各种格式，例如 JSON、XML、纯文本或表格数据，具体取决于 API 和被调用的特定端点。就我们而言，目前仅支持 JSON。
管理环境
为了应对处理 API 的沙盒环境和生产环境挑战，我们已将环境的概念纳入整合生成器。除设置整合时自动创建的默认主环境外，您还可以灵活添加其他环境。
这些额外的环境允许您自定义请求的 URL、身份验证详情、标头和正文，使您可以在 API 中针对特定的沙盒环境或生产环境。
要创建新环境，只需单击环境部分旁的“+”按钮。要复制现有环境，请将鼠标悬停在该环境上，然后从三点菜单中选择“复制”选项。请记住，只有一个环境可设置为默认环境，该环境将位于列表顶部，并在对话生成器中自动选择第一个（除非有意修改）。
如果一个环境没有被任何人工智能专员使用，并且它是唯一环境或默认环境，则可以将其删除。要修改默认设置，只需从三点菜单中选择合适的选项即可。
测试功能
完成 API 请求的设置后，验证所有配置是否都已正确非常有用。为方便此流程，整合生成器在右上角提供了便捷的测试功能。
“测试”按钮可通过后接默认环境名称的“测试”标签轻松识别。单击它后，整合生成器将使用请求参数和环境部分提供的信息向 API 发起请求。然后，从 API 收到的响应将显示在界面右侧的测试整合部分。如果您想使用来自不同环境的请求详情测试 API，只需从测试功能的下拉菜单中选择所需的环境，并再次单击测试按钮。
响应内容
在测试整合部分，整合生成器会显示从 API 获得的响应。响应的内容分为以下对象：
| 物体 | 内容 | 示例 |
| 状态代码 | HTTP 响应状态代码表示特定 HTTP 请求是否已成功完成。了解更多。 | "statusCode"：200 |
| 数据 | 如果请求成功，数据对象将显示 API 的相关数据。但是，如果请求不成功，则会根据相应的状态代码提供更多信息。 |
"data": { "name"：“德国”， "capture"："Berlin", "region"："欧洲"， "population"：83240525, "area":357114} |
| 请求参数 | 在 requestParameters 对象中，整合生成器会显示请求参数，以及用于调用 API 的关联测试值。 |
"requestParameters": { "country":"de"} |
在再次使用测试功能检查具有任何已修改配置的整合之前，请确保保存整合。
场景
每个新创建的整合都包括三个预先配置的场景。其中两个场景可以根据需要自定义或删除，但第三个场景（名为“回退”）无法编辑。此“回退”场景可用作主要的后备选项，以防上述任何场景都未触发。
| 场景 | 默认查询 | 描述 |
| 成功 | 状态代码 >= 200 和 statusCode <300 | 如果 statuscode 在 200 到 300 之间，则应捕获首选/满意路径。 |
| 失败 | 状态代码 < 200 或 statusCode >= 300 | 此场景应捕获状态代码（在 2XX 范围内）的未成功路径。 |
| 回退 | - | 始终触发至少一个场景的回退场景。 |
场景相当于触发 API 整合时对话在对话中所遵循的不同分支。
场景查询
每个 API 整合只能触发一个场景。确定对话期间触发哪个场景的逻辑取决于场景查询和场景定义顺序。
场景查询表示触发特定场景所必须满足的条件。要确定条件是否为 true，整合生成器会检查场景查询以及 API 响应中包含的数据。常用数据字段包括状态代码、API 响应数据对象中特定于 API 的数据，甚至可能包括请求参数中的值。
成功场景的默认场景查询要求 API 响应的状态代码在 200 到 300 的范围内。如果满足此条件，将触发成功场景。
由于可以修改默认场景查询并添加新场景，因此根据 API 响应，来自不同场景的多个场景查询可能会为 true。在这种情况下，场景的顺序决定了触发哪个场景。
为了提供可视化反馈，我们实施了一项功能，可指示根据当前 API 响应将触发哪个场景。它还识别了理论上会触发但由于触发了高阶场景而实际未触发的场景。此外，它还会突出显示因为条件未满足而无法触发的场景。
| 标准匹配 | 可视化 | 描述 |
| 标准匹配项（按顺序排列） |  |
以蓝色单心点突出显示的方案表示将要触发的方案。 |
| 标准不匹配 |  |
以空点突出显示的方案不会被触发。 |
| 标准匹配，但不是顺序中的第一个 |  |
以灰色实心点表示的场景仅在理论上会被触发。 |
要修改场景顺序，只需单击一个场景，然后通过拖动重新排列顺序。除了回退场景（始终排在最后）外，您可以根据偏好调整顺序。
会话参数
配置每个场景时，您可以通过来自后端系统的各种数据点增强对话。您可以通过将 API 响应中的相关信息转换并存储到会话参数中，指定每个场景所需的可访问数据。然后可在建立对话的流程中使用这些会话参数，向访问者显示信息或规划基础工作流程。
会话参数由键值对定义。密钥用作对话生成器中的引用，而查询则用于从 API 响应中转换和提取特定数据以保存值。整合生成器根据当前响应，提供关于已保存值如何在响应值字段中显示的实时反馈。
在上图中，会话参数键值定义为“大写”，可使用花括号 - 项在对话生成器中引用。 {{capital}}.查询确定应转换哪些数据并将其保存为会话参数的值。在本例中，它从 API 响应数据对象内的“大写”字段提取内容。
查询语言 - JSONha
JSONdata 用作场景级别和会话参数级别查询的查询语言。其设计原则是简单查询应易于编写，以便精通技术和不懂技术的专业人士使用。JSONana 的学习曲线较短，因此可以快速掌握。使用 JSONdata，您可以执行基本的功能、转换日期，甚至可以将不同的数据点合并在一起。
JSONdata 是一种有公开文档记录的查询和转换语言，可 在此处找到相关文档。
翻译免责声明：本文章使用自动翻译软件翻译，以便您了解基本内容。 我们已采取合理措施提供准确翻译，但不保证翻译准确性
如对翻译准确性有任何疑问，请以文章的英语版本为准。