You need to enable JavaScript to run this app.
导航
使用网关访问密钥
最近更新时间:2024.12.17 10:49:09首次发布时间:2024.11.08 10:35:19

本文介绍了如何使用网关访问密钥,包括查看密钥(API Key)、获取调用大模型网关 OpenAPI 的示例代码。

前提条件

您已经创建了网关访问密钥。相关操作,请参见创建网关访问密钥

查看密钥(API Key)

每个网关访问密钥有唯一的 API Key。向大模型网关 OpenAPI 发送请求时,您需要在请求中提供有效的 API Key。
要查看网关访问密钥的 API Key:

  1. 登录大模型网关控制台
  2. 在左侧导航栏,单击 网关访问密钥
  3. 在网关访问密钥列表找到您的网关访问密钥,单击 操作 列的 查看密钥
  4. 查看密钥 对话框,查看和复制相应的 API Key。

    注意

    请务必妥善保管您的网关访问密钥 API Key。API Key 泄露会导致未经授权的使用,为您带来安全风险和资产损失!

    Image

查看代码

大模型网关控制台提供 OpenAPI 的请求示例代码,包含 Curl 和 Python 示例。
要获取调用大模型网关 OpenAPI 的示例代码:

  1. 登录大模型网关控制台

  2. 在左侧导航栏,单击 网关访问密钥

  3. 在网关访问密钥列表找到您的网关访问密钥,单击 操作 列的 查看代码

  4. 查看代码 对话框,查看 CurlPython 示例代码。

    • Curl
      查看代码 对话框默认展示 Curl 示例命令。您可以复制示例命令,并将其粘贴到您的终端工具,以运行您的第一个 API 请求。
    • Python
      查看代码 对话框单击 Python,以查看 Python 示例代码。您可以复制示例代码,并将其粘贴到您的项目代码,以便在业务逻辑中请求大模型网关。

    Image

    使用示例代码前,注意以下内容:

    • 通过 选择模型 参数指定要调用的模型。
      您可以从网关访问密钥绑定的模型中选择一个模型。您选择模型后,代码中的model参数值将自动替换成模型对应的值。
      如果网关访问密钥绑定了多个同一类型的模型,那么当您选择一个模型后,可以单击右侧的图标,查看模型故障转移的预览效果。当前模型调用失败时,大模型网关将依次调用后续的模型。
    • 使用您的网关访问密钥 API Key 替换示例代码中的$VEI_API_KEY
    • (可选)如果您开启了调用认证功能,则需要将示例代码中的$ENCRYPTED_INFO替换成与大模型网关技术团队约定的加密文本。您可以在网关访问密钥详情中了解调用认证的相关配置。

    说明

    调用认证功能目前只向白名单中的用户开放进行测试。如果您对该功能感兴趣,可以通过工单系统联系我们,了解详情。

    Image