跳转到内容

Community Integrations

Google Cloud Vertex AI

通过 Google Cloud 的管理平台访问 xAI 的 Grok 模型,享受企业级安全性、治理和统一计费。

本指南介绍如何在 Google Cloud Vertex AI / Gemini Enterprise Agent Platform 上设置和使用 Grok 模型。在 Vertex AI 上的 Grok 通过 OpenAI 兼容 API 作为合作伙伴模型访问,包括 Responses API 和 Chat Completions。模型通过 Model Garden 启用。

先决条件

开始之前,请确保您已具备:

  • 一个已启用计费的活跃 Google Cloud Platform (GCP) 项目。
  • 启用 API 和访问 Model Garden 的权限,例如 Vertex AI 用户或项目编辑者角色。
  • 在您的项目中启用了 aiplatform.googleapis.com API 或等效的 Agent Platform API。
  • 已安装并已通过应用程序默认凭据 (ADC) 进行身份验证的 Google Cloud CLI (gcloud)。

设置 ADC 和您的项目:

bash
gcloud auth application-default login
gcloud config set project YOUR_PROJECT_ID

如果尚未启用所需的 API,请启用它:

bash
gcloud services enable aiplatform.googleapis.com

安装必需的包

bash
pip install -U openai google-cloud-aiplatform

在 Model Garden 中启用 Grok 模型

  1. 前往 Google Cloud Console 的 Model Garden,或在控制台中搜索 "Model Garden"。
  2. 搜索 "Grok",或按发布者 xAI 浏览。
  3. 选择所需的 Grok 模型,例如 Grok 4.2 或 Grok 4.3。
  4. 查看模型卡以了解功能、配额、定价和区域信息。
  5. 如果提示,点击 EnableDeploy / request access
  6. 启用后,该模型可用于 API 调用。

使用 Model Garden 中显示的模型 ID。Vertex 模型名称可能使用发布者前缀,例如:

  • xai/grok-4.5

模型可用性通常与 xAI API 匹配,但受 Google Cloud 区域可用性和配额的限制。

进行首次 API 调用

Vertex AI 上的 Grok 使用 OpenAI 兼容接口。您可以使用标准的 openai Python 库。

身份验证

使用应用程序默认凭据。客户端可以获取您的 gcloud 身份验证或服务帐户凭据。

您可能需要通过环境变量或在客户端中直接设置 Vertex/OpenAI 兼容的基础 URL 或端点。请使用模型卡或 Google Agent Platform 文档中的确切端点。

bash
export OPENAI_BASE_URL="https://YOUR_VERTEX_ENDPOINT"

Responses API 示例

python
from openai import OpenAI

client = OpenAI()  # Uses ADC / env vars automatically

response = client.responses.create(
    model="xai/grok-4.5",
    input="Explain the advantages of using Grok for agentic workflows with parallel tool calling.",
    max_output_tokens=800,
)

print(response.output_text)

Chat Completions 示例

python
from openai import OpenAI

client = OpenAI()

response = client.chat.completions.create(
    model="xai/grok-4.5",
    messages=[
        {
            "role": "user",
            "content": "Which city has a higher temperature right now, Boston or New Delhi, and by how much in Fahrenheit?",
        }
    ],
    tools=[
        {
            "type": "function",
            "function": {
                "name": "get_current_weather",
                "description": "Get the current weather in a given location",
                "parameters": {
                    "type": "object",
                    "properties": {
                        "location": {
                            "type": "string",
                            "description": "The city and state, e.g., San Francisco, CA",
                        },
                        "unit": {"type": "string", "enum": ["celsius", "fahrenheit"]},
                    },
                    "required": ["location"],
                },
            },
        }
    ],
    tool_choice="auto",
)

print(response.choices[0].message.content)

两个接口都支持流式传输,以实现更低的延迟体验。

函数调用和工具使用

Grok 在 Responses API 和 Chat Completions 接口上的工具使用和并行函数调用方面表现出色。为工具定义清晰、严格的架构,以便模型能够可靠地选择和调用它们。

数据保留和合规性

Google Cloud 上 Grok 模型的数据保留和处理由 Google Cloud Vertex AI 政策管理。

  • 许多部署支持零数据保留 (ZDR) 选项。
  • 查看特定的模型卡和您组织的 Google Cloud 数据治理设置。
  • 可以使用 Vertex AI 请求-响应日志记录启用活动日志记录,用于审计和调试目的。

有关详细信息,请参阅 Google Cloud 关于 Vertex AI 数据治理和日志记录的文档。

功能支持

支持的功能包括:

  • Responses API 和 Chat Completions。
  • 函数调用和工具使用,包括并行函数调用。
  • 推理模式 / 扩展思考。
  • 结构化输出 / JSON 模式。
  • 流式传输。
  • 通过 Google Cloud 提供固定配额和承诺使用折扣。

上下文窗口因模型而异。请查看 Model Garden 中特定 Grok 模型的当前限制。

全局、多区域和区域端点

Vertex AI / Gemini Enterprise Agent Platform 提供灵活的端点路由:

  • 全局端点:通过动态路由提供最大可用性;推荐用于大多数用例。
  • 区域端点:通过特定区域路由,以满足严格的合规性要求。

最佳实践

  • 选择与您的延迟、吞吐量和推理要求相匹配的 Grok 模型和端点配置。
  • 优先使用应用程序默认凭据和 IAM 角色,而不是长期密钥。为生产工作负载使用服务帐户。
  • 监控 Google Cloud 计费和配额页面的使用情况。根据需要申请增加配额。
  • 使用清晰的工具架构和明确的输出格式。
  • 启用请求日志记录,并与 Google Cloud Monitoring / Logging 集成。
  • 从直接 xAI API 迁移时,更新基础 URL、客户端配置和模型前缀。大多数提示和工具定义只需进行少量更改即可转移。

故障排除

问题检查内容
身份验证错误运行 gcloud auth application-default login 并验证项目权限。
未找到模型确认模型已在 Model Garden 中启用,并使用确切的 xai/... ID。
超出配额在 Google Cloud 控制台中检查配额,并根据需要申请增加。
端点 / 基础 URL 问题使用模型卡或 Google 文档中的确切端点或环境变量。

当可用时,先在 Google Cloud 控制台 playground / Model Garden 界面上开始,然后转向代码。

后续步骤

  • 探索 Model Garden 中已启用的模型。
  • 构建利用 Grok 工具调用优势的智能应用程序。
  • 与 Google Cloud 服务(如 Cloud Functions 和 Vertex AI Pipelines)集成。
  • 查阅完整的 xAI Grok 文档和模型卡,获取提示技巧和功能说明。

本文档为 docs.x.ai 全站中文翻译,由 AI 自动翻译生成。代码示例请以原文为准。