聊天补全API

目的与范围

聊天补全API提供了OpenAI Python库中用于对话式AI交互的主要接口。本文档涵盖了聊天补全资源结构、方法实现、参数配置和响应处理模式。有关具有解析和高级流式传输功能的增强版Beta聊天功能，请参见增强聊天功能。有关更新的统一响应API，请参见响应API。

API资源架构

聊天补全API在主客户端下被组织为分层资源，支持单个补全管理和消息历史访问。

资源层级

来源： api.md81-94 src/openai/types/chat/completion_create_params.py36-409

核心方法实现

补全资源实现了标准的CRUD操作，并专门处理流式响应和消息管理。

来源： api.md81-94 tests/api_resources/chat/test_completions.py26-429

请求配置

聊天补全API通过CompletionCreateParams类型系统支持广泛配置，流式和非流式请求都有独立的参数类。

参数结构

类别	关键参数	目的
核心	`messages`, `model`	必需的对话上下文和模型选择
生成	`temperature`, `top_p`, `max_completion_tokens`	响应生成控制
工具	`tools`, `tool_choice`, `parallel_tool_calls`	函数调用能力
格式	`response_format`, `modalities`	输出格式和媒体类型
行为	`stream`, `stream_options`, `store`	响应传递和存储
高级	`reasoning_effort`, `prediction`, `web_search_options`	模型特定功能

来源： src/openai/types/chat/completion_create_params.py36-308

消息类型和内容

API支持多种消息角色和内容类型，以实现丰富的对话界面。

来源： api.md47-78 src/openai/types/chat/completion_create_params.py12-13

响应类型和处理

API根据流式配置和补全状态返回不同的响应类型。

响应流程

来源： api.md47-78 tests/api_resources/chat/test_completions.py151-238

流式实现

聊天补全API通过服务器发送事件提供了全面的流式传输支持，并针对不同的内容类型进行了专门处理。

流式配置

流式行为通过stream参数和可选的stream_options控制

来源： src/openai/types/chat/completion_create_params.py246-247 src/openai/types/chat/completion_create_params.py381-406

工具和函数集成

聊天补全API为对话中的工具调用和函数执行提供了广泛支持。

工具配置

参数	类型	目的
`tools`	`Iterable[ChatCompletionToolParam]`	可用工具列表
`tool_choice`	`ChatCompletionToolChoiceOptionParam`	工具选择策略
`parallel_tool_calls`	`bool`	启用并发工具执行
`functions`	`Iterable[Function]`	旧版函数定义
`function_call`	`FunctionCall`	旧版函数调用控制

来源： src/openai/types/chat/completion_create_params.py70-91 src/openai/types/chat/completion_create_params.py257-276

高级特性

推理和预测

API支持推理模型和内容预测的高级模型能力。

来源： src/openai/types/chat/completion_create_params.py180-187 src/openai/types/chat/completion_create_params.py167-171 src/openai/types/chat/completion_create_params.py302-308

消息存储与检索

聊天补全API包含消息存储功能，用于持久化对话历史。

存储消息访问

messages子资源提供对存储对话消息的访问

来源： api.md89-94 src/openai/types/chat/completion_create_params.py239-244

与客户端架构集成

聊天补全API与更广泛的客户端架构集成，支持同步和异步操作以及响应包装功能。

客户端集成模式

来源： tests/api_resources/chat/test_completions.py115-148 tests/api_resources/chat/test_completions.py449-873