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

身份验证

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

export OPENAI_API_KEY=sk-***

示例

在你的 Agent 中使用 OpenAIResponses


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 文档

名称类型默认值说明
idstr"gpt-4o"要使用的 OpenAI 模型 ID。
namestr"OpenAIResponses"此响应模型实例的名称。
providerstr"OpenAI"模型提供商。
includeOptional[List[str]]None要包含在响应中的响应组件列表。
max_output_tokensOptional[int]None响应输出中要生成的最大 token 数。
metadataOptional[Dict[str, Any]]None要随请求包含的附加元数据。
parallel_tool_callsOptional[bool]None是否允许并行工具调用。
reasoningOptional[Dict[str, Any]]None用于启用和控制响应中推理/思考的参数。
storeOptional[bool]None是否存储此响应请求的输出以供模型蒸馏或评估。
temperatureOptional[float]None控制模型输出的随机性。
top_pOptional[float]None通过核心采样控制多样性。
truncationOptional[str]None如何处理超出 token 限制的内容。
userOptional[str]None代表您的最终用户的唯一标识符。
response_formatOptional[Any]None一个指定模型必须输出的格式的对象。
request_paramsOptional[Dict[str, Any]]None要包含在请求中的附加参数。
api_keyOptional[str]None用于向 OpenAI 进行身份验证的 API 密钥。
organizationOptional[str]None用于 API 请求的组织。
base_urlOptional[Union[str, httpx.URL]]NoneAPI 请求的基础 URL。
timeoutOptional[float]NoneAPI 请求的超时时间。
max_retriesOptional[int]None失败请求的最大重试次数。
default_headersOptional[Dict[str, str]]None在所有请求中包含的默认标头。
default_queryOptional[Dict[str, str]]None在所有请求中包含的默认查询参数。
http_clientOptional[httpx.Client]None一个可选的预配置 HTTP 客户端。
client_paramsOptional[Dict[str, Any]]None客户端配置的附加参数。
vector_store_namestr"knowledge_base"用于文件上传和检索的向量存储的名称。

OpenAIResponsesModel 类的一个子类,可以访问相同的参数。