如何获取Yi-Large的API Key（分步指南）

API Key，并探讨其在实际应用中的重要性。

注册并登录零一万物大模型开放平台

在使用Yi-Large API之前，必须在零一万物大模型开放平台注册并登录。该平台是一个功能丰富的生态系统，为用户提供了多种工具，包括API管理、文档资源和技术支持。

注册页面

首先，访问零一万物大模型开放平台，按照提示进行账号注册。注册过程包括填写基本信息和邮箱验证。完成这些步骤后，您将能够使用您的账户信息登录到平台。

账户认证的重要性

完成注册后，用户需要通过平台的认证机制。认证步骤包括提供身份证明和联系方式。这一过程确保平台对所有用户的合法性和合规性，从而保证API使用的安全性和稳定性。只有通过认证的用户才能创建API Key并调用平台的API服务。

创建API Key

完成注册和认证后，接下来就是创建API Key。API Key是您与零一万物大模型开放平台进行互动的唯一标识符。

API Key管理界面

进入工作台后，导航到“API Key管理”菜单。在这个界面，您可以看到系统为您自动生成的API Key，还可以选择创建新的API Key。

如何安全存储API Key

一旦创建了API Key，务必将其安全存储。API Key是访问平台服务的重要凭证，泄露可能导致安全问题。建议使用密码管理器存储API Key，确保只有授权人员可以访问。

安装及调用OpenAI SDK

Python SDK，只需简单配置即可使用。首先，确保您的Python版本至少为3.7.1，OpenAI SDK版本不低于1.0.0。

pip install openai

同步调用示例

下面是一个使用OpenAI SDK进行同步调用的示例：

import openai

from openai import OpenAI

API_BASE = "https://api.lingyiwanwu.com/v1"

API_KEY = "your key"

client = OpenAI(

  api_key=API_KEY,

  base_url=API_BASE

)

completion = client.chat.completions.create(

  model="yi-large-turbo",

  messages=[{"role": "user", "content": "Hi, who are you?"}]

)

print(completion)

流式调用示例

流式调用可以在处理大量数据时提高效率，以下是一个流式调用的示例：

import openai

from openai import OpenAI

API_BASE = "https://api.lingyiwanwu.com/v1"

API_KEY = "your key"

client = OpenAI(

  api_key=API_KEY,

  base_url=API_BASE

)

completion = client.chat.completions.create(

  model="yi-large",

  messages=[{"role": "user", "content": "Hi, who are you?"}],

  stream=True

)

for chunk in completion:

  print(chunk.choices[0].delta.content or "", end="", flush=True)

通过Langchain使用

调用API。首先，安装Langchain库：

pip install langchain_openai

使用Langchain进行API调用

通过Langchain，可以更灵活地选择模型和设置请求参数：

from langchain_openai import ChatOpenAI

from langchain_core.messages import HumanMessage, SystemMessage



chat = ChatOpenAI(

    model="yi-large",

    temperature=0.3,

    max_tokens=200,

    api_key='your key',

    base_url="https://api.lingyiwanwu.com/v1"

)messages = [

    SystemMessage(content="你是一名精通了 golang 的专家"),

    HumanMessage(content="写一个 golang 的 hello world 程序"),

]response = chat.invoke(messages)print(response.content)

环境变量配置API Key和Base URL

为了简化开发过程，可以使用环境变量配置API Key和Base URL。

export OPENAI_API_KEY="your key"

export OPENAI_BASE_URL="https://api.lingyiwanwu.com/v1"

这样，您就可以在代码中省略API Key和Base URL的显式声明，直接使用Langchain来调用API。

常见问题解答

FAQ

问：如何找到零一万物API？

答：可以通过幂简集成平台，通过关键词搜索或API hub分类页查找零一万物API。
问：为什么要设置速率限制？

答：速率限制帮助防止API的滥用，确保公平访问，并管理基础设施的整体负载。
问：回答为什么被截断了？

答：如果回答因超出max_tokens限制被截断，请在调用API时提高max_tokens的数值。
问：如何在LangChain和LlamaIndex中使用Yi Model API？

答：在LangChain中导入ChatOpenAI，并设置api_base、api_key和model参数。在LlamaIndex中使用OpenAILike和ChatMessage进行配置。
问：有哪些替代的AI大模型API服务商？

答：其他服务商包括360多模态大语言模型、语音大模型服务MiniMax等，可以在幂简集成开放平台中找到更多信息。

结论

获取和使用Yi-Large的API Key是一个循序渐进的过程，从注册、认证到调用API，每一步都需要仔细处理。通过对API Key的正确管理和使用，开发者可以充分发挥API的强大功能，为各种应用场景提供支持。希望本指南能够帮助您顺利获取并使用Yi-Large API，为您的项目增添更多的可能性。