IBM Cloud Docs
部署内置 UI 组件

部署内置 UI 组件

对于文档检索和定制项目，提供了一组可供您使用的用户界面组件。

与开发者一起使用 IBM 提供的预构建 UI 组件来部署应用程序。

有关构建您自己的应用程序的更多信息，请参阅 使用 API 构建定制应用程序。

提供了多个内置 UI 组件。

搜索结果

根据查询内容对最相关的段落和表格进行排序。

搜索结果列表
搜索结果
*

试用

构面

使用帮助用户按特定类别和域过滤搜索结果的构面来优化结果。

Facets
Facets

试用

富文档预览

在文档预览中显示结果。 此视图突出显示原始文档文本中的结果段落。 它还显示在文档中检测到的任何扩充项提及项。 丰富的预览功能适用于应用 SDU 模型的源文件，如 PDF、Microsoft PowerPoint, 和 Microsoft Word 文件。

丰富的文档预览
丰富的文档
*

试用

部署项目

要部署您的项目，请完成以下步骤：

  1. 要使用 API，您需要知道项目的项目标识。 转至“集成和部署 > API 信息”页面。

  2. 从“集成和部署 > UI 组件”页面中，查找指向开发者可用于入门的资源的链接。

GitHub 样本应用程序入门

通过 GitHub, 您可以运行一个脚本来启动一个带有预构建 UI 组件的示例应用程序。 事实上，样本应用程序与产品的 改进和定制 页面非常相似，因为产品本身使用这些 UI 组件。

该脚本需要一些必备软件才能运行。 启动脚本后，它会检查系统上是否安装了必需的软件。 如果没有，它会让您知道需要安装什么软件。 如果以下软件包尚未安装，请安装：

脚本需要有关服务实例和项目的信息，以使用为项目配置的数据和搜索设置，并将其应用于样本应用程序。 您必须收集以下信息，以便在脚本稍后要求您提供信息时可以将其与脚本共享:

服务凭证

样本应用程序脚本使用以下信息来构造端点，在此端点中可以发送 API 请求并向服务实例进行认证:

  • URL
  • API 密钥

要获取此信息，请针对您正在使用的部署类型完成相应的步骤:

  • IBM Cloud 从IBM Cloud 资源列表中，展开 AI/Machine Learning 部分，然后查找先前创建的服务实例。 点击实例可打开其概览页面。 从 “证书”部分复制 URL 和API密钥值，并将其保存在您以后可以访问的地方，例如本地文本文件。

  • IBM Cloud Pak for Data 从网络客户端主菜单中，依次展开“服务”和“实例”。IBM Software Hub 从网络客户端主菜单中，展开 “服务”，然后点击 “实例”。 查找实例，然后单击该实例以打开其摘要页面。 滚动到页面的访问信息部分，然后复制 URL 和持票人令牌。 将值存储在以后可以访问这些值的位置，例如本地文本文件。 (不记名令牌充当已安装部署的 API 密钥。)

项目标识

在本教程中创建的项目的唯一标识。

您可以从“集成和部署”页面的 API 信息 选项卡复制项目标识。

要运行用于启动样本应用程序的脚本，请完成以下步骤:

  1. 执行以下某个操作：

    • 如果已下载存储库，请将文件从归档解压缩到系统上的工作目录。 打开命令终端窗口，然后切换到您下载存储库文件的目录。

    • 如果您克隆了存储库，请从您将存储库克隆到的目录打开终端窗口。

  2. 输入以下命令启动脚本：

    ./runExampleApp.sh

    给予脚本时间以设置运行应用程序所需的资源。

    如果缺少任何必需的必备软件包，那么该脚本会让您知道需要安装哪些软件包，然后才能成功使用该脚本。

  3. 当系统提示您指定 authType 时，请输入您使用的认证类型。 根据服务实例的部署方式，类型有所不同:

    • IBM Cloud Enter iam 键

    • IBM Cloud Pak for Data 输入 xml-ph-0000@deepl.internal。IBM Software Hub 请发送电子邮件至。CP4D

      iam 值指示您正在使用 Identity and Access Management，这是 IBM Cloud 用于认证其受管服务的服务。 对于部署在 IBM Cloud Pak for Data 上的已安装实例，应指定 CP4D 代替。

    对于接下来的三个提示，请输入先前复制并保存的信息。

    • url
    • apikey
    • project_id

脚本完成后，它会询问您是否要立即启动样本应用程序。 请发送电子邮件至 y，回复“是”。 这将显示新的 Web 浏览器窗口或选项卡，并在页面中呈现样本应用程序。 示例应用程序的 URL 为 http://localhost:3000/，这意味着该应用程序在本地运行，使用其他电脑的用户无法访问。

显示示例应用用户界面
示例应用
*

样本应用程序为您提供搜索项目的预览。 使用它来测试搜索项目并进行任何必要的调整。

使用样本应用程序完成测试后，可以通过返回到运行初始脚本的终端窗口并按 Ctrl + C 来将其停止。

部署其他项目类型

要分析内容挖掘项目中的数据，请单击 改进和定制 页面中的 启动应用程序。 有关更多信息，请参阅 分析数据。

要从 Document Retreival for Contract 项目分析合同，请提交查询。 有关了解合同信息的更多信息，请参阅 了解合同。

要部署 Conversational Search 项目，请将此项目连接到使用 watsonx Assistant构建的助手。 要执行的一般步骤包括:

  1. 创建助手。

    您可以将 watsonx Assistant 试用套餐用于测试目的。

  2. 将搜索技能添加到助手，然后将其连接到此项目。

  3. 部署助手。

    有关构建 watsonx Assistant 搜索技能的更多信息，请参阅相应的部署文档: