本页面简要介绍了如何使用随 Vertex AI on Google Distributed Cloud (GDC) 气隙环境安装的 API 及其参考文档。
服务端点和发现文档
您需要使用服务端点才能以编程方式与 Vertex AI API 进行交互。
获取 Vertex AI Workbench 端点和发现文档
Vertex AI Workbench KRM API 的 API 端点为：
https://ENDPOINT/apis/aiplatform.gdc.goog/v1
将 ENDPOINT 替换为 Management API 服务器的 API 端点。
如需访问 Vertex AI Workbench 发现文档，请执行以下操作之一：
在浏览器中输入端点网址。
在 curl 等工具中运行
kubectl proxy命令，以在本地计算机上打开一个指向 Management API 服务器的代理。该命令运行后，在浏览器中输入以下网址：http://127.0.0.1:8001/apis/aiplatform.gdc.goog/v1。
获取预训练的 API 端点
如需获取预训练 API 的端点，请查看服务状态和端点。
REST、gRPC、KRM 和客户端库
您可以使用 gRPC 或所提供的某个客户端库访问预训练的 API。客户端库是基于 gRPC 构建的。
或者，您也可以使用 REST 访问某些预训练的 API。
您可以使用 Vertex AI Workbench 的 Kubernetes 资源模型 (KRM) API 来管理 Vertex AI Workbench。
客户端库
Vertex AI 为预训练 API 提供 Python 客户端库。下表比较了使用客户端库的优势和劣势：
| 优点 | 缺点 |
|---|---|
|
由 Google 维护。
内置身份验证。 内置重试功能。 高效的协议缓冲区 HTTP 请求正文。 |
并不适用于所有编程语言。 |
REST
OCR API 和 Translation API 支持 REST。如需了解详情，请参阅以下服务的 REST API 参考文档：
下表比较了使用 REST 的优点和缺点：
| 优点 | 缺点 |
|---|---|
|
简单的 JSON 接口。
Google 和许多第三方工具和库都支持此参数。 |
您必须构建自己的客户端。
您必须实现身份验证。 您必须实现重试。 低效的 JSON HTTP 请求正文。 这些 API 不支持 REST 流式传输。 |
gRPC
预训练 API 支持 gRPC。如需详细了解针对 gRPC 库生成的类型、方法和字段的一般说明，请参阅以下 gRPC 参考文档：
下表比较了使用 gRPC 的优点和缺点：
| 优点 | 缺点 |
|---|---|
|
支持多种编程语言。
高效的协议缓冲区 HTTP 请求正文。 |
您必须从 Google 提供的协议缓冲区生成自己的客户端。
您必须实现身份验证。 您必须实现重试。 |
KRM
Vertex AI Workbench API 支持 KRM。如需了解详情，请参阅 Vertex AI Workbench KRM API 参考文档。
类型、方法和字段名称
根据您使用的是客户端库、REST、gRPC 还是 KRM，API 的类型、方法和字段名称会有以下不同：
- REST 按资源层次结构及其方法进行安排。
- 客户端库和 gRPC 按服务及其方法进行安排。
- KRM 字段名称使用 camelCase，但 API 服务接受 camelCase 或 snake_case。
- REST 和 gRPC 字段名称使用 snake_case。
- 客户端库字段名称使用词首字母大写形式、驼峰式命名法或蛇形命名法，取决于哪种名称对于语言是惯用的。
REST 和 Protocol Buffers
调用 REST API 时，协议缓冲区的默认值行为可能会导致 JSON 响应中缺少字段。这些字段已设置为默认值，因此未包含在响应中。