OpenAI

了解如何在 Agno 中使用 OpenAI 模型。

GPT 模型是业内顶级的 LLM，并且被 Agents 用作默认 LLM。OpenAI 支持各种世界一流的模型。在此处查看其模型：https://platform.openai.com/docs/models。

我们建议进行实验以找到最适合您用例的模型。以下是一些通用建议：

• gpt-4o 适用于大多数通用用例。
• gpt-4o-mini 模型适用于较小的任务和更快的推理。
• o1 模型适用于复杂的推理和多步任务。
• o3-mini 是一款强大的推理模型，支持工具调用和结构化输出，但成本低得多。

OpenAI 有基于层级的速率限制。有关更多信息，请参阅文档。

身份验证

设置您的 OPENAI_API_KEY 环境变量。您可以在此处从 OpenAI 获取。

Mac

export OPENAI_API_KEY=sk-***

示例

在您的 Agent 中使用 OpenAIChat：

agent.py

from agno.agent import Agent, RunResponse
from agno.models.openai import OpenAIChat

agent = Agent(
    model=OpenAIChat(id="gpt-4o"),
    markdown=True
)

# 在终端中打印响应
agent.print_response("写一个两句话的恐怖故事。")

在此处查看更多示例：../examples/models/openai。

参数

有关更多信息，请参阅OpenAI 文档。

名称	类型	默认值	描述
id	str	"gpt-4o"	要使用的 OpenAI 模型 ID。
name	str	"OpenAIChat"	此聊天模型实例的名称。
provider	str	"OpenAI " + id	模型的提供商。
store	Optional[bool]	None	是否存储此聊天完成请求的输出，用于模型蒸馏或评估产品。
metadata	Optional[Dict[str, Any]]	None	要包含在请求中的其他元数据。
frequency_penalty	Optional[float]	None	根据新标记在文本中的频率对其进行惩罚。
logit_bias	Optional[Any]	None	修改指定标记在完成中出现的可能性。
logprobs	Optional[bool]	None	在概率最高的标记中包含 log 概率。
max_tokens	Optional[int]	None	聊天完成中要生成的最大标记数。
max_completion_tokens	Optional[int]	None	完成中要生成的最大标记数。
modalities	Optional[List[str]]	None	模型支持的模态列表。
audio	Optional[Dict[str, Any]]	None	模型特定于音频的参数。
presence_penalty	Optional[float]	None	根据新标记在文本中是否出现对其进行惩罚。
response_format	Optional[Any]	None	指定模型必须输出格式的对象。
seed	Optional[int]	None	用于确定性采样的种子。
stop	Optional[Union[str, List[str]]]	None	最多 4 个序列，API 将停止生成更多标记。
temperature	Optional[float]	None	控制模型输出的随机性。
top_logprobs	Optional[int]	None	每个标记要返回的 log 概率结果的数量。
user	Optional[str]	None	代表您的最终用户的唯一标识符。
top_p	Optional[float]	None	通过原子核采样控制多样性。
extra_headers	Optional[Any]	None	要随请求发送的其他标头。
extra_query	Optional[Any]	None	要随请求发送的其他查询参数。
request_params	Optional[Dict[str, Any]]	None	要包含在请求中的其他参数。
api_key	Optional[str]	None	用于与 OpenAI 进行身份验证的 API 密钥。
organization	Optional[str]	None	用于 API 请求的组织。
base_url	Optional[Union[str, httpx.URL]]	None	API 请求的基本 URL。
timeout	Optional[float]	None	API 请求的超时时间。
max_retries	Optional[int]	None	失败请求的最大重试次数。
default_headers	Optional[Any]	None	将包含在所有请求中的默认标头。
default_query	Optional[Any]	None	将包含在所有请求中的默认查询参数。
http_client	Optional[httpx.Client]	None	一个可选的预配置 HTTP 客户端。
client_params	Optional[Dict[str, Any]]	None	客户端配置的附加参数。
client	Optional[OpenAIClient]	None	OpenAI 客户端实例。
async_client	Optional[AsyncOpenAIClient]	None	异步 OpenAI 客户端实例。
structured_outputs	bool	False	是否使用模型的结构化输出。
supports_structured_outputs	bool	True	模型是否支持结构化输出。
add_images_to_message_content	bool	True	是否将图像添加到消息内容。
override_system_role	bool	True	是否覆盖系统角色。
system_message_role	str	"developer"	要映射系统消息到的角色。

OpenAIChat 是 Model 类的子类，可以访问相同的参数。