OpenAI Responses

了解如何使用 Agno 中的 OpenAI Responses。

OpenAIResponses 是一个用于通过 Responses API 与 OpenAI 模型进行交互的类。此类提供了一个简化的接口，用于使用 OpenAI 的新 Response API，这与传统的 Chat API 不同。它支持工具使用、文件处理和知识检索等高级功能。

身份验证

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

Mac

export OPENAI_API_KEY=sk-***

示例

在你的 Agent 中使用 OpenAIResponses：

agent.py

from agno.agent import Agent
from agno.media import File
from agno.models.openai.responses import OpenAIResponses

agent = Agent(
    model=OpenAIResponses(id="gpt-4o-mini"),
    tools=[{"type": "file_search"}, {"type": "web_search_preview"}],
    markdown=True,
)

agent.print_response(
    "Summarize the contents of the attached file and search the web for more information.",
    files=[File(url="https://agno-public.s3.amazonaws.com/recipes/ThaiRecipes.pdf")],
)

在此处查看更多示例。

参数

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

名称	类型	默认值	说明
id	str	"gpt-4o"	要使用的 OpenAI 模型 ID。
name	str	"OpenAIResponses"	此响应模型实例的名称。
provider	str	"OpenAI"	模型提供商。
include	Optional[List[str]]	None	要包含在响应中的响应组件列表。
max_output_tokens	Optional[int]	None	响应输出中要生成的最大 token 数。
metadata	Optional[Dict[str, Any]]	None	要随请求包含的附加元数据。
parallel_tool_calls	Optional[bool]	None	是否允许并行工具调用。
reasoning	Optional[Dict[str, Any]]	None	用于启用和控制响应中推理/思考的参数。
store	Optional[bool]	None	是否存储此响应请求的输出以供模型蒸馏或评估。
temperature	Optional[float]	None	控制模型输出的随机性。
top_p	Optional[float]	None	通过核心采样控制多样性。
truncation	Optional[str]	None	如何处理超出 token 限制的内容。
user	Optional[str]	None	代表您的最终用户的唯一标识符。
response_format	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[Dict[str, str]]	None	在所有请求中包含的默认标头。
default_query	Optional[Dict[str, str]]	None	在所有请求中包含的默认查询参数。
http_client	Optional[httpx.Client]	None	一个可选的预配置 HTTP 客户端。
client_params	Optional[Dict[str, Any]]	None	客户端配置的附加参数。
vector_store_name	str	"knowledge_base"	用于文件上传和检索的向量存储的名称。

OpenAIResponses 是 Model 类的一个子类，可以访问相同的参数。