使用 API 构建定制应用程序
使用 Discovery API 来构建用于搜索数据的定制应用程序或组件。
服务 API 版本控制
API 请求需要采用 version=YYYY-MM-DD
格式的日期的 version 参数。 每当发生向后不兼容的 API 更改时,都会发布 API 的新次版本。
随每个 API 请求一起发送 version 参数。 服务会使用您指定日期的 API 版本,或该日期之前的最新版本。 不要缺省使用当前日期。 而是改为指定与兼容您应用程序的版本相匹配的日期,并使其保持不变,直到应用程序准备好用于更高版本。
当前版本为 2023-03-31
。
获取项目标识 IBM Cloud
此信息仅适用于 IBM Cloud。
要使用API,您必须在请求中构建 URL。 许多 API 方法都需要项目标识。
-
从 IBM Cloud 资源列表中,展开 AI/Machine Learning,然后找到 Discovery 服务实例的服务页面。
-
从 凭证 部分中,复制 URL。 将此值指定为 API 请求中的
{url}
。 -
在此页面上,复制 API 密钥。 您指定的这个值是
{apikey}
。 -
在 Discovery中打开项目,然后转至 集成并部署 > API 信息 页面。
-
复制项目标识。 您指定的这个值是
{project_id}
。如果您正在使用内容挖掘项目,请停留在“共享链接”页面上。 从 Web 浏览器的 位置 字段中,复制以
/projects
开头的 URL。 例如,projects/a8ce5fed-7f33-4405-aa4b-88ffba322712/deploy/beta
。 在 URL 的/projects/
段之后指定的标识是项目标识。 -
使用复制的ID创建请求 URL。
例如,以下请求列出了项目中的集合:
curl -X {request_method} -u "apikey:{apikey}" \ "{url}/v2/projects/{project_id}/collections?version=2019-11-29 -k"
要获取 {collection_id}
,可以使用 列表集合 API 方法。 或者,在产品用户界面中打开集合,然后从 Web 浏览器位置字段复制在页面 URL的 /collections/
段之后显示的集合标识。
使用API IBM Cloud Pak for DataIBM Software Hub
此信息仅适用于 Discovery for Cloud Pak for Data。
要使用API,您必须在请求中构建 URL。
-
从网络客户端主菜单中,依次展开 “服务” 和 “实例”。
-
查找实例,然后单击该实例以打开其摘要页面。
-
滚动到页面的 访问信息 部分,然后复制 URL。 您应将此值指定为
{url}
。 -
另外,复制不记名令牌。 发起 API 调用时,需要传递该令牌。
-
从已启动的应用程序实例,转至“集成和部署 > API 信息”页面。
-
复制项目标识。 您将指定此值为
{project_id}
。如果您正在使用内容挖掘项目,请停留在“共享链接”页面上。 从 Web 浏览器的 位置 字段中,复制以
/projects
开头的 URL。 例如,projects/a8ce5fed-7f33-4405-aa4b-88ffba322712/deploy/beta
。 在 URL 的/projects/
段之后指定的标识是项目标识。 -
使用复制的ID创建请求 URL。
例如,以下请求列出了项目中的集合:
curl -H "Authorization: Bearer {token}" \ "{url}/v2/projects/{project_id}/collections?version=2019-11-29 -k"
为管理员生成的不记名令牌可以访问任何实例,而不考虑为该实例配置的访问设置。
该承载令牌将在12小时后失效。 有关定制会话长度的更多信息,请参阅 设置空闲会话超时。
后续步骤
开发者可以进行以下增强:
- 使用 API 使用发现查询语言定义更复杂的查询。
- 使用 curations 指定要返回以响应特定查询的准确文档。
- 通过 使用 Analyze API 处理文档而不将其存储在集合中。
- 当摄入文档的状态变为
available
或failed
时,使用 文档状态 Webhook API 发送 Webhook 事件。