可用的 API

重要信息： IBM Cloud Pak® for Data 4.8 版本将于 2025 年 7 月 31 日结束支持 (EOS)。欲了解更多信息，请参阅 IBM Cloud Pak for Data 版本 4.X 的停止服务公告。

在 IBM Cloud Pak for Data 4.8 版本支持结束之前，升级到 IBM Software Hub 5.1 版本。有关更多信息，请参阅从 IBM Cloud Pak for Data 版本 4.8 升级到 IBM Software Hub 版本 5.1。

您有权访问的 API 取决于环境中安装的服务。

IBM Cloud Pak for Data 和在该平台上运行的一些服务提供了可扩展的开放式 API ，可用于收集，组织和分析数据以及将应用程序与 AI 结合使用。通过此 API 集合，您可以完成以下任务。

在业务应用程序中自动执行和管理 AI 生命周期，以便您可以使用 AI。
实施可为 AI 和 ML 应用程序提供数据的数据驱动型流程和操作。

您可以使用单个认证令牌向 Cloud Pak for Data 平台和 API 进行认证。请参阅生成 API 授权令牌。

有关可使用的 API 的更多信息，请参阅以下资源。

Cloud Pak for Data platform API

描述

Cloud Pak for Data 平台 API 是可用于执行以下任务的管理 API。

向平台认证。
管理有权访问平台的用户。
管理平台上定义的角色。
在平台上更新您的用户帐户。
监视 Cloud Pak for Data 平台的状态。

要求

要使用此 API ，必须安装 Cloud Pak for Data control plane 。

API 参考

Cloud Pak for Data 平台应用程序接口: 已针对 Cloud Pak for Data V 4.8.0更新 Cloud Pak for Data Platform API。此 API 适用于 Cloud Pak for Data V 4.8.0 和所有后续版本的 Cloud Pak for Data ，直到创建新版本的 API 为止。
Cloud Pak for Data: 此客户机提供用于在 Cloud Pak for Data中使用 Python 运行时 (例如 Jupyter 和 Jupyterlab) 的方法。
服务实例 API: 如果您是具有 Create service instances 许可权的 Cloud Pak for Data 管理员，请创建，检索和删除服务实例。
警报 API: 使用警报 API 来浏览生成的事件以及配置监视器和警报。
主页自定义卡片 API: 使用定制卡 REST API 创建定制卡以在 Cloud Pak for Data 主页上显示关键性能指标。
保险库和秘密应用程序接口: 使用保险库文件和私钥 API 通过访问控制和审计日志记录来保护凭证和私钥。
卷 API: 使用卷 REST API 在现有 Cloud Pak for Data 存储设备上创建和管理持久卷实例。

AI Factsheets API

描述

使用 AI Factsheets API 可创建模型用例，控制模型跟踪，获取模型事实以及获取有关已部署的跟踪模型上的警报的信息。

要求

要使用此 API ，必须安装 AI Factsheets 服务。

API 参考

概况介绍服务: 使用 AI Factsheets API 与模型库存进行交互。
IBM 人工智能治理事实客户端库 Python: 收集有关在 IBM® Cloud，外部机器学习引擎或独立环境中的 Jupyter Notebook 中运行的不同实验的事实。

Apache Spark 作业 API

描述

在 Cloud Pak for Data中，可以在集群上运行 Spark 作业或应用程序，而无需安装 Watson Studio。使用 Analytics Engine powered by Apache Spark的 Spark 作业 REST API。

您可以使用 Spark 作业 REST API 来提交运行 Spark SQL 或数据变换，数据科学和机器学习作业的任何 Spark 应用程序。提交的每个作业都在专用集群中运行。

要求

要使用此 API ，管理员必须在 Cloud Pak for Data 平台上安装此服务。要确定是否已安装该服务，请打开 "服务" 目录，并检查是否已启用该服务。

API 参考

Spark 作业 API 语法、参数和返回码

Cognos Analytics 工件 API

描述: 使用 Cognos® Analytics API 来管理 Cognos Analytics 报告，仪表板和其他功能中使用的工件。
要求: 要使用此 API ，管理员必须在 Cloud Pak for Data 平台上安装此服务。要确定是否已安装该服务，请打开 "服务" 目录，并检查是否已启用该服务。
API 参考: Cognos Analytics 工件 API

Connections API

描述

Watson 数据 API 包含有关在目录或项目中创建连接的指示信息。

要求

要使用此 API ，必须安装下列其中一个服务:

Common core services 或用于安装 common core services的服务。有关更多信息，请参阅软件需求。
IBM Knowledge Catalog
Watson Studio

API 参考

Watson Data API 中的连接。

您可以在数据 > 平台连接上查看各个数据源属性的表。展开连接资源，然后选择连接属性。

DataStage REST API

描述: 使用 DataStage® REST API 来处理，编译和运行流。 DataStage 流是在基于 JSON 的模式中包含数据集成逻辑的设计时资产。
要求: 要使用此 API ，管理员必须在 Cloud Pak for Data 平台上安装此服务。要确定是否已安装该服务，请打开 "服务" 目录，并检查是否已启用该服务。
API 参考: DataStage REST API

Db2 Data Gate API

描述: 您可以使用应用程序编程接口 (API) 来允许应用程序与 Db2® Data Gate进行通信。
要求: 要使用此 API ，管理员必须在 Cloud Pak for Data 平台上安装此服务。要确定是否已安装该服务，请打开 "服务" 目录，并检查是否已启用该服务。
API 参考: Db2 Data Gate 应用程序接口

Db2 Data Management Console API

描述: Db2 Data Management Console REST API 将连接到服务部署，以便您可以监视数据和数据源。
要求: 要使用此 API ，管理员必须在 Cloud Pak for Data 平台上安装此服务。要确定是否已安装该服务，请打开 "服务" 目录，并检查是否已启用该服务。
API 参考: Db2 Data Management Console REST API

Decision Optimization Python 客户机

描述

您可以使用 Decision Optimization 客户机 API 与 Decision Optimization 实验进行交互。您可以执行以下任务。

创建并运行具有不同数据或模型阐述的 Decision Optimization 实验的多个方案。
获取解决方案结果。

要求

要使用此 API ，管理员必须在 Cloud Pak for Data 平台上安装 Decision Optimization 服务。

API 参考

Decision Optimization Python 客户

IBM Match 360 with Watson API

描述

使用 IBM Match 360 with Watson API 将其强大的主数据匹配功能连接到您的系统和流程。使用 API 和相应的 SDK 来开发与服务交互的应用程序。

配置主数据。: 配置数据模型、管理项目元数据、建议映射和匹配属性，并启动数据匹配过程。
查看和更改主数据。: 在系统中搜索并修改数据。使用 API 来搜索、查看、编辑和导出记录及实体。
匹配数据。: 通过启动匹配和可视化匹配结果及主数据实体来管理数据匹配过程。
管理数据模型。: 管理 IBM Match 360 系统中的元数据。使用 API 来查看和修改模型、匹配算法及组合视图规则。

要求

要使用此 API ，必须安装 IBM Match 360 with Watson 服务。

API 参考

IBM Match 360 with Watson API 参考

了解更多

请参阅管理主数据。

OpenPages API

描述: OpenPages® API 提供对 OpenPages 数据和元数据的访问权。您可以使用 API 来开发用于扩展应用程序的解决方案。
要求: 要使用此 API ，必须安装 OpenPages 服务。
API 参考: OpenPages 开发人员指南

Planning Analytics TM1 REST API

描述: 使用 Planning Analytics TM1® REST API 对 TM1 数据执行创建、读取、更新和删除操作。 TM1 REST API 为 TM1 服务器提供了一个符合开放数据协议（OData）第 4 版的接口，允许客户端查询和更新托管在 TM1 服务器上的数据源。
要求: 要使用此 API ，管理员必须在 Cloud Pak for Data 平台上安装此服务。要确定是否已安装该服务，请打开 "服务" 目录，并检查是否已启用该服务。
API 参考: TM1 REST API

Product Master API

描述

Product Master 提供 REST API 层以访问和管理主数据及相关实体。完整的 REST API 定义可用作 OpenAPI 规范。 REST API 可用于与各种上游和下游系统集成，以及从 Product Master创建或检索内容。

您可以使用 Product Master REST API 来执行以下任务。

创建和扩充主数据。例如，产品，位置，供应商或客户。
按特定于域的分类法对主数据分类。
搜索和查看主数据。
创建和管理数据模型。例如，规范，目录或调度作业。
管理参考数据。例如，分类法或查找。
生成报告并收集审计信息。
上载数字资产并管理与主数据的链接。

要求

要使用此 API ，必须安装 Product Master 服务。

API 参考

Product Master REST API

IBM Knowledge Catalog 的 Watson 数据 API

描述

Watson 数据 API 为 IBM Knowledge Catalog提供功能。您可以使用该 API 来管理数据相关资产以及需要使用这些资产的人员。例如，您可以使用 API 来执行以下任务。

管理分析项目。
管理目录。
管理可用于分析项目和目录的连接。
管理监管策略。
从连接发现资产。
查看资产的沿袭。

要求

要使用此 API ，必须安装 IBM Knowledge Catalog 服务:

API 参考

Watson Data API

Watson Studio 的 Watson 数据 API

描述

Watson 数据 API 为 Watson Studio提供功能。您可以使用该 API 来管理数据相关资产以及需要使用这些资产的人员。例如，您可以使用 API 来执行以下任务。

管理分析项目。
管理目录。
管理可用于分析项目和目录的连接。
管理监管策略。
从连接发现资产。
查看资产的沿袭。

要求

要使用此 API ，必须安装 Watson Studio 服务:

API 参考

Watson Data API

Watson Discovery API 和 SDK

描述

Watson Discovery API 提供了 AI 支持的搜索引擎，可用于从复杂业务文档中抽取答案。

您可以通过 Watson Knowledge Studio 服务增强 Watson Discovery 了解特定于域的语言的能力。

您可以显示 Watson Discovery 在 watsonx Assistant中发现的信息。

您还可以使用 Cloud Pak for Data REST API 来创建 Watson Discovery 服务实例。有关更多信息，请参阅以编程方式创建 Watson Discovery 服务实例。

要求

要使用此 API ，必须安装 Watson Discovery 服务。

API 参考

发现 v2 API

了解更多

请参阅使用 Watson Discovery查找答案。

Watson Machine Learning API

描述

您可以使用 Watson Machine Learning API 或 Python 客户机库对模型和函数进行训练，存储，部署和评分。您可以执行以下任务。

构建和训练分析模型和神经网络。
部署分析模型和神经网络，以便在其他应用程序中使用。

要求

要使用此 API ，必须安装 Watson Machine Learning 服务。

API 参考

Watson Machine Learning API: 使用 Watson Machine Learning REST API 与机器学习资产进行交互。
Watson Machine Learning Python 客户端: 使用 Watson Machine Learning Python 客户机来构建、训练和部署模型和函数，以及运行脚本。

Watson OpenScale API 和 SDK

描述

Watson OpenScale API 提供了注入功能。您可以使用 API 来执行以下任务。

度量 AI 模型的结果。
确保模型是公平的。
确保模型是可解释的。

您还可以使用 Watson OpenScale Python SDK 连接到训练数据以评估批处理部署。

要求

要使用此 API ，必须安装 Watson OpenScale 服务。

API 参考

Watson Pipelines API 和 SDK

描述

目前， Watson Pipelines 仅提供 Python 客户机 API。使用 API 来查询数据，公开输出等。

要求

要使用此 API ，必须安装 Watson Pipelines 服务。

API 参考

Watson Pipelines 用于 API IBM Cloud Pak for Data

Watson Query REST API

描述: Watson Query REST API 将连接到服务部署，以便您可以管理虚拟数据，数据源和用户角色。此外，通过使用 Watson Query REST API ，您可以将数据虚拟化并发布到 IBM Knowledge Catalog中的缺省目录。
要求: 要使用此 API ，管理员必须在 Cloud Pak for Data 平台上安装此服务。要确定是否已安装该服务，请打开 "服务" 目录，并检查是否已启用该服务。
API 参考: Watson Query REST API

Watson Speech services API 和 SDK

描述

Watson Speech services API 和 SDK 组合了两个 Watson 服务。您可以选择要安装哪些服务。可以组合这些服务中的功能以构建 AI 应用程序或使用 AI 增强现有应用程序。

要求

要使用此 API ，必须安装 Watson Speech services 服务。

API 参考

了解更多

请参阅使用 Watson Speech services转录语音。

watsonx.ai API

描述

您可以使用 watsonx.ai API 或 Python 客户机库来推断和调整基础模型。

要求

要使用 watsonx.ai API ，必须安装 watsonx.ai 服务。

API 参考

watsonx.ai 应用程序接口: 使用 REST API 来开发生成性 AI 解决方案。
watsonx.ai Python 图书馆: 使用笔记本来开发生成性 AI 解决方案。

了解更多

请参阅编码生成 AI 解决方案。

watsonx Assistant API 和 SDK

描述

watsonx Assistant API 提供了注入功能。您可以使用此 API 构建进入任何应用程序、设备或通道的会话式接口。该 API 将 Machine Learning 和 Natural Language Understanding 相结合，以提供有吸引力的统一的问题解决体验。

要求

要使用此 API ，必须安装 watsonx Assistant 服务。

API 参考

了解更多

请参阅使用 watsonx Assistant构建助手。

watsonx.governance API 和 SDK

描述

watsonx.governance API 将 AI 监管从预测机器学习模型扩展到生成 AI ，同时监视和降低与模型，用户和数据集相关的风险。这些 API 组合了 AI Factsheets， Watson OpenScale和 OpenPages API 以及 SDK。

要求

要使用此 API ，必须安装 watsonx.governance 服务。

API 参考

了解更多

请参见管理资产， watsonx.governance。