API Agent 概述

在线编辑

API Agent 用户界面及其关键组件概览。

此页面假定您已经登录 API Agent 。 如果您在登录时需要帮助，请参阅《 入门指南》。
注： 由于定期更新，图片的实际外观和感觉可能会略有不同。 此外，本地 Visual Studio Code 主题和用户界面定制也会影响外观。

连接详细信息

登录后，您可以在左上角栏查看连接详情。 您可以单击 AI 左侧的文本以访问更具体的信息，其中包括 API Connect 管理 URL 和您的医疗服务提供者机构。

左上栏截图

连接详情截图

新建交谈

  1. 单击 IBM API 代理菜单，选择新聊天开始新会话。

    应用程序接口代理菜单截图

  2. 选择供应商组织。 您必须已经是该组织的成员，而且 API Agent 必须已为您启用。 这样您就可以使用 API Agent 了。

    API 代理中的新聊天截图

  3. 单击继续。 显示欢迎信息。

    应用程序接口代理欢迎信息截图

  4. 在 " 键入内容 "字段中，输入文本以开始与 API Agent 互动。

计划

输入命令后， API Agent 会显示或运行一个计划，这是一系列工具，每个工具都有相应的参数，旨在满足用户的要求。
  • 不修改系统的计划（只读操作）会自动执行，无需用户批准。
  • 修改系统状态的计划（如创建、更新或删除资源）需要用户在执行前明确批准。

以下示例显示了 create test cases for the petstore api and run the test cases 的用户消息计划。

宠物店应用程序接口和运行案例示例截图

查看和编辑计划

显示计划后，您可以查看和修改每个工具的建议。 如果 API Agent 提供的默认建议令人满意，您可以批准并继续。

要进行任何更改，请选择 " 编辑计划 "打开 " 编辑计划 "窗口，在该窗口中可以对数值进行更改。

宠物店应用程序接口和运行案例示例中编辑选项的截图

核准

执行任何改变系统状态的工具都需要用户批准。 未经用户明确同意，不得运行这些工具。

理解回应

每个响应都是执行单个工具时显示的结果。 它包括一个摘要，展开箭头选项可查看详细的系统响应。

单击 " 批准 "后，工具将运行并显示回复。 以下是成功运行的一个示例。

错误

如果您的提示要求执行的操作因系统缺乏相应的工具集而无法执行， API Agent 。 API Agent 指出，目前的工具无法完成申请。 然后会列出可用的工具及其简要说明。 任何其他错误都是工具的执行错误。 在这种情况下， API Agent 会提供工具运行期间遇到的错误摘要。

API 代理中提示显示圣何塞天气的截图

正在异常中止

您可以选择忽略生成的计划并发起另一个请求。 如果您选择这样做，之前的提示和操作将被忽略。

API Agent 中已发布 API 的提示列表截图

命令

您可以使用 /commands 直接运行某些可用工具。 如果您输入正斜杠（/），即可查看可用命令列表。

应用程序接口代理中可用命令的截图

要传递参数，必须以 key:value 格式给出值。 在值之前允许有空格，这样更容易指定要上传的文件。 以下是一个使用/command的示例。

键：值格式示例截图

上传和下载文件

某些命令需要上传文件。 文件必须在 Visual Studio Code 工作区中才能上传。

上传文件图标截图

在 " 类型 "字段中输入 @ ，将显示可用文件列表。 当您输入字符时，列表会相应地进行筛选。 您可以在这一过程中的任何时间点选择文件。

在 "输入内容 "栏输入 @ 后列出的文件截图

在 @file name 列出的地方，可以从本地工作区上传文件。

每当提到 api_name 时，您可以将其与 id 、 name:version 或 draft API 的名字一起使用。 只要只有一个API草案具有该特定名称，那么仅使用该名称是可以接受的。 但是，不允许使用API的名称。 当提及 product_name 时，也适用同样的准则。

某些命令允许您从响应中下载文件，下载图标表示下载。

聊天中可下载文件下的下载图标截图