为助手添加扩展名
创建自定义扩展后，必须先将其添加到助手中，然后才能通过操作访问。
将扩展添加到助手中可以配置扩展，以便在特定环境中使用，还能使扩展可用，以便从操作中调用。
您可以为每个环境使用不同的配置细节。 例如，您可能希望在草稿环境中为测试服务器使用 URL ，而在实时环境中为生产服务器使用。
有关如何创建自定义扩展的信息，请参阅 《构建自定义扩展》。
将扩展名添加到环境草案中
要在助手中添加自定义扩展，请按照以下步骤操作：
在 “
集成”页面上，滚动至 “扩展 ”部分，找到您要添加的自定义扩展的图块。单击添加。 查看扩展概述，然后单击 "确认"为助手进行配置。
首次向助手添加扩展时，您提供的配置设置只应用于草稿环境。 必须先完成草稿环境的配置，才能在实时环境中添加扩展。 阅读 "为实时环境配置扩展"部分，了解如何将自定义扩展添加到实时环境或其他环境。
阅读 "开始 "步骤中的信息，然后单击 "下一步"。
在身份验证步骤中，指定助手调用服务时要使用的身份验证和服务器信息。
在 "身份验证类型"字段中，选择要使用的身份验证类型（如果 API 未通过身份验证，则选择 "无身份验证"）。 可用的身份验证类型由OpenAPI文档中定义的安全方案决定。
请提供所选身份验证类型所需的其他信息（例如用户名和密码、API密钥、Bearer令牌或 OAuth 2.0 相关信息）。
有关配置 OAuth 2.0 身份验证的更多信息，请参阅 OAuth 2.0 身份验证。
在服务器字段中，选择要使用的服务器 URL。
如果所选 URL 包含任何变量，也请指定要使用的值。 根据 OpenAPI 文档中每个变量的定义方式，您可以从有效值列表中选择或在字段中键入要使用的值。
生成的 URL 消息显示了助手使用的完整 URL ，包括变量值。
单击下一步。
查看操作表显示了助手能够从操作步骤中调用的操作。 “操作”是指对特定资源调用特定的 HTTP 方法（例如
GET或POST）所发出的请求。
对于每项操作，表格中都有一行显示以下信息：
操作：操作说明：操作说明来自OpenAPI文件中的 "
summary（如果存在）或 "description。方法 ：用于发送操作 API 请求的 HTTP 方法。
资源：操作所作用的资源的路径。
要查看有关某项操作的更多信息，请点击表格中该行旁边的图标 
。 详情如下：
请求参数：为操作定义的输入参数列表，以及每个参数的类型和参数是必填还是可选。
响应属性：响应正文中的属性，这些属性被映射为助手可以访问的变量。
单击完成。
单击关闭返回集成页面。
扩展现在已连接到助手，并可在草稿环境中执行操作。
管理扩展
将自定义扩展添加到环境中后，可以查看或替换其OpenAPI文档，并更新身份验证类型。
在扩展名中，单击 "打开"。
选择要管理自定义扩展的环境，然后单击确认。
在 “管理扩展 ”步骤中，如有需要，您可以查看已导入的 OpenAPI 文档。
在"身份验证"选项卡中，你可以看到OpenAPI文档中定义的身份验证方法的相关信息。 "(《世界人权宣言》) 表. 身份验证 "选项卡中的字段表提供了有关 "身份验证 "选项卡中字段的详细信息：
字段名称 |
描述 |
值 |
|---|---|---|
认证类型 |
OpenAPI脚本中设置的身份验证类型。 |
- |
用户名 |
OpenAPI脚本中的用户名证书。 |
例如， |
密码 |
OpenAPI脚本中设置的密码凭证。 |
例如， |
服务器 |
开放式 API 文档中定义的服务器链接，用于连接到 API 扩展。 |
例如， |
OAuth 2.0 认证
如果您正在配置 OAuth 2.0 身份验证，则需要提供的信息取决于授权类型。
有关 OAuth 2.0 的更多信息，请参阅 OAuth 2.0。
要完成 OAuth 的身份验证设置，请按照以下步骤操作：
如果您还没有注册，请向您要访问的外部 API 注册您的应用程序。 复制外部 API 提供的客户端 ID 和客户端密文。
在 "补助金类型"字段中，选择要使用的补助金类型。 可用的授权类型由OpenAPI文档中 "
securitySchemes对象中定义的流程决定。 支持以 "x-开头的授权码、客户凭据、密码和自定义授予类型。
OAuth2 自定义授权类型由 IBM 的 IAM x-<any custom name> 身份验证机制以及 watsonx 使用。
指定注册应用程序时外部 API 提供的所需值。 所需数值取决于补助金类型：
授权类型 |
所需数值 |
|---|---|
授权代码 |
- 客户端 ID \n - 客户端密钥 |
客户机凭证 |
- 客户端 ID \n - 客户端密钥 |
密码 |
- 客户端 ID \n - 客户端密钥 \n - 用户名 \n - 密码 |
|
- 《 openAPI 》规范文件中提到的隐藏字段列表 |
如果使用的是授权码授予类型，请按照以下步骤操作：
从 AI 助手构建器扩展程序的设置页面复制重定向链接 URL ，然后将其粘贴到外部 API 应用程序注册页面的相应字段中。 （重定向地址 URL 有时被称为“回调 URL”。）
单击 "授予访问权限"。 您将被重定向到外部服务网站上的授权页面。 确认授予的访问权限正确无误，点击批准。 然后通过重定向 URL 将您重定向到扩展设置页面。
在客户端身份验证字段中，指定身份验证凭据是在 HTTP 标头中发送，还是作为请求正文的一部分发送。 (在请求正文中发送的凭据使用 "
x-www-form-urlencoded内容类型） 选择外部服务期望的选项。在标头前缀字段中，指定 "
Authorization标头中访问令牌前面的前缀。 (默认前缀为 "Bearer，这是大多数应用程序的典型前缀）如果使用自定义授予类型 "
x-<any custom name>（例如 x-apikey），请按照以下步骤操作：添加与密文字段相关的密文值。
添加可选参数值（如果有）。
如果外部服务支持“刷新令牌”授权类型，当旧的访问令牌过期时， AI 助手构建器会自动获取新的访问令牌。 如果 OpenAPI 文档定义了 属性 refreshUrl ，则使用指定的 URL；否则，使用 tokenUrlURL。
为实时环境配置扩展
要为实时环境配置扩展，请按照以下步骤操作：
在 “
集成”页面上，滚动至 “扩展 ”部分，找到您要添加的自定义扩展的图块。单击打开。 打开自定义扩展窗口。
在 "环境"字段中，选择 "实时"。 点击 “确认 ”。
重复配置过程，指定要用于实时环境的值。
如果使用多个环境，请按照相同步骤为每个环境配置扩展名。 更多信息，请参阅添加和使用多重环境。
现在，该扩展可在您配置的环境中使用，并可从助手中调用。 有关如何从操作中调用扩展程序的更多信息，请参阅 “调用自定义扩展程序 ”。