From ec4a1d43d537eb9e1996b87e8c5a42cb9a07dab4 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 2 Sep 2026 02:14:25 +0000 Subject: [PATCH] =?UTF-8?q?[AI]=20docs:=20=E8=87=AA=E5=8A=A8=E6=9B=B4?= =?UTF-8?q?=E6=96=B0=20OpenAI=20=E4=B8=AD=E6=96=87=E7=BF=BB=E8=AF=91?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/zh/.translation-manifest.json | 94 +- docs/zh/api/docs/guides/your-data.md | 296 +-- docs/zh/api/docs/libraries.md | 118 +- docs/zh/api/docs/quickstart.md | 66 +- docs/zh/api/reference/resources/batches.md | 482 ++-- .../resources/batches/methods/cancel.md | 68 +- .../resources/batches/methods/create.md | 104 +- .../resources/batches/methods/list.md | 66 +- .../resources/batches/methods/retrieve.md | 72 +- .../responses/streaming-events.md | 274 +-- .../responses/websocket-events.md | 316 +-- docs/zh/api/reference/resources/chat.md | 1963 +++++++++-------- .../completions/methods/retrieve.md | 182 +- .../completions/streaming-events.md | 20 +- .../zh/api/reference/resources/completions.md | 254 +-- .../resources/completions/methods/create.md | 146 +- 16 files changed, 2261 insertions(+), 2260 deletions(-) diff --git a/docs/zh/.translation-manifest.json b/docs/zh/.translation-manifest.json index 2780d6e..7c369a1 100644 --- a/docs/zh/.translation-manifest.json +++ b/docs/zh/.translation-manifest.json @@ -1,5 +1,5 @@ { - "generatedAt": "2026-09-01T21:30:25.004Z", + "generatedAt": "2026-09-02T02:12:58.511Z", "pages": { "https://developers.openai.com/api/docs/actions/actions-library.md": { "policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5", @@ -1735,21 +1735,21 @@ "policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5", "reviewStatus": "machine", "sourcePath": "docs/en/api/docs/guides/your-data.md", - "sourceSha256": "470ba960f71510e9c01ff2cf3f3938c08e08b55eeed98eca128c6bf68e2953eb", + "sourceSha256": "65d09502e2b1791210448f3d18fcc0f686780a25b5e13d54d945492056a666b0", "sourceUrl": "https://developers.openai.com/api/docs/guides/your-data.md", "targetPath": "docs/zh/api/docs/guides/your-data.md", - "targetSha256": "fc862369dfd0a0d4143181bd3eb0097d8902ee728252309d800ebdf18f2199f3", - "translatedAt": "2026-09-01T20:04:09.728Z" + "targetSha256": "ff5c6ba3a9af639c5f66b5db4ef37fc8afb1d488de1a3cb09eab9437709cbd64", + "translatedAt": "2026-09-02T01:40:52.691Z" }, "https://developers.openai.com/api/docs/libraries.md": { "policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5", "reviewStatus": "machine", "sourcePath": "docs/en/api/docs/libraries.md", - "sourceSha256": "5dab0c297038e0ee85eaf396b5d14d47681a7e4bfc2c7aff9b3bd08296288925", + "sourceSha256": "b60e466cc95f9f0acbb3ed3c4b6b657fd4aa6496be7ceb1ff991cedff9c3afde", "sourceUrl": "https://developers.openai.com/api/docs/libraries.md", "targetPath": "docs/zh/api/docs/libraries.md", - "targetSha256": "fb365fa9c9d3f2cc3757759c055970cd0fa5a9ec44b8cf695e5889bc184d5a83", - "translatedAt": "2026-08-31T07:13:48.470Z" + "targetSha256": "f4db1fcb946793c5355947542d3b0ff56485897104213e582b63888c6ceb962c", + "translatedAt": "2026-09-02T01:37:46.772Z" }, "https://developers.openai.com/api/docs/libraries/openai-cli.md": { "policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5", @@ -1815,11 +1815,11 @@ "policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5", "reviewStatus": "machine", "sourcePath": "docs/en/api/docs/quickstart.md", - "sourceSha256": "3b53be774781d992361ff768b03b8033b71d922824a0e94beca66eda3acea654", + "sourceSha256": "37b2da97ab63d4600fd8ed1f153195aed4203586263bd6f1e2181c59abd59712", "sourceUrl": "https://developers.openai.com/api/docs/quickstart.md", "targetPath": "docs/zh/api/docs/quickstart.md", - "targetSha256": "f02e8b2652ad9dc13d0a6c0040d5fb29243987eee7f47e651492257375936531", - "translatedAt": "2026-09-01T20:08:12.138Z" + "targetSha256": "f9569c360a2e99ba2a6a20cbff97d84e06fb908a58356a67ab10a5f6fc864291", + "translatedAt": "2026-09-02T01:42:10.844Z" }, "https://developers.openai.com/api/docs/supported-countries.md": { "policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5", @@ -1992,54 +1992,54 @@ "translatedAt": "2026-08-30T07:30:46.216Z" }, "https://developers.openai.com/api/reference/resources/batches.md": { - "policySha256": "6e9b1538f41ab5d3db960df19d735ece2c894fe9182904cf1d818170eaeeb7c2", + "policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5", "reviewStatus": "machine", "sourcePath": "docs/en/api/reference/resources/batches.md", - "sourceSha256": "498cde35151362cfa9abbdd9b788b4e0b836d4248da3d20b7311efd25f6cfbf6", + "sourceSha256": "9d42ab38ccc96e774019d4496edc026165a6a138394be1611e03eb4c31192afe", "sourceUrl": "https://developers.openai.com/api/reference/resources/batches.md", "targetPath": "docs/zh/api/reference/resources/batches.md", - "targetSha256": "4e4bab2ac456c2cb54413603c3a0b6d4e8a33d1ba013bb91622e75a48b75e846", - "translatedAt": "2026-08-26T19:32:40.348Z" + "targetSha256": "3ed2076a2c0c9de7c18551962796e97e8cf336fdd46299fae500127155d74759", + "translatedAt": "2026-09-02T01:43:22.699Z" }, "https://developers.openai.com/api/reference/resources/batches/methods/cancel.md": { "policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5", "reviewStatus": "machine", "sourcePath": "docs/en/api/reference/resources/batches/methods/cancel.md", - "sourceSha256": "202e4396936b7a4d7ec0a87e0b1a340e1f79032c5503cad90de212a67a590907", + "sourceSha256": "f603a5dc509434337aa9ae3b8a9a0079ef44eb120f3886b1096bd7224e60c958", "sourceUrl": "https://developers.openai.com/api/reference/resources/batches/methods/cancel.md", "targetPath": "docs/zh/api/reference/resources/batches/methods/cancel.md", - "targetSha256": "b9ff68082d22c89d47eac986185348d6439d5fbea26b548e6d233dc1e0000b18", - "translatedAt": "2026-08-30T07:31:17.798Z" + "targetSha256": "7c57816b44c98690203d6e7a97fa8f72dc4410adba010b665661e535567398bc", + "translatedAt": "2026-09-02T01:43:50.101Z" }, "https://developers.openai.com/api/reference/resources/batches/methods/create.md": { "policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5", "reviewStatus": "machine", "sourcePath": "docs/en/api/reference/resources/batches/methods/create.md", - "sourceSha256": "b152519af5eb5b1524f497f85dc298bd6b0020c445a761fa0d4517b9c028f478", + "sourceSha256": "32d00a38de49f4703e910056813f43a2296581d22910d750c7740feb19aba317", "sourceUrl": "https://developers.openai.com/api/reference/resources/batches/methods/create.md", "targetPath": "docs/zh/api/reference/resources/batches/methods/create.md", - "targetSha256": "d4604fe6b9f03f6bce38222b74ec4bbcadf2761385bdf7b43841bd12cdf9660c", - "translatedAt": "2026-08-30T07:31:51.350Z" + "targetSha256": "7e02c47abdaecce030d07b76c6c04f6323dcc851befa366851f8d29e98001235", + "translatedAt": "2026-09-02T01:44:35.024Z" }, "https://developers.openai.com/api/reference/resources/batches/methods/list.md": { "policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5", "reviewStatus": "machine", "sourcePath": "docs/en/api/reference/resources/batches/methods/list.md", - "sourceSha256": "231906e4ebb728458f5c810c8b9a15ba5c72f8de32944f7a06a4e4faeada1769", + "sourceSha256": "3d54dbd0bc23aa41b50ed6145bee153e265a3b288d9770f2ec083eb891287ad7", "sourceUrl": "https://developers.openai.com/api/reference/resources/batches/methods/list.md", "targetPath": "docs/zh/api/reference/resources/batches/methods/list.md", - "targetSha256": "10324c31354e956896d34808f0870e8252bc11e40870b1271ec93b993a5d2052", - "translatedAt": "2026-08-30T07:32:15.445Z" + "targetSha256": "314fb380e2831b9d5fc35cd2ba0057dc436262f088563e469c776adc657c44ba", + "translatedAt": "2026-09-02T01:45:08.095Z" }, "https://developers.openai.com/api/reference/resources/batches/methods/retrieve.md": { "policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5", "reviewStatus": "machine", "sourcePath": "docs/en/api/reference/resources/batches/methods/retrieve.md", - "sourceSha256": "fdc946031e7dfbbae4d649a316cdef9daf7c3a6d4c67796a7b74d3c1a5f6ba5e", + "sourceSha256": "e00dc113cdde95343c09cd4fe990285431ff54bbdf99496ea728e61a0ea43b82", "sourceUrl": "https://developers.openai.com/api/reference/resources/batches/methods/retrieve.md", "targetPath": "docs/zh/api/reference/resources/batches/methods/retrieve.md", - "targetSha256": "fdeee30a2a5db1c067639bec8504f87ace7b97f055ec19a64498c7f764c8a80c", - "translatedAt": "2026-08-30T07:32:38.573Z" + "targetSha256": "3a5b73a958494b04698313ed0dcf5f9444ed4412306adc43246308359ec8abbb", + "translatedAt": "2026-09-02T01:45:31.588Z" }, "https://developers.openai.com/api/reference/resources/beta/subresources/assistants.md": { "policySha256": "6e9b1538f41ab5d3db960df19d735ece2c894fe9182904cf1d818170eaeeb7c2", @@ -2205,21 +2205,21 @@ "policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5", "reviewStatus": "machine", "sourcePath": "docs/en/api/reference/resources/beta/subresources/responses/streaming-events.md", - "sourceSha256": "3e577195dbac2479ad42166be11ea4d6022a94bfaa3f35741518cd24be408a34", + "sourceSha256": "f4564f1ea0a2047a56551939af975e0d7a44d801cf89a9dfa80165789e4483fd", "sourceUrl": "https://developers.openai.com/api/reference/resources/beta/subresources/responses/streaming-events.md", "targetPath": "docs/zh/api/reference/resources/beta/subresources/responses/streaming-events.md", - "targetSha256": "78c94c419ee8e888507d2cb55ac145c5f937fc6a80a92f8c5f4f33205af82dc6", - "translatedAt": "2026-09-01T20:12:41.060Z" + "targetSha256": "a506d2eb60e346194cc55528186900ed7dbca79eee3ad75c16371d7c471bb8d1", + "translatedAt": "2026-09-02T01:50:17.651Z" }, "https://developers.openai.com/api/reference/resources/beta/subresources/responses/websocket-events.md": { "policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5", "reviewStatus": "machine", "sourcePath": "docs/en/api/reference/resources/beta/subresources/responses/websocket-events.md", - "sourceSha256": "5f9518423752b7859172e668b1b28cc97b0d8426fe3a67c1f4ed03d04e470dd3", + "sourceSha256": "167fc150cb5968887146b1c5589733e690327c983924b58bfa700f33982b3630", "sourceUrl": "https://developers.openai.com/api/reference/resources/beta/subresources/responses/websocket-events.md", "targetPath": "docs/zh/api/reference/resources/beta/subresources/responses/websocket-events.md", - "targetSha256": "2e0d48f76d9c40d2cdd09ee5f0ce32b8c7030f37b3a1a65ec0ccd5ce9c45ed43", - "translatedAt": "2026-09-01T20:17:19.502Z" + "targetSha256": "1af3953957362a7355eb1a5bb726737b7730260b4c903a1dfb69da49d649904a", + "translatedAt": "2026-09-02T01:55:49.469Z" }, "https://developers.openai.com/api/reference/resources/beta/subresources/threads.md": { "policySha256": "6e9b1538f41ab5d3db960df19d735ece2c894fe9182904cf1d818170eaeeb7c2", @@ -2435,51 +2435,51 @@ "policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5", "reviewStatus": "machine", "sourcePath": "docs/en/api/reference/resources/chat.md", - "sourceSha256": "ea003164a8614c35a790d600f3e7925e581694001a90a673d7b16f82eea90316", + "sourceSha256": "06969eccad4d7d6f4a40227e59fc502d6f61de9ba59701a90f3d67651e9d86b0", "sourceUrl": "https://developers.openai.com/api/reference/resources/chat.md", "targetPath": "docs/zh/api/reference/resources/chat.md", - "targetSha256": "2088cdb2e1ca32880320a49f85a3331ca39b492f5d340f355c8430ab46b50920", - "translatedAt": "2026-09-01T20:20:17.015Z" + "targetSha256": "857efd71a75b29f9b871d754ee26b1bef0cfbce09a9b370a2a42876279240089", + "translatedAt": "2026-09-02T02:08:03.027Z" }, "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/retrieve.md": { "policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5", "reviewStatus": "machine", "sourcePath": "docs/en/api/reference/resources/chat/subresources/completions/methods/retrieve.md", - "sourceSha256": "50f5c52c6b6a78efb2ca42aff9dcd9e29074dd25605a417416d702395bdc0f38", + "sourceSha256": "fbdb40c776c12edc0fabc89ab3ca41c01463039a21ac47fe05e1735ccb99a7bf", "sourceUrl": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/retrieve.md", "targetPath": "docs/zh/api/reference/resources/chat/subresources/completions/methods/retrieve.md", - "targetSha256": "feb039fd25eb917ad1c59143db2d3be3e436779c8ab4e6134d00da65d7ba3488", - "translatedAt": "2026-09-01T20:20:54.822Z" + "targetSha256": "f128bf92999d616c3a01d6f02a69b13df21ca59a94998cbfa4cec3ac6932a3f5", + "translatedAt": "2026-09-02T02:09:07.774Z" }, "https://developers.openai.com/api/reference/resources/chat/subresources/completions/streaming-events.md": { "policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5", "reviewStatus": "machine", "sourcePath": "docs/en/api/reference/resources/chat/subresources/completions/streaming-events.md", - "sourceSha256": "5d68c74c7966c206c4f21d8ee1807250e405170de898049f1746331a3f7274b4", + "sourceSha256": "6c962133e0dd636e16b5ab4db474d0b765454f0bc5b81529be8dbea3e0aeb72b", "sourceUrl": "https://developers.openai.com/api/reference/resources/chat/subresources/completions/streaming-events.md", "targetPath": "docs/zh/api/reference/resources/chat/subresources/completions/streaming-events.md", - "targetSha256": "42fbad09a0bdebcebbd73009a1ebbfa165c57ed6e63e85572b3cfeac30d90cb3", - "translatedAt": "2026-09-01T20:21:06.972Z" + "targetSha256": "01fb8e45281d6542c5e98ceba023fd90f3783f62c422b70149bfad6ac790725e", + "translatedAt": "2026-09-02T02:09:31.402Z" }, "https://developers.openai.com/api/reference/resources/completions.md": { "policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5", "reviewStatus": "machine", "sourcePath": "docs/en/api/reference/resources/completions.md", - "sourceSha256": "53edc9d0a41e97440fcdf33b56c832ab5b0f4666f70ed28a70fe1d854f093819", + "sourceSha256": "baa793b7514b2e08509ce3b4720abc34d4e49de96407f3480cb1651d2da47a73", "sourceUrl": "https://developers.openai.com/api/reference/resources/completions.md", "targetPath": "docs/zh/api/reference/resources/completions.md", - "targetSha256": "6624ec23545bb0a92b68c124414ca184681e6e68a48ce80137721527f819fafe", - "translatedAt": "2026-09-01T20:21:49.189Z" + "targetSha256": "573a49d58f1e77dcc335e48dfb225f9af6990c2277d58973961e827840028ef5", + "translatedAt": "2026-09-02T02:11:31.969Z" }, "https://developers.openai.com/api/reference/resources/completions/methods/create.md": { "policySha256": "5d41c8a7a73acf25529f1beffa364a03666ea413b7e792e6db794b8f801777b5", "reviewStatus": "machine", "sourcePath": "docs/en/api/reference/resources/completions/methods/create.md", - "sourceSha256": "524348eab66a17cd22e83e73129874c058cb2fe6e98c2bcaa16a45e13f53fabf", + "sourceSha256": "76826ac01218d5d474e783bc7a9ae00977e560075a230619918a5820c0b4e42e", "sourceUrl": "https://developers.openai.com/api/reference/resources/completions/methods/create.md", "targetPath": "docs/zh/api/reference/resources/completions/methods/create.md", - "targetSha256": "6ee9578b631f99b557f8a2027dd456a82c474c11ad6ce7116f157f32da26dbe5", - "translatedAt": "2026-08-31T07:31:51.607Z" + "targetSha256": "9b00ac59f47e1fbe63f0c94f50bbedf5d392023ffee9a8d53a936bee23b57774", + "translatedAt": "2026-09-02T02:12:58.511Z" }, "https://developers.openai.com/api/reference/resources/containers.md": { "policySha256": "6e9b1538f41ab5d3db960df19d735ece2c894fe9182904cf1d818170eaeeb7c2", diff --git a/docs/zh/api/docs/guides/your-data.md b/docs/zh/api/docs/guides/your-data.md index 3e387c8..1c24155 100644 --- a/docs/zh/api/docs/guides/your-data.md +++ b/docs/zh/api/docs/guides/your-data.md @@ -1,178 +1,178 @@ # OpenAI 平台中的数据控制 -> 如需查看完整文档索引,请参阅 [llms.txt](/llms.txt)。可通过在页面 URL 后附加 `.md` 来获取文档页面的 Markdown 版本。 +> 如需查看完整文档索引,请参阅 [llms.txt](/llms.txt)。如需获取文档页面的 Markdown 版本,可在页面 URL 末尾追加 `.md` 。 -了解 OpenAI 如何使用你的数据,以及你如何进行控制。 +了解 OpenAI 如何使用你的数据,以及你可以如何控制它。 -你的数据归你所有。自 2023 年 3 月 1 日起,发送至 OpenAI API 的数据不会用于训练或改进 OpenAI 模型(除非你明确选择与我们共享数据)。 +你的数据归你所有。自 2023-03-01 起,发送给 OpenAI API 的数据不会用于训练或改进 OpenAI 模型(除非你明确选择与我们共享数据)。 ## 通过 OpenAI API 存储的数据类型 -使用 OpenAI API 时,数据可能以以下形式存储: +在使用 OpenAI API 时,数据可能会被存储为: -- **滥用监控日志:** 你使用平台时生成的日志,OpenAI 为执行我们的 [使用政策](https://openai.com/policies/usage-policies) 和协议以及减轻有害的 AI 使用所必需。 -- **应用状态:** 为完成某项任务或请求而由某些 API 功能持久保存的数据。 +- **滥用监控日志:** 你在使用平台时产生的日志,OpenAI 需要据此执行我们的 [使用政策](https://openai.com/policies/usage-policies) 与协议,并缓解有害的 AI 使用行为。 +- **应用状态:** 部分 API 功能为完成任务或请求而持久化保存的数据。 -## 滥用监控的数据保留控制 +## 用于滥用监控的数据保留控制 -滥用监控日志可能包含特定的客户内容,例如提示和响应,以及从这些客户内容衍生的元数据,例如分类器的输出。默认情况下,API 功能的所有使用都会生成滥用监控日志,并保留最长 30 天,除非法律要求更长的保留期,或者为保护我们的服务或任何第三方免受伤害而合理必要。 +滥用监控日志可能包含某些客户内容,例如提示和响应,以及从这些客户内容派生的元数据,例如分类器输出。默认情况下,会针对所有 API 功能的使用生成滥用监控日志,并保留最长 30 天,除非法律要求更长的保留期,或者更长的保留期是保护我们的服务或任何第三方免受伤害所合理必要的。 -符合条件的客户可在遵守下述限制的前提下,通过获得批准的 [零数据保留](#zero-data-retention) 或 [修改后的滥用监控](#modified-abuse-monitoring) 控制,将客户内容从这些滥用监控日志中排除。目前,这些控制需事先获得 OpenAI 的批准并接受额外要求。已获批准的客户可为其 API 组织或项目在修改后的滥用监控与零数据保留之间选择其一。 +符合条件的客户可以通过获得以下批准,在遵守下方限制的前提下,将其客户内容排除在这些滥用监控日志之外: [Zero Data Retention](#zero-data-retention) 或 [Modified Abuse Monitoring](#modified-abuse-monitoring) 控制。目前,这些控制需事先获得 OpenAI 的批准并满足额外要求。已获批准的客户可以为其 API 组织或项目在 Modified Abuse Monitoring 或 Zero Data Retention 之间进行选择。 -启用修改后的滥用监控或零数据保留的客户有责任确保其用户遵守 OpenAI 的安全与负责任使用 AI 的政策,并遵守适用法律下的任何审核和报告要求。 +启用 Modified Abuse Monitoring 或 Zero Data Retention 的客户负责确保其用户遵守 OpenAI 安全且负责任地使用 AI 的政策,并遵守适用法律下的任何审核和报告要求。 -请联系我们的 [销售团队](https://openai.com/contact-sales) ,以详细了解这些方案并咨询申请资格。 +联系我们的 [销售团队](https://openai.com/contact-sales) 了解有关这些产品的更多信息并咨询资格要求。 -### 改进后的滥用行为监控 +### Modified Abuse Monitoring -修改后的滥用监控会从所有 API 端点的滥用监控日志中排除客户内容(除少数情况下的图像和文件输入外,如下所述 [下文](https://developers.openai.com/api/docs/guides/your-data#image-and-file-inputs)),同时仍允许客户充分利用 OpenAI 平台的全部功能。 +Modified Abuse Monitoring 将客户内容(如以下 [所述](https://developers.openai.com/api/docs/guides/your-data#image-and-file-inputs))所述的罕见情况下的图像和文件输入除外)从所有 API 端点的滥用监控日志中排除,同时仍允许客户使用 OpenAI 平台的全部功能。 ### Zero Data Retention -零数据留存以与 Modified Abuse Monitoring 相同的方式将客户内容排除在滥用监控日志之外。 +零数据留存与修改后的滥用监控一样,将客户内容排除在滥用监控日志之外。 -此外,零数据留存会更改某些端点的行为: `store` 参数 `/v1/responses` 和 `v1/chat/completions` 将始终被视为 `false`,即使请求尝试将该值设置为 `true`. +此外,零数据留存会更改某些端点行为: `store` 参数(针对 `/v1/responses` 和 `v1/chat/completions` 将始终被视为 `false`,即使请求尝试将该值设置为 `true`. -除了这些特定的行为更改外,即使启用了零数据留存,下表中标记为不符合零数据留存资格的端点和功能仍可能存储应用程序状态。 +除了上述特定行为更改外,下表中被标记为不符合零数据留存资格的端点和功能仍可能存储应用状态,即使已启用零数据留存也是如此。 ### Eyes Off -对于获批使用零数据留存或修改后滥用监控的客户,我们保留针对特定客户使模型不符合零数据留存或修改后滥用监控条件的权利,并将提前书面通知受影响的客户。在这种情况下,客户内容将保留在滥用监控日志中,但除非适用法律要求,否则此类内容将被排除在人工审核之外。对于已签署 OpenAI 商业伙伴及医疗保健附录的客户,一旦你的组织 ID 配置为 Eyes Off,即使数据被留存,也可使用符合 BAA 资格的端点处理 PHI。 +对于已获批零数据保留或模型滥用监控豁免的客户,我们保留针对特定客户使相关模型不再适用于零数据保留或模型滥用监控豁免的权利,并会提前书面通知受影响的客户。在此情况下,客户内容将保留在滥用监控日志中,但除非适用法律要求,否则此类内容不会用于人工审阅。对于已签署 OpenAI 商业伙伴与医疗健康附录的客户,一旦您的组织 ID 配置了 Eyes Off,即使数据被保留,符合 BAA 条件的端点也可用于处理 PHI。 -### 安全保留 +### 安全留存 -对于获得零数据保留或修改后滥用监控批准的客户,如果我们合理认为有必要调查或防止严重风险活动,我们保留使特定客户的模型不再符合零数据保留或修改后滥用监控条件的权利,并会提前书面通知受影响的客户。在这种情况下,当我们使用这些模型时,若我们的分类器检测到客户内容可能违反我们的 [使用政策](https://openai.com/policies/usage-policies/) 或你的协议。否则保留策略不受影响。对于已签署 OpenAI 商业伙伴协议与医疗保健附录的客户,一旦你的组织 ID 配置了安全保留功能,符合 BAA 条件的端点即可用于处理 PHI,即使数据被保留。 +对于已获批零数据保留或修改后滥用监控的客户,如果为调查或防止严重风险活动而合理必要时,我们保留使某些模型对这些特定客户不再符合零数据保留或修改后滥用监控条件的权利,并将事先书面通知受影响的客户。在此情况下,当使用这些模型时,对于我们的分类器检测到可能违反我们的 [使用政策](https://openai.com/policies/usage-policies/) 或您的协议的内容,我们可能会保留并人工审查客户内容。否则保留政策不受影响。对于已签署 OpenAI 商业伙伴及医疗保健附录的客户,一旦您的组织 ID 配置了安全保留,即使数据被保留,符合 BAA 条件的端点也可用于处理 PHI。 -### 配置数据保留控制 +### 配置数据保留控制项 -当你的组织获得数据保留控制的使用批准后,你会在 **Data Retention** 标签页中看到它,位置在 [Settings → Organization → Data controls](https://platform.openai.com/settings/organization/data-controls/data-retention)。在该标签页中,你可以在组织和项目级别配置数据保留控制。 +在你的组织获得数据保留控制功能的批准后,你会在 **数据保留** 标签页中看到,位置在 [Settings → Organization → Data controls](https://platform.openai.com/settings/organization/data-controls/data-retention)。在该标签页中,你可以在组织和项目级别配置数据保留控制功能。 -- **组织级控制:** 为整个组织选择零数据留存或修订后的滥用监控。 -- **项目级控制:** 为每个项目选择 `default` 以继承组织级设置,明确选择零数据留存或修订后的滥用监控,或选择 **无** 以对该项目禁用这些控制。 +- **组织级控制:** 在整个组织范围内选择零数据留存或修改后的滥用监控。 +- **项目级控制:** 为每个项目选择 `default` 以继承组织级别的设置,明确选择 Zero Data Retention 或 Modified Abuse Monitoring,或选择 **None** 以禁用该项目的这些控件。 -### 各接口的存储要求与保留控制 +### 各接口的存储要求和留存控制 -下表列出了每个接口会在何时存储应用状态。符合零数据保留(Zero Data Retention)条件的接口不会保留任何客户内容用于应用状态,但仍受下文所述限制的约束。不符合零数据保留条件的接口或能力在启用零数据保留的情况下被使用时,仍可能保留应用状态。 +下表说明了在每个端点上何时存储应用状态。符合零数据保留资格的端点不会保留任何客户内容用于应用状态,但仍受下述限制约束。不符合零数据保留资格的端点或能力在使用过程中可能会保留应用状态,即使你已经启用零数据保留也是如此。 -| 端点 | 用于训练的数据 | 滥用监控保留期 | 应用状态保留期 | 符合零数据保留条件 | 符合 Eyes Off 与安全保留条件 | +| Endpoint | Data used for training | Abuse monitoring retention | Application state retention | Zero Data Retention eligible | Eyes Off and Safety Retention eligible | | -------------------------- | :--------------------: | :------------------------: | :----------------------------: | :----------------------------: | :------------------------------------: | -| `/v1/chat/completions` | 否 | 30 天 | 无,例外情况见下文 | 是,限制条件见下文 | 是,限制条件见下文 | -| `/v1/responses` | 否 | 30 天 | 无,例外情况见下文 | 是,限制条件见下文 | 是,限制条件见下文 | -| `/v1/conversations` | 否 | 直至删除 | 直至删除 | 否 | 否 | -| `/v1/conversations/items` | 否 | 直至删除 | 直至删除 | 否 | 否 | -| `/v1/chatkit/threads` | 否 | 直至删除 | 直至删除 | 否 | 否 | -| `/v1/assistants` | 否 | 30 天 | 直至删除 | 否 | 否 | -| `/v1/threads` | 否 | 30 天 | 直至删除 | 否 | 否 | -| `/v1/threads/messages` | 否 | 30 天 | 直至删除 | 否 | 否 | -| `/v1/threads/runs` | 否 | 30 天 | 直至删除 | 否 | 否 | -| `/v1/threads/runs/steps` | 否 | 30 天 | 直至删除 | 否 | 否 | -| `/v1/vector_stores` | 否 | 30 天 | 直至删除 | 否 | 否 | -| `/v1/images/generations` | 否 | 30 天 | 无 | 是,限制条件见下文 | 否 | -| `/v1/images/edits` | 否 | 30 天 | 无 | 是,限制条件见下文 | 否 | -| `/v1/embeddings` | 否 | 30 天 | 无 | 是 | 否 | -| `/v1/audio/transcriptions` | 否 | 无 | 无 | 是 | 否 | -| `/v1/audio/translations` | 否 | 无 | 无 | 是 | 否 | -| `/v1/audio/speech` | 否 | 30 天 | 无 | 是 | 否 | -| `/v1/files` | 否 | 30 天 | 直至删除\* | 否 | 否 | -| `/v1/fine_tuning/jobs` | 否 | 30 天 | 直至删除 | 否 | 否 | -| `/v1/evals` | 否 | 30 天 | 直至删除 | 否 | 否 | -| `/v1/batches` | 否 | 30 天 | 直至删除 | 否 | 否 | -| `/v1/moderations` | 否 | 无 | 无 | 是 | 否 | -| `/v1/completions` | 否 | 30 天 | 无 | 是 | 否 | -| `/v1/realtime` | 否 | 30 天 | 无 | 是 | 否 | -| `/v1/videos` | 否 | 30 天 | 无 | 否 | 否 | +| `/v1/chat/completions` | No | 30 days | None, see below for exceptions | Yes, see below for limitations | Yes, see below for limitations | +| `/v1/responses` | No | 30 days | None, see below for exceptions | Yes, see below for limitations | Yes, see below for limitations | +| `/v1/conversations` | No | Until deleted | Until deleted | No | No | +| `/v1/conversations/items` | No | Until deleted | Until deleted | No | No | +| `/v1/chatkit/threads` | No | Until deleted | Until deleted | No | No | +| `/v1/assistants` | No | 30 days | Until deleted | No | No | +| `/v1/threads` | No | 30 days | Until deleted | No | No | +| `/v1/threads/messages` | No | 30 days | Until deleted | No | No | +| `/v1/threads/runs` | No | 30 days | Until deleted | No | No | +| `/v1/threads/runs/steps` | No | 30 days | Until deleted | No | No | +| `/v1/vector_stores` | No | 30 days | Until deleted | No | No | +| `/v1/images/generations` | No | 30 days | None | Yes, see below for limitations | No | +| `/v1/images/edits` | No | 30 days | None | Yes, see below for limitations | No | +| `/v1/embeddings` | No | 30 days | None | Yes | No | +| `/v1/audio/transcriptions` | No | None | None | Yes | No | +| `/v1/audio/translations` | No | None | None | Yes | No | +| `/v1/audio/speech` | No | 30 days | None | Yes | No | +| `/v1/files` | No | 30 days | Until deleted\* | No | No | +| `/v1/fine_tuning/jobs` | No | 30 days | Until deleted | No | No | +| `/v1/evals` | No | 30 days | Until deleted | No | No | +| `/v1/batches` | No | 30 days | Until deleted | No | No | +| `/v1/moderations` | No | None | None | Yes | No | +| `/v1/completions` | No | 30 days | None | Yes | No | +| `/v1/realtime` | No | 30 days | None | Yes | No | +| `/v1/videos` | No | 30 days | None | No | No | #### `/v1/chat/completions` -- 音频输出应用状态会存储 1 小时,以支持 [多轮对话](https://developers.openai.com/api/docs/guides/audio). +- 音频输出应用状态会存储 1 小时,以便支持 [多轮对话](https://developers.openai.com/api/docs/guides/audio). - 当为组织启用 Zero Data Retention 时, `store` 参数将始终被视为 `false`,即使请求尝试将该值设置为 `true`. -- 参见 [图像和文件输入](#image-and-file-inputs). -- 提示缓存可能会将加密的键/值张量作为应用状态存储在 GPU 本地存储中。这些数据存储在本地 GPU 机器上,并在 24 小时到期后不再保留。对于 `gpt-5.5` 和 `gpt-5.5-pro`,将 `prompt_cache_retention` 设置为 `in_memory` 会返回错误。对于 GPT-5.6 模型及后续模型系列, `prompt_cache_options.ttl` 控制的是最短缓存生命周期,而非此最长应用状态保留期。若要了解更多信息,请参阅 [提示缓存指南](https://developers.openai.com/api/docs/guides/prompt-caching#prompt-cache-retention). +- 参见 [图像与文件输入](#image-and-file-inputs). +- 提示缓存可能将加密的键/值张量作为应用状态存储在 GPU 本地存储中。这些数据存储在本地 GPU 机器上,并在 24 小时过期后不再保留。对于 `gpt-5.5` 和 `gpt-5.5-pro`,将 `prompt_cache_retention` 设置为 `in_memory` 会返回错误。对于 GPT-5.6 及更高版本的模型系列, `prompt_cache_options.ttl` 控制的是最短缓存生命周期,而不是此最长应用状态保留时长。如需了解更多信息,请参阅 [提示缓存指南](https://developers.openai.com/api/docs/guides/prompt-caching#prompt-cache-retention). #### `/v1/responses` - 除非下文另有说明,Responses API 默认具有 30 天的应用状态保留期,或者当 `store` 参数设置为 `true`。时也是如此。在这些情况下,响应数据将至少存储 30 天。 - 当为组织启用 Zero Data Retention 时, `store` 参数将始终被视为 `false`,即使请求尝试将该值设置为 `true`. -- 后台模式会将响应数据存储到磁盘大约 10 分钟,以支持轮询。对于使用 [Modified Abuse Monitoring](#modified-abuse-monitoring),的项目,包括增强版 Modified Abuse Monitoring,在以下情况下前台请求遵循标准保留期 `store` 被省略或设置为 `true`。后台响应仅在请求明确设置 `store=true`。时遵循标准保留期。如果 `store` 被省略或设置为 `false` 用于后台请求,响应将在临时轮询期结束后被删除。 -- 音频输出应用状态会存储 1 小时,以支持 [多轮对话](https://developers.openai.com/api/docs/guides/audio). -- 参见 [图像和文件输入](#image-and-file-inputs). -- MCP 服务器(与 [远程 MCP 服务器工具](https://developers.openai.com/api/docs/guides/tools-connectors-mcp))一起使用)属于第三方服务,发送到 MCP 服务器的数据适用其各自的数据保留策略。 -- 由 [Hosted Shell](https://developers.openai.com/api/docs/guides/tools-shell#hosted-shell-quickstart) 和 [代码解释器](https://developers.openai.com/api/docs/guides/tools-code-interpreter) 使用的托管容器在容器处于活动状态期间,可能会将临时应用状态写入容器文件系统(由临时块存储提供支持)。当容器过期或被显式删除时,容器数据将被删除。 -- 提示缓存可能会将加密的键/值张量作为应用状态存储在 GPU 本地存储中。这些数据存储在本地 GPU 机器上,并在 24 小时到期后不再保留。对于 `gpt-5.5` 和 `gpt-5.5-pro`,将 `prompt_cache_retention` 设置为 `in_memory` 会返回错误。对于 GPT-5.6 模型及后续模型系列, `prompt_cache_options.ttl` 控制的是最短缓存生命周期,而非此最长应用状态保留期。若要了解更多信息,请参阅 [提示缓存指南](https://developers.openai.com/api/docs/guides/prompt-caching#prompt-cache-retention). -- 当组织未启用 Zero Data Retention 时,所有查询都会对所有受支持的模型使用扩展提示缓存。 -- 对于 服务端压缩,当 `store="false"`. -- 我们支持 [Skills](https://developers.openai.com/api/docs/guides/tools-skills) 提供两种形态:本地执行和基于托管容器的执行。托管技能遵循与托管 shell 相同的容器生命周期:挂载的技能和容器文件在容器处于活动状态期间保持可用,并在容器过期或被删除时被丢弃。 -- 通过网络连接传输给第三方服务的数据适用其各自的数据保留策略。 +- 后台模式将响应数据存储到磁盘约 10 分钟,以支持轮询。对于使用 [Modified Abuse Monitoring](#modified-abuse-monitoring),的项目,包括增强版 Modified Abuse Monitoring,前台请求在 `store` 被省略或设置为 `true`。后台响应仅在请求显式设置 `store=true`。时才会遵循标准保留期。如果 `store` 被省略或设置为 `false` 用于后台请求,则响应会在临时轮询期结束后被删除。 +- 音频输出应用状态会存储 1 小时,以便支持 [多轮对话](https://developers.openai.com/api/docs/guides/audio). +- 参见 [图像与文件输入](#image-and-file-inputs). +- MCP 服务器(与 [远程 MCP 服务器工具](https://developers.openai.com/api/docs/guides/tools-connectors-mcp))一起使用)是第三方服务,发送到 MCP 服务器的数据受其数据保留策略约束。 +- 由 [托管 Shell](https://developers.openai.com/api/docs/guides/tools-shell#hosted-shell-quickstart) 和 [Code Interpreter](https://developers.openai.com/api/docs/guides/tools-code-interpreter) 使用的托管容器可能会在容器处于活动状态时将临时应用状态写入容器文件系统(由临时块存储支持)。容器数据会在容器过期或被显式删除时被删除。 +- 提示缓存可能将加密的键/值张量作为应用状态存储在 GPU 本地存储中。这些数据存储在本地 GPU 机器上,并在 24 小时过期后不再保留。对于 `gpt-5.5` 和 `gpt-5.5-pro`,将 `prompt_cache_retention` 设置为 `in_memory` 会返回错误。对于 GPT-5.6 及更高版本的模型系列, `prompt_cache_options.ttl` 控制的是最短缓存生命周期,而不是此最长应用状态保留时长。如需了解更多信息,请参阅 [提示缓存指南](https://developers.openai.com/api/docs/guides/prompt-caching#prompt-cache-retention). +- 当组织未启用零数据保留时,所有查询都会对所有支持的模型使用扩展提示缓存。 +- 对于 服务端 压缩,当 `store="false"`. +- 我们支持 [Skills](https://developers.openai.com/api/docs/guides/tools-skills) 时,提供两种形态:本地执行和基于托管容器的执行。托管技能遵循与托管 shell 相同的容器生命周期:挂载的技能和容器文件在容器处于活动状态期间保持可用,并在容器过期或被删除时被丢弃。 +- 通过网络连接传输到第三方服务的数据受其数据保留策略约束。 -#### `/v1/assistants`, `/v1/threads`,并且 `/v1/vector_stores` +#### `/v1/assistants`, `/v1/threads`,以及 `/v1/vector_stores` -- 与 Assistants API 相关的对象会在你通过 API 或仪表板删除它们 30 天后从我们的服务器上删除。未通过 API 或仪表板删除的对象将无限期保留。 +- 与 Assistants API 相关的对象在你通过 API 或控制面板删除它们 30 天后,会从我们的服务器上删除。通过 API 或控制面板未删除的对象将被无限期保留。 #### `/v1/images` -- 在使用以下模型时,图像生成兼容零数据保留(Zero Data Retention): `gpt-image-2`, `gpt-image-1.5`, `gpt-image-1`,以及 `gpt-image-1-mini`. +- 在使用 `gpt-image-2`, `gpt-image-1.5`, `gpt-image-1`,时,图像生成与零数据保留兼容,并且 `gpt-image-1-mini`. #### `/v1/files` -- 文件可以通过 API 或仪表板手动删除,也可以通过设置 `expires_after` 参数自动删除。详见 [此处](https://developers.openai.com/api/reference/resources/files/methods/create#files_create-expires_after) 以了解更多信息。 +- 可以通过 API 或控制面板手动删除文件,也可以通过设置 `expires_after` 参数自动删除文件。详见 [此处](https://developers.openai.com/api/reference/resources/files/methods/create#files_create-expires_after) 了解更多信息。 #### `/v1/videos` -- 该 `v1/videos` API 包含一个 工作流,它在处理过程中会将数据保存到磁盘,并保留 48 小时以便调用方下载生成的视频,然后再保留 30 天用于滥用监控。 `v1/videos` 目前被阻止用于 MAM 或 ZDR 请求。如果你的组织已启用数据保留控制,请按照 **无** 中所述,将项目配置为 [配置数据保留控制](#configuring-data-retention-controls) ,以便在 `/v1/videos` 项目中使用。 +- 该 `v1/videos` API 包含一个 工作流,在处理过程中会将数据保存到磁盘,并保留 48 小时以便调用方下载生成的视频,随后保留 30 天用于滥用监控。 `v1/videos` 目前被 MAM 或 ZDR 请求阻止。如果你的组织已启用数据保留控制,请按照 **None** 中的说明,配置一个将其保留设置设为 [配置数据保留控制](#configuring-data-retention-controls) 的项目,以便在该项目中使用 `/v1/videos` 。 -#### 图像和文件输入 +#### 图像与文件输入 -可以将图像和文件作为输入上传至 `/v1/responses` (包括使用 Computer Use 工具时), `/v1/chat/completions`,以及 `/v1/images`。图像和文件输入在提交时会经过 CSAM 内容扫描。如果分类器检测到潜在的 CSAM 内容,该图像将被保留以供人工审核,即使已启用零数据留存、修订后的滥用监控或 Eyes Off。 +图像和文件可以作为输入上传到 `/v1/responses` (包括使用 Computer Use 工具时), `/v1/chat/completions`,以及 `/v1/images`。提交时会对图像和文件输入进行 CSAM 内容扫描。如果分类器检测到潜在的 CSAM 内容,即使已启用零数据留存 (Zero Data Retention)、修订后的滥用监控 (Modified Abuse Monitoring) 或 Eyes Off,该图像也会被保留以供人工审核。 -#### 网页搜索 +#### Web Search -具有实时互联网访问的网页搜索不符合 HIPAA 资格,也不受 BAA 保障。在离线/仅缓存模式下使用网页搜索(`external_web_access: false`)在配合 ZDR 组织内启用 ZDR 项目的 API 密钥使用时,可纳入 BAA 保障范围。此 HIPAA/BAA 指引仅适用于 Responses API `web_search` 工具。注意:预览版变体(`web_search_preview`) 会忽略此参数,表现如同 `external_web_access` 为 `true`。我们建议使用 `web_search`. +具有实时互联网访问的网页搜索不符合 HIPAA 资格,也不在 BAA 覆盖范围内。处于离线/仅缓存模式的网页搜索(`external_web_access: false`)在使用来自 ZDR 组织内启用了 ZDR 的项目的 API 密钥时,有资格获得 BAA 覆盖。此 HIPAA/BAA 指南仅适用于 Responses API `web_search` 工具。注意:预览版变体(`web_search_preview`)会忽略此参数,其行为如同 `external_web_access` 为 `true`。我们建议使用 `web_search`. ## 数据驻留控制 -数据驻留控制是一项项目配置选项,可用于配置 该公司 OpenAI 用于提供服务的所在区域。 +数据驻留控制是一项项目配置选项,允许你配置 OpenAI 用于提供服务的基础设施所在的位置。 -请联系我们的 [销售团队](https://openai.com/contact-sales) 团队,了解你是否符合使用数据驻留控制的资格。使用数据驻留端点会收取 [10% 的附加费用](https://developers.openai.com/api/docs/pricing) ,适用于 2026 年 3 月 5 日当天或之后发布且符合数据驻留条件的模型。 +请联系我们的 [销售团队](https://openai.com/contact-sales) 团队,确认你是否符合使用数据驻留控制的条件。使用数据驻留端点的将收取 [10% 附加费](https://developers.openai.com/api/docs/pricing) ,适用于 2026 年 3 月 5 日及之后发布的、符合数据驻留条件的模型。 -### 数据驻留是如何工作的? +### 数据驻留是如何运作的? -在你的账户上启用数据驻留后,你可以为在账户中新建的项目从下方列出的可用区域中选择一个区域。如果你使用下方列出的受支持端点、模型和快照,那么该项目的客户内容(按你服务协议中的定义)在所选区域内静态存储,以满足端点运行所需的数据持久化要求(例如 /v1/batches)。 +当你的账号启用了数据驻留功能时,你可以为你账号中新建的项目设置一个区域,可选区域见下方列表。如果使用下方列出的受支持端点、模型和快照,该项目的客户内容(定义见你的服务协议)将在所选区域静态存储,前提是相关端点需要持久化数据才能运行(例如 /v1/batches)。 -如果你选择的区域支持区域处理(如下方特别说明),服务也会在所选区域内为你的客户内容执行推理。 +如果你选择的区域支持区域化处理(具体见下方标识),相应服务也会在所选区域内为你的客户内容执行推理。 -数据驻留不适用于系统数据,系统数据可能会在所选区域之外进行处理和存储。系统数据是指不含客户内容的账户数据、元数据和使用数据,这些数据由服务收集并用于管理和运营服务,例如账户信息或直接访问服务的最终用户(例如你的员工)的资料、分析、使用统计、计费信息、支持请求和结构化输出模式。 +数据驻留不适用于系统数据,相关信息可能会在所选区域之外进行处理和存储。系统数据是指不含客户内容的账号数据、元数据和使用数据,这些数据由服务收集并用于管理和运行服务,例如直接访问服务的最终用户(例如你的员工)的账号信息或档案、分析信息、使用统计、计费信息、支持请求以及结构化输出模式。 ### 子处理者与区域请求处理 -OpenAI 使用 [子处理方](https://openai.com/policies/sub-processor-list/) 来提供服务。对于发往 `us.api.openai.com` 或 `eu.api.openai.com`,的请求,OpenAI 使用 [Cloudflare Regional Services](https://developers.cloudflare.com/data-localization/regional-services/) ,以便 TLS 终止和 HTTPS 解密发生在所选的处理区域内。 +OpenAI 使用 [sub-processors](https://openai.com/policies/sub-processor-list/) 来提供服务。对于发往 `us.api.openai.com` 或 `eu.api.openai.com`,的请求,OpenAI 使用 [Cloudflare Regional Services](https://developers.cloudflare.com/data-localization/regional-services/) ,以便 TLS 终止和 HTTPS 解密在所选的处理区域内完成。 -### 局限性 +### 限制 -数据驻留不适用于:(1) 终端用户或客户的接入基础设施所在位置导致客户内容在所选区域之外的任何传输或存储;(2) 由 OpenAI 以外的其他方通过本服务提供的产品、服务或内容;或 (3) 客户内容以外的任何数据,如系统数据。 +数据驻留不适用于:(1) 由于最终用户或客户在访问服务时所使用的基础设施所在地而导致客户内容在所选区域之外的任何传输或存储;(2) 由 OpenAI 以外的各方提供的产品、服务或内容;或 (3) 客户内容之外的任何数据,例如系统数据。 -如果您选择的区域不支持区域化处理(如下文所述),OpenAI 也可能在该区域之外处理并临时存储客户内容,以提供服务。 +如果您所选的区域不支持区域处理(如下所述),OpenAI 也可能会在该区域之外处理并临时存储客户内容,以提供相应服务。 -### 非美国地区的额外要求 +### 非美国地区的其他要求 -要在美国以外的任何地区使用数据驻留,你必须获得滥用监控控制的批准,并签署修订后的保留条款修正案。 +若要将数据驻留设置为美国以外的任何区域,你必须获得滥用监控控制的批准,并签署一份修订后的保留条款。 -选择阿拉伯联合酋长国地区需要额外的批准。请联系 [sales](https://openai.com/contact-sales) 寻求帮助。 +选择阿拉伯联合酋长国区域需要额外审批。请联系 [sales](https://openai.com/contact-sales) 以获取帮助。 ### 如何使用数据驻留 数据驻留是在你的 API 组织内按项目配置的。 -若要为区域存储配置数据驻留,请在创建新项目时从下拉菜单中选择相应的区域。 +若要为区域存储配置数据驻留,请在创建新项目时从下拉列表中选择相应的区域。 -对于已配置数据驻留的项目的请求,请按照下表定义的域名前缀添加到每个请求中。 +对于已配置数据驻留的项目的请求,请按照下表定义的域前缀为每个请求添加该前缀。 #### Select a processing region per request -除了创建区域专属项目外,你也可以使用带有前缀的域名,对来自 Global 区域项目的 API 密钥的单个请求选择区域处理。 +除了创建区域专属项目外,你也可以对单个请求选择区域处理,方法是使用带有 API key 前缀域名的请求,且该 接口 key 来自一个地理区域为 Global 的项目。 -现有的资格和数据保留控制要求仍然适用。所选的端点和模型也必须支持区域处理,如下表所示。 +现有的资格要求与数据保留控制要求仍然适用。所选端点和模型也必须支持区域处理,如下表所示。 -下面的示例在 Global 项目中复用同一个客户端和同一个 API 密钥,分别用于 Global、US 和 EU 请求: +下面的示例复用了同一个客户端和来自 Global 项目的 API key,分别用于 Global、US 和 EU 请求: ```python from openai import OpenAI @@ -230,91 +230,91 @@ puts(response.output_text) ``` -### 哪些模型和功能支持数据驻留? +### 哪些模型和功能符合数据驻留资格? -以下模型和 API 服务目前可在下方指定区域使用数据驻留。 +以下模型和 API 服务目前可在下方指定区域享受数据驻留支持。 -使用 **按区域划分的支持情况** 比较各区域的能力,并扩展每个区域中可用的服务。使用 **API 端点、工具和模型支持** 获取完整的模型列表和详细的服务视图。区域存储支持并不意味着区域处理支持。 +使用 **各区域支持情况** 比较各区域的能力,并查看每个区域可用的服务。使用 **API 端点、工具和模型支持** 获取完整模型列表以及详细的服务视图。区域存储支持并不代表区域处理支持。 -#### 各地区支持情况 +#### 按地区提供支持 -下面给出完整的、未经过滤的区域支持表。每个服务的模型快照列于 **API 端点、工具和模型支持**。当区域处理仅支持部分快照时,该子集会包含在处理服务单元中。 +完整且未经过滤的区域支持表如下。每个服务的模型快照列在 **API 端点、工具和模型支持**。中。当区域处理仅支持部分快照时,该子集会包含在处理服务单元格中。 -| 区域 | 域名前缀 | 区域存储 | 区域处理 | 是否需要 MAM 或 ZDR | 支持的模式 | 存储服务 | 处理服务 | +| 地区 | 域名前缀 | 区域存储 | 区域处理 | 需要 MAM 或 ZDR | 支持的模式 | 存储服务 | 处理服务 | | -------------------------- | ------------------- | :--------------: | :-----------------: | :-----------------: | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| 美国 | `us.api.openai.com` | 是 | 是 | 否 | 文本、音频、语音、图像 | `/v1/audio/transcriptions, /v1/audio/translations, /v1/audio/speech`
`/v1/batches`
`/v1/chat/completions`
`/v1/embeddings`
`/v1/evals`
`/v1/files`
`/v1/fine_tuning/jobs`
`/v1/images/edits`
`/v1/images/generations`
`/v1/moderations`
`/v1/realtime`
`/v1/realtime/transcription_sessions`
`/v1/realtime/translations`
`/v1/responses`
`/v1/responses File Search`
`/v1/responses Web Search`
`/v1/vector_stores`
`Code Interpreter tool`
`File Search`
`File Uploads`
`Remote MCP server tool`
`Scale Tier`
`Structured Outputs (excluding schema)`
`Supported input modalities` | `/v1/audio/transcriptions, /v1/audio/translations, /v1/audio/speech`
`/v1/batches`
`/v1/chat/completions`
`/v1/embeddings`
`/v1/evals`
`/v1/fine_tuning/jobs`
`/v1/images/edits`
`/v1/images/generations`
`/v1/moderations`
`/v1/realtime`
`/v1/realtime/transcription_sessions`
`/v1/realtime/translations`
`/v1/responses`
`/v1/responses File Search`
`/v1/responses Web Search`
`Code Interpreter tool`
`File Search`
`Remote MCP server tool`
`Scale Tier`
`Structured Outputs (excluding schema)`
`Supported input modalities` | -| 欧洲(欧洲经济区 + 瑞士) | `eu.api.openai.com` | 是 | 是 | 是\*\* | 文本、音频、语音、图像\* | `/v1/audio/transcriptions, /v1/audio/translations, /v1/audio/speech`
`/v1/batches`
`/v1/chat/completions`
`/v1/embeddings`
`/v1/evals`
`/v1/files`
`/v1/fine_tuning/jobs`
`/v1/images/edits`
`/v1/images/generations`
`/v1/moderations`
`/v1/realtime`
`/v1/realtime/transcription_sessions`
`/v1/realtime/translations`
`/v1/responses`
`/v1/responses File Search`
`/v1/responses Web Search`
`/v1/vector_stores`
`Code Interpreter tool`
`File Search`
`File Uploads`
`Remote MCP server tool`
`Scale Tier`
`Structured Outputs (excluding schema)`
`Supported input modalities` | `/v1/audio/transcriptions, /v1/audio/translations, /v1/audio/speech`
`/v1/batches`
`/v1/chat/completions`
`/v1/embeddings`
`/v1/evals`
`/v1/fine_tuning/jobs`
`/v1/images/edits`
`/v1/images/generations`
`/v1/moderations`
`/v1/realtime`
`/v1/realtime/transcription_sessions`
`/v1/realtime/translations`
`/v1/responses`
`/v1/responses File Search`
`/v1/responses Web Search`
`Code Interpreter tool`
`File Search`
`Remote MCP server tool`
`Scale Tier`
`Structured Outputs (excluding schema)`
`Supported input modalities` | -| 澳大利亚\* | `au.api.openai.com` | 是 | 否 | 是 | 文本、音频、语音、图像 | `/v1/audio/transcriptions, /v1/audio/translations, /v1/audio/speech`
`/v1/batches`
`/v1/chat/completions`
`/v1/embeddings`
`/v1/files`
`/v1/fine_tuning/jobs`
`/v1/images/edits`
`/v1/images/generations`
`/v1/moderations`
`/v1/responses`
`/v1/responses File Search`
`/v1/responses Web Search`
`/v1/vector_stores`
`Code Interpreter tool`
`File Search`
`File Uploads`
`Remote MCP server tool`
`Scale Tier`
`Structured Outputs (excluding schema)`
`Supported input modalities` | 无 | -| 加拿大\* | `ca.api.openai.com` | 是 | 否 | 是 | 文本、音频、语音、图像 | `/v1/audio/transcriptions, /v1/audio/translations, /v1/audio/speech`
`/v1/batches`
`/v1/chat/completions`
`/v1/embeddings`
`/v1/files`
`/v1/fine_tuning/jobs`
`/v1/images/edits`
`/v1/images/generations`
`/v1/moderations`
`/v1/responses`
`/v1/responses File Search`
`/v1/responses Web Search`
`/v1/vector_stores`
`Code Interpreter tool`
`File Search`
`File Uploads`
`Remote MCP server tool`
`Scale Tier`
`Structured Outputs (excluding schema)`
`Supported input modalities` | 无 | -| 日本\* | `jp.api.openai.com` | 是 | 否 | 是 | 文本、音频、语音、图像 | `/v1/audio/transcriptions, /v1/audio/translations, /v1/audio/speech`
`/v1/batches`
`/v1/chat/completions`
`/v1/embeddings`
`/v1/files`
`/v1/fine_tuning/jobs`
`/v1/images/edits`
`/v1/images/generations`
`/v1/moderations`
`/v1/responses`
`/v1/responses File Search`
`/v1/responses Web Search`
`/v1/vector_stores`
`Code Interpreter tool`
`File Search`
`File Uploads`
`Remote MCP server tool`
`Scale Tier`
`Structured Outputs (excluding schema)`
`Supported input modalities` | 无 | -| 印度\* | `in.api.openai.com` | 是 | 否 | 是 | 文本、音频、语音、图像 | `/v1/audio/transcriptions, /v1/audio/translations, /v1/audio/speech`
`/v1/batches`
`/v1/chat/completions`
`/v1/embeddings`
`/v1/files`
`/v1/fine_tuning/jobs`
`/v1/images/edits`
`/v1/images/generations`
`/v1/moderations`
`/v1/responses`
`/v1/responses File Search`
`/v1/responses Web Search`
`/v1/vector_stores`
`Code Interpreter tool`
`File Search`
`File Uploads`
`Remote MCP server tool`
`Scale Tier`
`Structured Outputs (excluding schema)`
`Supported input modalities` | 无 | -| 新加坡\* | `sg.api.openai.com` | 是 | 否 | 是 | 文本、音频、语音、图像 | `/v1/audio/transcriptions, /v1/audio/translations, /v1/audio/speech`
`/v1/batches`
`/v1/chat/completions`
`/v1/embeddings`
`/v1/files`
`/v1/fine_tuning/jobs`
`/v1/images/edits`
`/v1/images/generations`
`/v1/moderations`
`/v1/responses`
`/v1/responses File Search`
`/v1/responses Web Search`
`/v1/vector_stores`
`Code Interpreter tool`
`File Search`
`File Uploads`
`Remote MCP server tool`
`Scale Tier`
`Structured Outputs (excluding schema)`
`Supported input modalities` | 无 | -| 韩国\* | `kr.api.openai.com` | 是 | 否 | 是 | 文本、音频、语音、图像 | `/v1/audio/transcriptions, /v1/audio/translations, /v1/audio/speech`
`/v1/batches`
`/v1/chat/completions`
`/v1/embeddings`
`/v1/files`
`/v1/fine_tuning/jobs`
`/v1/images/edits`
`/v1/images/generations`
`/v1/moderations`
`/v1/responses`
`/v1/responses File Search`
`/v1/responses Web Search`
`/v1/vector_stores`
`Code Interpreter tool`
`File Search`
`File Uploads`
`Remote MCP server tool`
`Scale Tier`
`Structured Outputs (excluding schema)`
`Supported input modalities` | 无 | -| 英国\* | `gb.api.openai.com` | 是 | 否 | 是 | 文本、音频、语音、图像 | `/v1/audio/transcriptions, /v1/audio/translations, /v1/audio/speech`
`/v1/batches`
`/v1/chat/completions`
`/v1/embeddings`
`/v1/files`
`/v1/fine_tuning/jobs`
`/v1/images/edits`
`/v1/images/generations`
`/v1/moderations`
`/v1/responses`
`/v1/responses File Search`
`/v1/responses Web Search`
`/v1/vector_stores`
`Code Interpreter tool`
`File Search`
`File Uploads`
`Remote MCP server tool`
`Scale Tier`
`Structured Outputs (excluding schema)`
`Supported input modalities` | 无 | -| 阿联酋\* | `ae.api.openai.com` | 是 | 是 | 是 | 文本、音频、语音、图像 | `/v1/audio/transcriptions, /v1/audio/translations, /v1/audio/speech`
`/v1/batches`
`/v1/chat/completions`
`/v1/embeddings`
`/v1/files`
`/v1/fine_tuning/jobs`
`/v1/images/edits`
`/v1/images/generations`
`/v1/moderations`
`/v1/responses`
`/v1/responses File Search`
`/v1/responses Web Search`
`/v1/vector_stores`
`Code Interpreter tool`
`File Search`
`File Uploads`
`Remote MCP server tool`
`Scale Tier`
`Structured Outputs (excluding schema)`
`Supported input modalities` | `/v1/chat/completions` (`gpt-5.6-luna`, `gpt-5.5-2026-04-23`, `gpt-5.2-2025-12-11`)
`/v1/embeddings` (`text-embedding-3-large`)
`/v1/responses` (`gpt-5.5-pro-2026-04-23`, `gpt-5.6-luna`, `gpt-5.5-2026-04-23`, `gpt-5.2-2025-12-11`) | +| 美国 | `us.api.openai.com` | Yes | Yes | No | 文本、音频、语音、图像 | `/v1/audio/transcriptions, /v1/audio/translations, /v1/audio/speech`
`/v1/batches`
`/v1/chat/completions`
`/v1/embeddings`
`/v1/evals`
`/v1/files`
`/v1/fine_tuning/jobs`
`/v1/images/edits`
`/v1/images/generations`
`/v1/moderations`
`/v1/realtime`
`/v1/realtime/transcription_sessions`
`/v1/realtime/translations`
`/v1/responses`
`/v1/responses File Search`
`/v1/responses Web Search`
`/v1/vector_stores`
`Code Interpreter tool`
`File Search`
`File Uploads`
`Remote MCP server tool`
`Scale Tier`
`Structured Outputs (excluding schema)`
`Supported input modalities` | `/v1/audio/transcriptions, /v1/audio/translations, /v1/audio/speech`
`/v1/batches`
`/v1/chat/completions`
`/v1/embeddings`
`/v1/evals`
`/v1/fine_tuning/jobs`
`/v1/images/edits`
`/v1/images/generations`
`/v1/moderations`
`/v1/realtime`
`/v1/realtime/transcription_sessions`
`/v1/realtime/translations`
`/v1/responses`
`/v1/responses File Search`
`/v1/responses Web Search`
`Code Interpreter tool`
`File Search`
`Remote MCP server tool`
`Scale Tier`
`Structured Outputs (excluding schema)`
`Supported input modalities` | +| 欧洲(EEA + 瑞士) | `eu.api.openai.com` | Yes | Yes | Yes\*\* | 文本、音频、语音、图像\* | `/v1/audio/transcriptions, /v1/audio/translations, /v1/audio/speech`
`/v1/batches`
`/v1/chat/completions`
`/v1/embeddings`
`/v1/evals`
`/v1/files`
`/v1/fine_tuning/jobs`
`/v1/images/edits`
`/v1/images/generations`
`/v1/moderations`
`/v1/realtime`
`/v1/realtime/transcription_sessions`
`/v1/realtime/translations`
`/v1/responses`
`/v1/responses File Search`
`/v1/responses Web Search`
`/v1/vector_stores`
`Code Interpreter tool`
`File Search`
`File Uploads`
`Remote MCP server tool`
`Scale Tier`
`Structured Outputs (excluding schema)`
`Supported input modalities` | `/v1/audio/transcriptions, /v1/audio/translations, /v1/audio/speech`
`/v1/batches`
`/v1/chat/completions`
`/v1/embeddings`
`/v1/evals`
`/v1/fine_tuning/jobs`
`/v1/images/edits`
`/v1/images/generations`
`/v1/moderations`
`/v1/realtime`
`/v1/realtime/transcription_sessions`
`/v1/realtime/translations`
`/v1/responses`
`/v1/responses File Search`
`/v1/responses Web Search`
`Code Interpreter tool`
`File Search`
`Remote MCP server tool`
`Scale Tier`
`Structured Outputs (excluding schema)`
`Supported input modalities` | +| 澳大利亚\* | `au.api.openai.com` | Yes | No | Yes | 文本、音频、语音、图像 | `/v1/audio/transcriptions, /v1/audio/translations, /v1/audio/speech`
`/v1/batches`
`/v1/chat/completions`
`/v1/embeddings`
`/v1/files`
`/v1/fine_tuning/jobs`
`/v1/images/edits`
`/v1/images/generations`
`/v1/moderations`
`/v1/responses`
`/v1/responses File Search`
`/v1/responses Web Search`
`/v1/vector_stores`
`Code Interpreter tool`
`File Search`
`File Uploads`
`Remote MCP server tool`
`Scale Tier`
`Structured Outputs (excluding schema)`
`Supported input modalities` | None | +| 加拿大\* | `ca.api.openai.com` | Yes | No | Yes | 文本、音频、语音、图像 | `/v1/audio/transcriptions, /v1/audio/translations, /v1/audio/speech`
`/v1/batches`
`/v1/chat/completions`
`/v1/embeddings`
`/v1/files`
`/v1/fine_tuning/jobs`
`/v1/images/edits`
`/v1/images/generations`
`/v1/moderations`
`/v1/responses`
`/v1/responses File Search`
`/v1/responses Web Search`
`/v1/vector_stores`
`Code Interpreter tool`
`File Search`
`File Uploads`
`Remote MCP server tool`
`Scale Tier`
`Structured Outputs (excluding schema)`
`Supported input modalities` | None | +| 日本\* | `jp.api.openai.com` | Yes | No | Yes | 文本、音频、语音、图像 | `/v1/audio/transcriptions, /v1/audio/translations, /v1/audio/speech`
`/v1/batches`
`/v1/chat/completions`
`/v1/embeddings`
`/v1/files`
`/v1/fine_tuning/jobs`
`/v1/images/edits`
`/v1/images/generations`
`/v1/moderations`
`/v1/responses`
`/v1/responses File Search`
`/v1/responses Web Search`
`/v1/vector_stores`
`Code Interpreter tool`
`File Search`
`File Uploads`
`Remote MCP server tool`
`Scale Tier`
`Structured Outputs (excluding schema)`
`Supported input modalities` | None | +| 印度\* | `in.api.openai.com` | Yes | No | Yes | 文本、音频、语音、图像 | `/v1/audio/transcriptions, /v1/audio/translations, /v1/audio/speech`
`/v1/batches`
`/v1/chat/completions`
`/v1/embeddings`
`/v1/files`
`/v1/fine_tuning/jobs`
`/v1/images/edits`
`/v1/images/generations`
`/v1/moderations`
`/v1/responses`
`/v1/responses File Search`
`/v1/responses Web Search`
`/v1/vector_stores`
`Code Interpreter tool`
`File Search`
`File Uploads`
`Remote MCP server tool`
`Scale Tier`
`Structured Outputs (excluding schema)`
`Supported input modalities` | None | +| 新加坡\* | `sg.api.openai.com` | Yes | No | Yes | 文本、音频、语音、图像 | `/v1/audio/transcriptions, /v1/audio/translations, /v1/audio/speech`
`/v1/batches`
`/v1/chat/completions`
`/v1/embeddings`
`/v1/files`
`/v1/fine_tuning/jobs`
`/v1/images/edits`
`/v1/images/generations`
`/v1/moderations`
`/v1/responses`
`/v1/responses File Search`
`/v1/responses Web Search`
`/v1/vector_stores`
`Code Interpreter tool`
`File Search`
`File Uploads`
`Remote MCP server tool`
`Scale Tier`
`Structured Outputs (excluding schema)`
`Supported input modalities` | None | +| 韩国\* | `kr.api.openai.com` | Yes | No | Yes | 文本、音频、语音、图像 | `/v1/audio/transcriptions, /v1/audio/translations, /v1/audio/speech`
`/v1/batches`
`/v1/chat/completions`
`/v1/embeddings`
`/v1/files`
`/v1/fine_tuning/jobs`
`/v1/images/edits`
`/v1/images/generations`
`/v1/moderations`
`/v1/responses`
`/v1/responses File Search`
`/v1/responses Web Search`
`/v1/vector_stores`
`Code Interpreter tool`
`File Search`
`File Uploads`
`Remote MCP server tool`
`Scale Tier`
`Structured Outputs (excluding schema)`
`Supported input modalities` | None | +| 英国\* | `gb.api.openai.com` | Yes | No | Yes | 文本、音频、语音、图像 | `/v1/audio/transcriptions, /v1/audio/translations, /v1/audio/speech`
`/v1/batches`
`/v1/chat/completions`
`/v1/embeddings`
`/v1/files`
`/v1/fine_tuning/jobs`
`/v1/images/edits`
`/v1/images/generations`
`/v1/moderations`
`/v1/responses`
`/v1/responses File Search`
`/v1/responses Web Search`
`/v1/vector_stores`
`Code Interpreter tool`
`File Search`
`File Uploads`
`Remote MCP server tool`
`Scale Tier`
`Structured Outputs (excluding schema)`
`Supported input modalities` | None | +| 阿拉伯联合酋长国\* | `ae.api.openai.com` | Yes | Yes | Yes | 文本、音频、语音、图像 | `/v1/audio/transcriptions, /v1/audio/translations, /v1/audio/speech`
`/v1/batches`
`/v1/chat/completions`
`/v1/embeddings`
`/v1/files`
`/v1/fine_tuning/jobs`
`/v1/images/edits`
`/v1/images/generations`
`/v1/moderations`
`/v1/responses`
`/v1/responses File Search`
`/v1/responses Web Search`
`/v1/vector_stores`
`Code Interpreter tool`
`File Search`
`File Uploads`
`Remote MCP server tool`
`Scale Tier`
`Structured Outputs (excluding schema)`
`Supported input modalities` | `/v1/chat/completions` (`gpt-5.6-luna`, `gpt-5.5-2026-04-23`, `gpt-5.2-2025-12-11`)
`/v1/embeddings` (`text-embedding-3-large`)
`/v1/responses` (`gpt-5.5-pro-2026-04-23`, `gpt-5.6-luna`, `gpt-5.5-2026-04-23`, `gpt-5.2-2025-12-11`) | -\* 这些区域的图像支持需要获得增强型零数据留存或增强型修改后滥用监控的批准。 +\* 这些区域的图像支持需要获得增强型零数据保留或增强型修改后滥用监控的批准。 -\*\* 需要零数据留存、修改后滥用监控、Eyes Off 或安全留存。 +\*\* 需要零数据保留、修改后滥用监控、Eyes Off 或安全保留。 -#### API 端点、工具与模型支持 +#### API 端点、工具和模型支持 -| 端点或功能 | 服务 | 存储区域 | 处理区域 | 支持的模型与快照 | 区域处理快照例外情况 | 说明 | +| 端点或功能 | 服务 | 存储区域 | 处理区域 | 支持的模型和快照 | 区域处理快照例外 | 备注 | | -------------------------------------------------------------------- | ---------------- | ----------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `/v1/audio/transcriptions, /v1/audio/translations, /v1/audio/speech` | 音频 | 所有列出的区域 | 美国、欧洲(EEA + 瑞士) | `tts-1`, `whisper-1`, `gpt-4o-tts`, `gpt-4o-transcribe`, `gpt-4o-mini-transcribe` | 无 | — | -| `/v1/batches` | 批处理 | 所有列出的区域 | 美国、欧洲(EEA + 瑞士) | `gpt-5.5-pro-2026-04-23`, `gpt-5.4-pro-2026-03-05`, `gpt-5.2-pro-2025-12-11`, `gpt-5-pro-2025-10-06`, `gpt-5.6-sol`, `gpt-5.6-terra`, `gpt-5.6-luna`, `gpt-5.5-2026-04-23`, `gpt-5.4-2026-03-05`, `gpt-5-2025-08-07`, `gpt-5.4-mini-2026-03-17`, `gpt-5.4-nano-2026-03-17`, `gpt-5.2-2025-12-11`, `gpt-5.1-2025-11-13`, `gpt-5-mini-2025-08-07`, `gpt-5-nano-2025-08-07`, `gpt-4.1-2025-04-14`, `gpt-4.1-mini-2025-04-14`, `gpt-4.1-nano-2025-04-14`, `o3-2025-04-16`, `o4-mini-2025-04-16`, `o1-pro`, `o1-pro-2025-03-19`, `o3-mini-2025-01-31`, `o1-2024-12-17`, `gpt-4o-2024-11-20`, `gpt-4o-2024-08-06`, `gpt-4o-mini-2024-07-18`, `gpt-4-turbo-2024-04-09`, `gpt-4-0613`, `gpt-3.5-turbo-0125` | 无 | — | -| `/v1/chat/completions` | Chat Completions | 所有列出的区域 | 美国、欧洲(EEA + 瑞士)、阿拉伯联合酋长国 | `gpt-5.6-sol`, `gpt-5.6-terra`, `gpt-5.6-luna`, `gpt-5.5-2026-04-23`, `gpt-5.4-2026-03-05`, `gpt-5.4-mini-2026-03-17`, `gpt-5.4-nano-2026-03-17`, `gpt-5.2-2025-12-11`, `gpt-5.1-2025-11-13`, `gpt-5-2025-08-07`, `gpt-5-mini-2025-08-07`, `gpt-5-nano-2025-08-07`, `gpt-4.1-2025-04-14`, `gpt-4.1-mini-2025-04-14`, `gpt-4.1-nano-2025-04-14`, `o3-mini-2025-01-31`, `o3-2025-04-16`, `o4-mini-2025-04-16`, `o1-2024-12-17`, `gpt-4o-2024-11-20`, `gpt-4o-2024-08-06`, `gpt-4o-mini-2024-07-18`, `gpt-4-turbo-2024-04-09`, `gpt-4-0613`, `gpt-3.5-turbo-0125` | 阿拉伯联合酋长国: `gpt-5.6-luna`, `gpt-5.5-2026-04-23`, `gpt-5.2-2025-12-11` | — | -| `/v1/embeddings` | Embeddings | 所有列出的区域 | 美国、欧洲(EEA + 瑞士)、阿拉伯联合酋长国 | `text-embedding-3-small`, `text-embedding-3-large`, `text-embedding-ada-002` | 阿拉伯联合酋长国: `text-embedding-3-large` | — | -| `/v1/evals` | Evals | 美国、欧洲(EEA + 瑞士) | 美国、欧洲(EEA + 瑞士) | 服务级别支持 | 无 | — | -| `/v1/files` | Files | 所有列出的区域 | 无 | 服务级别支持 | 无 | — | -| `/v1/fine_tuning/jobs` | Fine-tuning | 所有列出的区域 | 美国、欧洲(EEA + 瑞士) | `gpt-4o-2024-08-06`, `gpt-4o-mini-2024-07-18`, `gpt-4.1-2025-04-14`, `gpt-4.1-mini-2025-04-14` | 无 | — | -| `/v1/images/edits` | Images | 所有列出的区域 | 美国、欧洲(EEA + 瑞士) | `gpt-image-2`, `gpt-image-1`, `gpt-image-1.5`, `gpt-image-1-mini` | 无 | — | -| `/v1/images/generations` | Images | 所有列出的区域 | 美国、欧洲(EEA + 瑞士) | `gpt-image-2`, `gpt-image-1`, `gpt-image-1.5`, `gpt-image-1-mini` | 无 | — | -| `/v1/moderations` | 审核 | 所有列出的区域 | 美国、欧洲(EEA + 瑞士) | `omni-moderation-latest` | 无 | — | -| `/v1/realtime` | 实时 | 美国、欧洲(EEA + 瑞士) | 美国、欧洲(EEA + 瑞士) | `gpt-realtime`, `gpt-realtime-1.5`, `gpt-realtime-mini`, `gpt-realtime-2`, `gpt-realtime-2.1`, `gpt-realtime-2.1-mini` | 无 | — | -| `/v1/realtime/transcription_sessions` | 实时 | 美国、欧洲(EEA + 瑞士) | 美国、欧洲(EEA + 瑞士) | `gpt-realtime-whisper` | 无 | — | -| `/v1/realtime/translations` | 实时 | 美国、欧洲(EEA + 瑞士) | 美国、欧洲(EEA + 瑞士) | `gpt-realtime-translate` | 无 | — | -| `/v1/responses` | Responses | 所有列出的区域 | 美国、欧洲(EEA + 瑞士)、阿拉伯联合酋长国 | `gpt-5.5-pro-2026-04-23`, `gpt-5.4-pro-2026-03-05`, `gpt-5.2-pro-2025-12-11`, `gpt-5-pro-2025-10-06`, `gpt-5.6-sol`, `gpt-5.6-terra`, `gpt-5.6-luna`, `gpt-5.5-2026-04-23`, `gpt-5.4-2026-03-05`, `gpt-5-2025-08-07`, `gpt-5.4-mini-2026-03-17`, `gpt-5.4-nano-2026-03-17`, `gpt-5.2-2025-12-11`, `gpt-5.1-2025-11-13`, `gpt-5-mini-2025-08-07`, `gpt-5-nano-2025-08-07`, `gpt-4.1-2025-04-14`, `gpt-4.1-mini-2025-04-14`, `gpt-4.1-nano-2025-04-14`, `o3-2025-04-16`, `o4-mini-2025-04-16`, `o1-pro`, `o1-pro-2025-03-19`, `o3-mini-2025-01-31`, `o1-2024-12-17`, `gpt-4o-2024-11-20`, `gpt-4o-2024-08-06`, `gpt-4o-mini-2024-07-18`, `gpt-4-turbo-2024-04-09`, `gpt-4-0613`, `gpt-3.5-turbo-0125` | 阿拉伯联合酋长国: `gpt-5.5-pro-2026-04-23`, `gpt-5.6-luna`, `gpt-5.5-2026-04-23`, `gpt-5.2-2025-12-11` | — | -| `/v1/responses File Search` | Responses | 所有列出的区域 | 美国、欧洲(EEA + 瑞士) | 服务级别支持 | 无 | — | -| `/v1/responses Web Search` | Responses | 所有列出的区域 | 美国、欧洲(EEA + 瑞士) | 服务级别支持 | 无 | — | -| `/v1/vector_stores` | 向量存储 | 所有列出的区域 | 无 | 服务级别支持 | 无 | — | -| `Code Interpreter tool` | 工具 | 所有列出的区域 | 美国、欧洲(EEA + 瑞士) | 服务级别支持 | 无 | — | -| `File Search` | 工具 | 所有列出的区域 | 美国、欧洲(EEA + 瑞士) | 服务级别支持 | 无 | — | -| `File Uploads` | Files | 所有列出的区域 | 无 | 服务级别支持 | 无 | 在使用 base64 文件上传时受支持。 | -| `Remote MCP server tool` | 工具 | 所有列出的区域 | 美国、欧洲(EEA + 瑞士) | 服务级别支持 | 无 | MCP 服务器是第三方服务。发送到 MCP 服务器的数据受其数据驻留策略约束。 | -| `Scale Tier` | 其他 | 所有列出的区域 | 美国、欧洲(EEA + 瑞士) | 服务级别支持 | 无 | — | -| `Structured Outputs (excluding schema)` | 其他 | 所有列出的区域 | 美国、欧洲(EEA + 瑞士) | 服务级别支持 | 无 | — | -| `Supported input modalities` | 其他 | 所有列出的区域 | 美国、欧洲(EEA + 瑞士) | `Text`, `Image`, `Audio/Voice` | 无 | — | - - - -### 端点限制 +| `/v1/audio/transcriptions, /v1/audio/translations, /v1/audio/speech` | 音频 | 所有列出的区域 | 美国、欧洲(EEA + 瑞士) | `tts-1`, `whisper-1`, `gpt-4o-tts`, `gpt-4o-transcribe`, `gpt-4o-mini-transcribe`, `gpt-transcribe` | None | — | +| `/v1/batches` | 批处理 | 所有列出的区域 | 美国、欧洲(EEA + 瑞士) | `gpt-5.5-pro-2026-04-23`, `gpt-5.4-pro-2026-03-05`, `gpt-5.2-pro-2025-12-11`, `gpt-5-pro-2025-10-06`, `gpt-5.6-sol`, `gpt-5.6-terra`, `gpt-5.6-luna`, `gpt-5.5-2026-04-23`, `gpt-5.4-2026-03-05`, `gpt-5-2025-08-07`, `gpt-5.4-mini-2026-03-17`, `gpt-5.4-nano-2026-03-17`, `gpt-5.2-2025-12-11`, `gpt-5.1-2025-11-13`, `gpt-5-mini-2025-08-07`, `gpt-5-nano-2025-08-07`, `gpt-4.1-2025-04-14`, `gpt-4.1-mini-2025-04-14`, `gpt-4.1-nano-2025-04-14`, `o3-2025-04-16`, `o4-mini-2025-04-16`, `o1-pro`, `o1-pro-2025-03-19`, `o3-mini-2025-01-31`, `o1-2024-12-17`, `gpt-4o-2024-11-20`, `gpt-4o-2024-08-06`, `gpt-4o-mini-2024-07-18`, `gpt-4-turbo-2024-04-09`, `gpt-4-0613`, `gpt-3.5-turbo-0125` | None | — | +| `/v1/chat/completions` | Chat Completions | 所有列出的区域 | 美国、欧洲(EEA + 瑞士)、阿联酋 | `gpt-5.6-sol`, `gpt-5.6-terra`, `gpt-5.6-luna`, `gpt-5.5-2026-04-23`, `gpt-5.4-2026-03-05`, `gpt-5.4-mini-2026-03-17`, `gpt-5.4-nano-2026-03-17`, `gpt-5.2-2025-12-11`, `gpt-5.1-2025-11-13`, `gpt-5-2025-08-07`, `gpt-5-mini-2025-08-07`, `gpt-5-nano-2025-08-07`, `gpt-4.1-2025-04-14`, `gpt-4.1-mini-2025-04-14`, `gpt-4.1-nano-2025-04-14`, `o3-mini-2025-01-31`, `o3-2025-04-16`, `o4-mini-2025-04-16`, `o1-2024-12-17`, `gpt-4o-2024-11-20`, `gpt-4o-2024-08-06`, `gpt-4o-mini-2024-07-18`, `gpt-4-turbo-2024-04-09`, `gpt-4-0613`, `gpt-3.5-turbo-0125` | 阿联酋: `gpt-5.6-luna`, `gpt-5.5-2026-04-23`, `gpt-5.2-2025-12-11` | — | +| `/v1/embeddings` | Embeddings | 所有列出的区域 | 美国、欧洲(EEA + 瑞士)、阿联酋 | `text-embedding-3-small`, `text-embedding-3-large`, `text-embedding-ada-002` | 阿联酋: `text-embedding-3-large` | — | +| `/v1/evals` | Evals | 美国、欧洲(EEA + 瑞士) | 美国、欧洲(EEA + 瑞士) | 服务级别支持 | None | — | +| `/v1/files` | Files | 所有列出的区域 | None | 服务级别支持 | None | — | +| `/v1/fine_tuning/jobs` | 微调 | 所有列出的区域 | 美国、欧洲(EEA + 瑞士) | `gpt-4o-2024-08-06`, `gpt-4o-mini-2024-07-18`, `gpt-4.1-2025-04-14`, `gpt-4.1-mini-2025-04-14` | None | — | +| `/v1/images/edits` | 图像 | 所有列出的区域 | 美国、欧洲(EEA + 瑞士) | `gpt-image-2`, `gpt-image-1`, `gpt-image-1.5`, `gpt-image-1-mini` | None | — | +| `/v1/images/generations` | 图像 | 所有列出的区域 | 美国、欧洲(EEA + 瑞士) | `gpt-image-2`, `gpt-image-1`, `gpt-image-1.5`, `gpt-image-1-mini` | None | — | +| `/v1/moderations` | Moderation | 所有列出的区域 | 美国、欧洲(EEA + 瑞士) | `omni-moderation-latest` | None | — | +| `/v1/realtime` | Realtime | 美国、欧洲(EEA + 瑞士) | 美国、欧洲(EEA + 瑞士) | `gpt-realtime`, `gpt-realtime-1.5`, `gpt-realtime-mini`, `gpt-realtime-2`, `gpt-realtime-2.1`, `gpt-realtime-2.1-mini` | None | — | +| `/v1/realtime/transcription_sessions` | Realtime | 美国、欧洲(EEA + 瑞士) | 美国、欧洲(EEA + 瑞士) | `gpt-realtime-whisper`, `gpt-live-transcribe`, `gpt-transcribe` | None | — | +| `/v1/realtime/translations` | Realtime | 美国、欧洲(EEA + 瑞士) | 美国、欧洲(EEA + 瑞士) | `gpt-realtime-translate` | None | — | +| `/v1/responses` | Responses | 所有列出的区域 | 美国、欧洲(EEA + 瑞士)、阿联酋 | `gpt-5.5-pro-2026-04-23`, `gpt-5.4-pro-2026-03-05`, `gpt-5.2-pro-2025-12-11`, `gpt-5-pro-2025-10-06`, `gpt-5.6-sol`, `gpt-5.6-terra`, `gpt-5.6-luna`, `gpt-5.5-2026-04-23`, `gpt-5.4-2026-03-05`, `gpt-5-2025-08-07`, `gpt-5.4-mini-2026-03-17`, `gpt-5.4-nano-2026-03-17`, `gpt-5.2-2025-12-11`, `gpt-5.1-2025-11-13`, `gpt-5-mini-2025-08-07`, `gpt-5-nano-2025-08-07`, `gpt-4.1-2025-04-14`, `gpt-4.1-mini-2025-04-14`, `gpt-4.1-nano-2025-04-14`, `o3-2025-04-16`, `o4-mini-2025-04-16`, `o1-pro`, `o1-pro-2025-03-19`, `o3-mini-2025-01-31`, `o1-2024-12-17`, `gpt-4o-2024-11-20`, `gpt-4o-2024-08-06`, `gpt-4o-mini-2024-07-18`, `gpt-4-turbo-2024-04-09`, `gpt-4-0613`, `gpt-3.5-turbo-0125` | 阿联酋: `gpt-5.5-pro-2026-04-23`, `gpt-5.6-luna`, `gpt-5.5-2026-04-23`, `gpt-5.2-2025-12-11` | — | +| `/v1/responses File Search` | Responses | 所有列出的区域 | 美国、欧洲(EEA + 瑞士) | 服务级别支持 | None | — | +| `/v1/responses Web Search` | Responses | 所有列出的区域 | 美国、欧洲(EEA + 瑞士) | 服务级别支持 | None | — | +| `/v1/vector_stores` | Vector stores | 所有列出的区域 | None | 服务级别支持 | None | — | +| `Code Interpreter tool` | Tools | 所有列出的区域 | 美国、欧洲(EEA + 瑞士) | 服务级别支持 | None | — | +| `File Search` | Tools | 所有列出的区域 | 美国、欧洲(EEA + 瑞士) | 服务级别支持 | None | — | +| `File Uploads` | Files | 所有列出的区域 | None | 服务级别支持 | None | 在使用 base64 文件上传时受支持。 | +| `Remote MCP server tool` | Tools | 所有列出的区域 | 美国、欧洲(EEA + 瑞士) | 服务级别支持 | None | MCP 服务器是第三方服务。发送到 MCP 服务器的数据须遵守其数据驻留策略。 | +| `Scale Tier` | 其他 | 所有列出的区域 | 美国、欧洲(EEA + 瑞士) | 服务级别支持 | None | — | +| `Structured Outputs (excluding schema)` | 其他 | 所有列出的区域 | 美国、欧洲(EEA + 瑞士) | 服务级别支持 | None | — | +| `Supported input modalities` | 其他 | 所有列出的区域 | 美国、欧洲(EEA + 瑞士) | `Text`, `Image`, `Audio/Voice` | None | — | + + + +### Endpoint limitations #### /v1/chat/completions -- 在非美国区域无法设置 store=true。 -- [扩展提示缓存](https://developers.openai.com/api/docs/guides/prompt-caching#prompt-cache-retention) 在不支持区域处理的区域中,可能需要 OpenAI 在区域外处理并临时存储客户内容,以提供相应服务。 +- 在非美国地区无法设置 store=true。 +- [扩展提示词缓存](https://developers.openai.com/api/docs/guides/prompt-caching#prompt-cache-retention) 在不支持区域处理的区域中,可能要求 OpenAI 在区域外处理并临时存储客户内容,以提供服务。 #### /v1/responses - 无法在 EU 区域设置 background=True。 -- [扩展提示缓存](https://developers.openai.com/api/docs/guides/prompt-caching#prompt-cache-retention) 在不支持区域处理的区域中,可能需要 OpenAI 在区域外处理并临时存储客户内容,以提供相应服务。 +- [扩展提示词缓存](https://developers.openai.com/api/docs/guides/prompt-caching#prompt-cache-retention) 在不支持区域处理的区域中,可能要求 OpenAI 在区域外处理并临时存储客户内容,以提供服务。 #### /v1/realtime -追踪目前不符合欧盟数据驻留要求,适用于 `/v1/realtime`. +追踪目前在以下方面尚不符合欧盟数据驻留要求 `/v1/realtime`. ## Enterprise Key Management (EKM) -Enterprise Key Management(EKM)允许你使用由你自己的外部密钥管理系统(KMS)管理的密钥对OpenAI 中的客户内容进行加密。 +Enterprise Key Management(EKM)允许你使用由你自己的外部密钥管理系统(KMS)管理的密钥来加密你在 OpenAI 的客户内容。 -配置完成后,EKM 将应用于任何 [application state](#types-of-data-stored-with-the-openai-api) 。参见 [EKM 帮助中心文章](https://help.openai.com/en/articles/20000943-openai-enterprise-key-management-ekm-overview) 了解有关 EKM 工作原理以及如何与你的 KMS 提供商集成的更多信息。 +配置完成后,EKM 会应用于你在使用该平台期间创建的任何 [application state](#types-of-data-stored-with-the-openai-api) 。更多信息请参阅 [EKM 帮助中心文章](https://help.openai.com/en/articles/20000943-openai-enterprise-key-management-ekm-overview) ,了解 EKM 的工作原理以及如何与你的 KMS 提供商进行集成。 ### EKM 限制 -OpenAI 支持在 AWS KMS、Google Cloud (GCP) 和 Azure Key Vault 中使用外部账户自带密钥(BYOK)加密。如果你的组织使用其他密钥管理服务,则需要将这些密钥同步到受支持的云 KMS 提供商之一,才能与 OpenAI 一起使用。 +OpenAI 支持在 AWS KMS、Google Cloud (GCP) 和 Azure Key Vault 中通过外部账户使用自带密钥 (BYOK) 加密。如果你的组织使用其他密钥管理服务,则需要将这些密钥同步到支持的云 KMS 提供商之一,以便与 OpenAI 一起使用。 -EKM 不支持以下产品。在启用了 EKM 的项目中尝试使用这些端点将返回错误。 +EKM 不支持以下产品。在已启用 EKM 的项目中尝试使用这些接口将返回错误。 - Assistants (/v1/assistants) -- 视觉微调 \ No newline at end of file +- 视觉模型微调 \ No newline at end of file diff --git a/docs/zh/api/docs/libraries.md b/docs/zh/api/docs/libraries.md index c668978..8ca4512 100644 --- a/docs/zh/api/docs/libraries.md +++ b/docs/zh/api/docs/libraries.md @@ -1,12 +1,12 @@ # SDK 和 CLI -> 完整文档索引请参阅 [llms.txt](/llms.txt)。在页面 URL 后追加 `.md` 即可获取对应文档页面的 Markdown 版本。 +> 完整的文档索引请参阅 [llms.txt](/llms.txt)。通过在页面 URL 后追加 `.md` 即可获取该页面的 Markdown 版本。 -本页介绍构建应用的几种主要方式: [OpenAI API](https://developers.openai.com/api/reference/overview):用于应用代码的官方 SDK、用于 shell 原生工作流的 OpenAI CLI、用于编排的 Agents SDK,或你惯用的任意 HTTP 客户端。 +本页面介绍使用 [OpenAI API](https://developers.openai.com/api/reference/overview):进行开发的主要方式:用于应用程序代码的官方 SDK、用于 shell 原生工作流的 OpenAI CLI、用于编排的 Agents SDK,或你偏好的任意 HTTP 客户端。 ## 创建并导出 API 密钥 -开始之前, [在控制台中创建一个 API 密钥](https://platform.openai.com/api-keys),你可以用它来 [访问 API](https://developers.openai.com/api/reference/overview)。将该密钥保存在安全的位置,例如计算机上的一个 [`.zshrc` 文件](https://www.freecodecamp.org/news/how-do-zsh-configuration-files-work/) 或其他文本文件。生成 API 密钥后,将其导出为终端中的 [环境变量](https://en.wikipedia.org/wiki/Environment_variable) 。 +开始之前, [在仪表板中创建一个 API 密钥](https://platform.openai.com/api-keys),你将用它来安全地 [访问 API](https://developers.openai.com/api/reference/overview)。请将此密钥保存在安全的位置,例如计算机上的一个 [`.zshrc` 文件](https://www.freecodecamp.org/news/how-do-zsh-configuration-files-work/) 或其他文本文件。生成 API 密钥后,请在终端中将其导出为 [环境变量](https://en.wikipedia.org/wiki/Environment_variable) 。 @@ -33,7 +33,7 @@ setx OPENAI_API_KEY "your_api_key_here" -OpenAI SDK 默认配置为自动从系统环境中读取你的 API 密钥。 +OpenAI SDK 被配置为自动从系统环境中读取你的 API 密钥。 ## 安装官方 SDK @@ -43,7 +43,7 @@ JavaScript -要在 Node.js、Deno 或 Bun 等 服务端 JavaScript 环境中使用 OpenAI API,你可以使用官方的 [OpenAI SDK for TypeScript and JavaScript](https://github.com/openai/openai-node)。首先使用 [npm](https://www.npmjs.com/) 或你常用的包管理器安装 SDK: +要在 Node.js、Deno 或 Bun 等 服务端 JavaScript 环境中使用 OpenAI API,你可以使用官方的 [OpenAI SDK for TypeScript and JavaScript](https://github.com/openai/openai-node)。先使用 [npm](https://www.npmjs.com/) 或你常用的包管理器安装 SDK: 使用 npm 安装 OpenAI SDK @@ -52,9 +52,9 @@ npm install openai ``` -安装好 OpenAI SDK 后,创建一个文件, `example.mjs` 并将示例代码复制到其中: +安装好 OpenAI SDK 后,创建一个文件 `example.mjs` 并将示例代码复制进去: -测试基本的 API 请求 +测试一个基础的 API 请求 ```javascript import OpenAI from "openai"; @@ -69,7 +69,7 @@ console.log(response.output_text); ``` -使用 `node example.mjs` (或 Deno、Bun 中对应的命令)执行代码。稍等片刻,你应该会看到 API 请求的输出。 +使用 `node example.mjs` (或 Deno、Bun 中等效的命令)执行代码。稍等片刻,你应当能看到 API 请求的输出。 [在 GitHub 上了解更多信息 @@ -87,7 +87,7 @@ Python -要在 Python 中使用 OpenAI API,你可以使用官方的 [OpenAI SDK for Python](https://github.com/openai/openai-python)。首先使用 [pip](https://pypi.org/project/pip/): +要在 Python 中使用 OpenAI API,你可以使用官方的 [OpenAI SDK for Python](https://github.com/openai/openai-python)。先使用 [pip](https://pypi.org/project/pip/): 使用 pip 安装 OpenAI SDK @@ -96,9 +96,9 @@ pip install openai ``` -安装好 OpenAI SDK 后,创建一个文件, `example.py` 并将示例代码复制到其中: +安装好 OpenAI SDK 后,创建一个文件 `example.py` 并将示例代码复制进去: -测试基本的 API 请求 +测试一个基础的 API 请求 ```python from openai import OpenAI @@ -114,7 +114,7 @@ print(response.output_text) ``` -使用 `python example.py`。稍等片刻,你应该会看到 API 请求的输出。 +使用 `python example.py`。稍等片刻,你应当能看到 API 请求的输出。 [在 GitHub 上了解更多信息 @@ -132,15 +132,15 @@ print(response.output_text) -该公司 与微软合作,提供了一个官方支持的 C# OpenAI API 客户端。你可以使用以下命令通过 .NET CLI 安装它: [NuGet](https://www.nuget.org/). +OpenAI 与 Microsoft 合作,提供一个官方支持的 C# API 客户端。你可以使用 .NET CLI 从 [NuGet](https://www.nuget.org/). ``` dotnet add package OpenAI ``` -向API 发起的简单请求示例如下: [Responses API](https://developers.openai.com/api/reference/resources/responses) 代码如下: +一个向 API 发出的简单请求,使用 [Responses API](https://developers.openai.com/api/reference/resources/responses) 示例如下: -测试基本的 API 请求 +测试一个基础的 API 请求 ```csharp using OpenAI.Responses; @@ -167,20 +167,20 @@ Java -OpenAI 为 Java 编程语言提供了一个 API 帮助库,目前处于 beta 阶段。你可以使用以下配置加入 Maven 依赖: +OpenAI 为 Java 语言提供了一个 API 帮助库,目前处于 beta 阶段。你可以使用以下配置加入 Maven 依赖: ```xml com.openai openai-java - 4.54.0 + 4.55.0 ``` -向API 发起的简单请求示例如下: [Responses API](https://developers.openai.com/api/reference/resources/responses) 代码如下: +一个向 API 发出的简单请求,使用 [Responses API](https://developers.openai.com/api/reference/resources/responses) 示例如下: -测试基本的 API 请求 +测试一个基础的 API 请求 ```java import com.openai.client.OpenAIClient; @@ -206,7 +206,7 @@ public class Main { ``` -要进一步了解如何在 Java 中使用 OpenAI API,请查看下方链接的 GitHub 仓库! +要了解更多在 Java 中使用 OpenAI API 的信息,请查看下方链接的 GitHub 仓库! [在 GitHub 上了解更多信息 @@ -224,7 +224,7 @@ Go -OpenAI 为 Go 编程语言提供了一个 API 帮助库,目前处于 beta 阶段。你可以使用下面的代码导入该库: +OpenAI 为 Go 语言提供了一个 API 帮助库,目前处于 beta 阶段。你可以使用下面的代码导入该库: ```go import ( @@ -233,9 +233,9 @@ import ( ``` -向API 发起的首个请求示例如下: [Responses API](https://developers.openai.com/api/reference/resources/responses) 代码如下: +向 API 发出的第一个请求,使用 [Responses API](https://developers.openai.com/api/reference/resources/responses) 示例如下: -测试基本的 API 请求 +测试一个基础的 API 请求 ```go package main @@ -264,7 +264,7 @@ func main() { ``` -要进一步了解如何在 Go 中使用 OpenAI API,请查看下方链接的 GitHub 仓库! +要了解更多在 Go 中使用 OpenAI API 的信息,请查看下方链接的 GitHub 仓库! [在 GitHub 上了解更多信息 @@ -282,7 +282,7 @@ Ruby -要在 Ruby 中使用 OpenAI API,你可以使用官方的 [OpenAI Ruby SDK](https://github.com/openai/openai-ruby)。首先将 gem 添加到你的应用中: +要在 Ruby 中使用 OpenAI API,你可以使用官方的 [OpenAI SDK for Ruby](https://github.com/openai/openai-ruby)。首先将 gem 添加到你的应用中: 使用 Bundler 安装 OpenAI SDK @@ -291,9 +291,9 @@ gem "openai" ``` -安装好 OpenAI SDK 后,创建一个文件, `example.rb` 并将示例代码复制到其中: +安装好 OpenAI SDK 后,创建一个文件 `example.rb` 并将示例代码复制进去: -测试基本的 API 请求 +测试一个基础的 API 请求 ```ruby require "openai" @@ -309,7 +309,7 @@ puts(response.output_text) ``` -使用 `ruby example.rb`。稍等片刻,你应该会看到 API 请求的输出。 +使用 `ruby example.rb`。稍等片刻,你应当能看到 API 请求的输出。 [在 GitHub 上了解更多信息 @@ -336,9 +336,9 @@ brew install openai/tools/openai ``` -然后在你的 shell 中运行一个基本的 API 请求: +然后在 shell 中运行一个基础的 API 请求: -测试基本的 API 请求 +测试一个基础的 API 请求 ```bash openai responses create \ @@ -349,7 +349,7 @@ openai responses create \ ``` -使用 CLI 完成可重复的终端工作流,例如从文件中提取结构化数据、生成图像、合成语音,以及使用 shell 工具组合 API 调用,例如 `jq`. +将 CLI 用于可重复的终端工作流,例如从文件中提取结构化数据、生成图像、创建语音,以及使用以下 shell 工具组合 API 调用 `jq`. [OpenAI CLI 指南 @@ -361,11 +361,11 @@ openai responses create \ ## 使用 Agents SDK -使用上面的官方 OpenAI SDK 直接发起 API 请求。当你的应用需要以代码为先的编排时,使用 Agents SDK -用于 智能体、工具、 +直接 OpenAI 请求请使用上述官方 SDK API。当你的应用需要代码优先的编排时,请使用 Agents SDK +来处理 智能体、工具、 交接、护栏、追踪或沙箱执行。 -如果你正在决定是采用直接 API 请求还是以代码为先的编排, +如果你要在直接 API 请求和代码优先的编排之间做选择, 请参阅 [Responses API 与 Agents SDK 的对比](https://developers.openai.com/api/docs/guides/agents#agents-sdk-vs-responses-api). [Agents SDK 快速入门 @@ -379,72 +379,72 @@ openai responses create \ ## Azure OpenAI 库 -Microsoft 的 Azure 团队维护着与 OpenAI API 以及 Azure OpenAI 服务兼容的库。请阅读下面的库文档,了解如何将其与 OpenAI API 配合使用。 +Microsoft 的 Azure 团队维护着与 OpenAI API 和 Azure OpenAI 服务兼容的库。阅读下面的库文档,了解如何将它们与 OpenAI API 一起使用。 -- [Azure OpenAI .NET 客户端库](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/openai/Azure.AI.OpenAI) -- [Azure OpenAI JavaScript 客户端库](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/openai/openai) -- [Azure OpenAI Java 客户端库](https://github.com/Azure/azure-sdk-for-java/tree/main/sdk/openai/azure-ai-openai) -- [Azure OpenAI Go 客户端库](https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/ai/azopenai) +- [适用于 .NET 的 Azure OpenAI 客户端库](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/openai/Azure.AI.OpenAI) +- [适用于 JavaScript 的 Azure OpenAI 客户端库](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/openai/openai) +- [适用于 Java 的 Azure OpenAI 客户端库](https://github.com/Azure/azure-sdk-for-java/tree/main/sdk/openai/azure-ai-openai) +- [适用于 Go 的 Azure OpenAI 客户端库](https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/ai/azopenai) --- ## 社区库 -下面的库由更广泛的开发者社区构建和维护。你也可以 [查看我们在 GitHub 上的 OpenAPI 规范](https://github.com/openai/openai-openapi) 仓库,及时了解我们对 API 所做更改的更新。 +以下库由更广泛的开发者社区构建和维护。你还可以 [在 GitHub 上关注我们的 OpenAPI 规范仓库](https://github.com/openai/openai-openapi) ,以便及时了解我们对 API 所做更改的更新。 -请注意,OpenAI 不会验证这些项目的正确性或安全性。 **使用时请自行承担风险!** +请注意,OpenAI 不会验证这些项目的正确性或安全性。 **使用风险自负!** ### Clojure -- [openai-clojure](https://github.com/wkok/openai-clojure) 作者 [wkok](https://github.com/wkok) +- [openai-clojure](https://github.com/wkok/openai-clojure) 由 [wkok](https://github.com/wkok) ### Dart/Flutter -- [openai](https://github.com/anasfik/openai) 作者 [anasfik](https://github.com/anasfik) +- [openai](https://github.com/anasfik/openai) 由 [anasfik](https://github.com/anasfik) ### Delphi -- [DelphiOpenAI](https://github.com/HemulGM/DelphiOpenAI) 作者 [HemulGM](https://github.com/HemulGM) +- [DelphiOpenAI](https://github.com/HemulGM/DelphiOpenAI) 由 [HemulGM](https://github.com/HemulGM) ### Elixir -- [openai.ex](https://github.com/mgallo/openai.ex) 作者 [mgallo](https://github.com/mgallo) +- [openai.ex](https://github.com/mgallo/openai.ex) 由 [mgallo](https://github.com/mgallo) ### Kotlin -- [openai-kotlin](https://github.com/Aallam/openai-kotlin) 作者 [Mouaad Aallam](https://github.com/Aallam) +- [openai-kotlin](https://github.com/Aallam/openai-kotlin) 由 [Mouaad Aallam](https://github.com/Aallam) ### PHP -- [orhanerday/open-ai](https://packagist.org/packages/orhanerday/open-ai) 作者 [orhanerday](https://github.com/orhanerday) -- [openai-php client](https://github.com/openai-php/client) 作者 [openai-php](https://github.com/openai-php) +- [orhanerday/open-ai](https://packagist.org/packages/orhanerday/open-ai) 由 [orhanerday](https://github.com/orhanerday) +- [openai-php client](https://github.com/openai-php/client) 由 [openai-php](https://github.com/openai-php) ### Rust -- [async-openai](https://github.com/64bit/async-openai) 作者 [64bit](https://github.com/64bit) +- [async-openai](https://github.com/64bit/async-openai) 由 [64bit](https://github.com/64bit) ### Scala -- [openai-scala-client](https://github.com/cequence-io/openai-scala-client) 作者 [cequence-io](https://github.com/cequence-io) +- [openai-scala-client](https://github.com/cequence-io/openai-scala-client) 由 [cequence-io](https://github.com/cequence-io) ### Swift -- [AIProxySwift](https://github.com/lzell/AIProxySwift) 作者 [Lou Zell](https://github.com/lzell) -- [OpenAIKit](https://github.com/dylanshine/openai-kit) 作者 [dylanshine](https://github.com/dylanshine) -- [OpenAI](https://github.com/MacPaw/OpenAI/) 作者 [MacPaw](https://github.com/MacPaw) +- [AIProxySwift](https://github.com/lzell/AIProxySwift) 由 [Lou Zell](https://github.com/lzell) +- [OpenAIKit](https://github.com/dylanshine/openai-kit) 由 [dylanshine](https://github.com/dylanshine) +- [OpenAI](https://github.com/MacPaw/OpenAI/) 由 [MacPaw](https://github.com/MacPaw) ### Unity -- [com.openai.unity](https://github.com/RageAgainstThePixel/com.openai.unity) 作者 [RageAgainstThePixel](https://github.com/RageAgainstThePixel) +- [com.openai.unity](https://github.com/RageAgainstThePixel/com.openai.unity) 由 [RageAgainstThePixel](https://github.com/RageAgainstThePixel) ### Unreal Engine -- [OpenAI-Api-Unreal](https://github.com/KellanM/OpenAI-Api-Unreal) 作者 [KellanM](https://github.com/KellanM) +- [OpenAI-Api-Unreal](https://github.com/KellanM/OpenAI-Api-Unreal) 由 [KellanM](https://github.com/KellanM) ## 其他 OpenAI 仓库 -- [tiktoken](https://github.com/openai/tiktoken) - 计算 token -- [simple-evals](https://github.com/openai/simple-evals) - 简单评估库 -- [mle-bench](https://github.com/openai/mle-bench) - 用于评估机器学习工程师智能体的库 +- [tiktoken](https://github.com/openai/tiktoken) - 统计 token 数 +- [simple-evals](https://github.com/openai/simple-evals) - 简易评估库 +- [mle-bench](https://github.com/openai/mle-bench) - 评估机器学习工程师的智能体库 - [gym](https://github.com/openai/gym) - 强化学习库 -- [swarm](https://github.com/openai/swarm) - 教学编排代码仓库 \ No newline at end of file +- [swarm](https://github.com/openai/swarm) - 教学用编排仓库 \ No newline at end of file diff --git a/docs/zh/api/docs/quickstart.md b/docs/zh/api/docs/quickstart.md index b28447c..0abbcd6 100644 --- a/docs/zh/api/docs/quickstart.md +++ b/docs/zh/api/docs/quickstart.md @@ -1,10 +1,10 @@ # 开发者快速入门 -> 如需完整文档索引,请参阅 [llms.txt](/llms.txt)。如需获取文档页面的 Markdown 版本,请在页面 URL 后追加 `.md` 即可。 +> 如需查看完整文档索引,请参阅 [llms.txt](/llms.txt)。可通过在页面 URL 末尾附加 `.md` 来获取文档页面的 Markdown 版本。 -OpenAI API 提供了一个统一的接口,用于访问业界领先的 AI [模型](https://developers.openai.com/api/docs/models) ,涵盖文本生成、自然语言处理、计算机视觉等任务。你可以通过创建一个 API 密钥并发起你的第一次 API 调用来快速入门,了解如何生成文本、分析图像、构建智能体等等。 +OpenAI API 提供面向先进 AI 的统一接口 [模型](https://developers.openai.com/api/docs/models) ,可用于文本生成、自然语言处理、计算机视觉等任务。首先创建一个 API 密钥并运行你的首次 API 调用,快速入门。了解如何生成文本、分析图像、构建智能体等。 -## 创建并导出 API 密钥 +## 创建并导出API密钥 @@ -17,13 +17,13 @@ StatsigClient.logEvent("quickstart_create_api_key_click", null, null) -开始之前,先在仪表盘中创建一个 API 密钥,后续你需要用它来 -安全地 [访问 API](https://developers.openai.com/api/reference/overview)。请将密钥 -保存在安全的位置,例如计算机上的某个 [`.zshrc` +开始之前,请在控制台中创建一个 API 密钥,你将用它来 +安全地 [访问 API](https://developers.openai.com/api/reference/overview)。请将该密钥 +存放在安全的位置,例如计算机上的一个 [`.zshrc` 文件](https://www.freecodecamp.org/news/how-do-zsh-configuration-files-work/) 或 -其他文本文件。生成 API 密钥后,将其导出为 +另一个文本文件。生成 API 密钥后,请将其导出为 环境变量 [环境变量](https://en.wikipedia.org/wiki/Environment_variable) -。 +在你的终端中。 @@ -52,7 +52,7 @@ setx OPENAI_API_KEY "your_api_key_here" 每个 OpenAI SDK 都会自动从系统环境中读取你的 API 密钥。 -## 安装 OpenAI SDK 并发起 API 调用 +## 安装 OpenAI SDK 并运行 API 调用 @@ -60,7 +60,7 @@ JavaScript -要在 Node.js、Deno 或 Bun 等服务端 JavaScript 环境中使用 OpenAI API,可以使用官方的 [OpenAI TypeScript 和 JavaScript SDK](https://github.com/openai/openai-node)。首先使用 [npm](https://www.npmjs.com/) 或你偏好的包管理器安装 SDK: +要在 Node.js、Deno 或 Bun 等服务端 JavaScript 环境中使用 OpenAI API,你可以使用 [OpenAI TypeScript 和 JavaScript SDK](https://github.com/openai/openai-node)。先通过 [npm](https://www.npmjs.com/) 或你常用的包管理器安装 SDK: 使用 npm 安装 OpenAI SDK @@ -69,7 +69,7 @@ npm install openai ``` -安装好 OpenAI SDK 后,创建一个名为 `example.mjs` 的文件,并将示例代码复制进去: +安装好 OpenAI SDK 后,新建一个文件 `example.mjs` ,并将下面的示例代码复制进去: 测试一个基础的 API 请求 @@ -86,7 +86,7 @@ console.log(response.output_text); ``` -使用 `node example.mjs` (或 Deno、Bun 中对应的命令)执行该代码。稍后你应能看到 API 请求的输出。 +使用 `node example.mjs` (或 Deno、Bun 中等效的命令)执行代码。稍等片刻,你就能看到 API 请求的输出。 [在 GitHub 上了解更多信息 @@ -104,7 +104,7 @@ Python -要在 Python 中使用 OpenAI API,可以使用官方的 [OpenAI Python SDK](https://github.com/openai/openai-python)。首先使用 [pip](https://pypi.org/project/pip/): +要在 Python 中使用 OpenAI API,你可以使用官方的 [OpenAI Python SDK](https://github.com/openai/openai-python)。先通过 [pip](https://pypi.org/project/pip/): 使用 pip 安装 OpenAI SDK @@ -113,7 +113,7 @@ pip install openai ``` -安装好 OpenAI SDK 后,创建一个名为 `example.py` 的文件,并将示例代码复制进去: +安装好 OpenAI SDK 后,新建一个文件 `example.py` ,并将下面的示例代码复制进去: 测试一个基础的 API 请求 @@ -131,7 +131,7 @@ print(response.output_text) ``` -使用 `python example.py`。稍后你应能看到 API 请求的输出。 +使用 `python example.py`。稍等片刻,你就能看到 API 请求的输出。 [在 GitHub 上了解更多信息 @@ -149,13 +149,13 @@ print(response.output_text) -该公司 与 Microsoft 合作提供了一个官方支持的 C# OpenAI API 客户端。你可以使用 .NET CLI 从 [NuGet](https://www.nuget.org/). +该公司 与 Microsoft 合作,提供一个官方支持的 C# OpenAI API 客户端。你可以使用 .NET CLI 从 [NuGet](https://www.nuget.org/). ``` dotnet add package OpenAI ``` -向 API 发起的一个简单请求示例如下: [Responses API](https://developers.openai.com/api/reference/resources/responses) 如下所示: +一个针对API 的简单请求到 [Responses API](https://developers.openai.com/api/reference/resources/responses) 看起来像这样: 测试一个基础的 API 请求 @@ -184,18 +184,18 @@ Java -OpenAI 为 Java 编程语言提供了一个 API 帮助库,当前处于 beta 阶段。你可以使用以下配置引入 Maven 依赖: +OpenAI 为 Java 编程语言提供了一个 API 帮助程序,目前处于 beta 阶段。你可以使用以下配置添加 Maven 依赖: ```xml com.openai openai-java - 4.54.0 + 4.55.0 ``` -一个简单的 API 请求示例 [Responses API](https://developers.openai.com/api/reference/resources/responses) 如下所示: +一个针对API 的简单请求到 [Responses API](https://developers.openai.com/api/reference/resources/responses) 看起来像这样: 测试一个基础的 API 请求 @@ -241,7 +241,7 @@ Go -OpenAI 为 Go 编程语言提供了一个 API 帮助库,当前处于 beta 阶段。你可以使用下面的代码导入该库: +OpenAI 为 Go 编程语言提供了一个 API 帮助程序,目前处于 beta 阶段。你可以使用下面的代码导入该库: ```go import ( @@ -250,7 +250,7 @@ import ( ``` -向 API 发起的第一个请求示例 [Responses API](https://developers.openai.com/api/reference/resources/responses) 如下所示: +一个针对API 的首次请求到 [Responses API](https://developers.openai.com/api/reference/resources/responses) 看起来像这样: 测试一个基础的 API 请求 @@ -299,7 +299,7 @@ Ruby -要在 Ruby 中使用 OpenAI API,你可以使用官方的 [OpenAI Ruby SDK](https://github.com/openai/openai-ruby)。首先将 gem 添加到你的应用中: +要在 Ruby 中使用 OpenAI API,你可以使用官方的 [OpenAI Ruby SDK](https://github.com/openai/openai-ruby)。首先将 gem 添加到你的应用程序: 使用 Bundler 安装 OpenAI SDK @@ -308,7 +308,7 @@ gem "openai" ``` -安装好 OpenAI SDK 后,创建一个名为 `example.rb` 的文件,并将示例代码复制进去: +安装好 OpenAI SDK 后,新建一个文件 `example.rb` ,并将下面的示例代码复制进去: 测试一个基础的 API 请求 @@ -326,7 +326,7 @@ puts(response.output_text) ``` -使用 `ruby example.rb`。稍后你应能看到 API 请求的输出。 +使用 `ruby example.rb`。稍等片刻,你就能看到 API 请求的输出。 [在 GitHub 上了解更多信息 @@ -359,12 +359,12 @@ StatsigClient.logEvent("quickstart_add_credits_billing_click", null, null) {/* prettier-ignore */} -恭喜你成功运行了一次免费测试 API 请求!开始使用更高的额度构建真实的应用,并使用我们的模型生成文本、音频、图像、视频等内容。 [我们的模型](https://developers.openai.com/api/docs/models) 生成文本、音频、图像、视频等内容。 +恭喜你成功运行了一次免费的测试 API 请求!开始构建具有更高限额的真实应用,使用 [我们的模型](https://developers.openai.com/api/docs/models) 生成文本、音频、图像、视频等内容。 - 探索专为帮助你更快交付而设计的工具和文档: + 探索旨在帮助你更快交付的工具和文档: [StatsigClient.logEvent( @@ -387,7 +387,7 @@ StatsigClient.logEvent("quickstart_add_credits_billing_click", null, null) ## 分析图像和文件 -直接将图片 URL、上传的文件或 PDF 文档发送给模型,以提取文本、分类内容或检测视觉元素。 +将图片 URL、上传的文件或 PDF 文档直接发送给模型,以提取文本、对内容进行分类,或识别视觉元素。 @@ -1103,7 +1103,7 @@ curl "https://api.openai.com/v1/responses" \ ## 使用工具扩展模型 -通过附加 [工具](https://developers.openai.com/api/docs/guides/tools),让模型能够访问外部数据和函数。可以使用 网页搜索 或 文件搜索 等内置工具,也可以定义自己的工具来调用 API、运行代码或与第三方系统集成。 +通过附加 [工具](https://developers.openai.com/api/docs/guides/tools)。为模型赋予对外部数据和函数的访问能力。使用 网页搜索 或 文件搜索 等内置工具,或自定义工具以调用 API、运行代码或与第三方系统集成。 @@ -1998,11 +1998,11 @@ puts(response.output_text) Learn to enable the model to call your own custom code.](https://developers.openai.com/api/docs/guides/function-calling) -## 以流式方式接收响应并构建实时应用 +## 流式响应与构建实时应用 -使用服务端发送 [流式事件](https://developers.openai.com/api/docs/guides/streaming-responses) 在结果生成时即时展示,或使用 [Realtime API](https://developers.openai.com/api/docs/guides/realtime) 构建支持文本、音频和图像输入的交互式语音应用。 +使用服务端发送 [流式事件](https://developers.openai.com/api/docs/guides/streaming-responses) 可在生成时展示结果,也可使用 [Realtime API](https://developers.openai.com/api/docs/guides/realtime) 来构建交互式语音应用,以及支持文本、音频和图像输入的应用。 -从 API 接收服务端发送事件流 +从 API 流式接收服务端事件 ```javascript import { OpenAI } from "openai"; @@ -2144,7 +2144,7 @@ end ## 构建智能体 -使用 OpenAI 平台构建 [智能体](https://developers.openai.com/api/docs/guides/agents) ,使其能够代表你的用户采取行动——例如 [控制计算机](https://developers.openai.com/api/docs/guides/tools-computer-use)。使用 [Agents SDK](https://developers.openai.com/api/docs/guides/agents) 在你的服务端创建编排逻辑。 +使用 OpenAI 平台来构建 [智能体](https://developers.openai.com/api/docs/guides/agents) ,让它们能够代表你的用户采取行动——例如 [控制计算机](https://developers.openai.com/api/docs/guides/tools-computer-use)。使用 Agents SDK [智能体开发工具包](https://developers.openai.com/api/docs/guides/agents) 在服务器上创建编排逻辑。 构建一个语言分诊 智能体 diff --git a/docs/zh/api/reference/resources/batches.md b/docs/zh/api/reference/resources/batches.md index 7ff6e8d..b654511 100644 --- a/docs/zh/api/reference/resources/batches.md +++ b/docs/zh/api/reference/resources/batches.md @@ -1,18 +1,18 @@ -# 批量 +# Batches -> 如需查看完整的文档索引,请参阅 [llms.txt](/llms.txt)。文档页面的 Markdown 版本可通过在页面 URL 后追加 `.md` 来获取。 +> 如需查看完整文档索引,请参阅 [llms.txt](/llms.txt)。在页面 URL 末尾附加 `.md` 即可获取文档页面的 Markdown 版本。 -## 取消批次 +## Cancel batch -**post** `/batches/{batch_id}/cancel` +**后** `/batches/{batch_id}/cancel` -取消进行中的批次。批次将保持 `cancelling` 状态最多 10 分钟,然后变为 `cancelled`,在此状态下,输出文件中可获取部分结果(如果有)。 +取消正在进行的批量任务。该批量任务将处于 `cancelling` 状态,最长持续 10 分钟,然后变为 `cancelled`,状态,此时输出文件中将提供部分结果(若有)。 ### 路径参数 - `batch_id: string` -### 返回 +### 返回值 - `Batch object { id, completion_window, created_at, 19 more }` @@ -20,19 +20,19 @@ - `completion_window: string` - 批处理应在该时间范围内进行处理。 + 处理该批次的时间窗口。 - `created_at: number` - 批处理创建时的 Unix 时间戳(以秒为单位)。 + 批次创建时的 Unix 时间戳(秒)。 - `endpoint: string` - 批处理使用的 OpenAI API 端点。 + 该批次所使用的 OpenAI API 端点。 - `input_file_id: string` - 批处理的输入文件 ID。 + 该批次的输入文件 ID。 - `object: "batch"` @@ -42,7 +42,7 @@ - `status: "validating" or "failed" or "in_progress" or 5 more` - 批处理的当前状态。 + 该批次当前的状态。 - `"validating"` @@ -62,19 +62,19 @@ - `cancelled_at: optional number` - 批处理取消时的 Unix 时间戳(以秒为单位)。 + 该批次被取消时的 Unix 时间戳(秒)。 - `cancelling_at: optional number` - 批处理开始取消时的 Unix 时间戳(以秒为单位)。 + 该批次开始取消时的 Unix 时间戳(秒)。 - `completed_at: optional number` - 批处理完成时的 Unix 时间戳(以秒为单位)。 + 该批次完成时的 Unix 时间戳(秒)。 - `error_file_id: optional string` - 包含出错请求输出的文件 ID。 + 包含请求错误输出的文件 ID。 - `errors: optional object { data, object }` @@ -82,19 +82,19 @@ - `code: optional string` - 标识错误类型的错误代码。 + 用于标识错误类型的错误代码。 - `line: optional number or null` - 错误发生时输入文件的行号(如适用)。 + 发生错误的输入文件行号(如果适用)。 - `message: optional string` - 提供有关错误更多详细信息的人类可读消息。 + 提供更多错误细节的人类可读消息。 - `param: optional string or null` - 导致错误的参数名称(如适用)。 + 引发错误的参数名称(如果适用)。 - `object: optional string` @@ -102,94 +102,94 @@ - `expired_at: optional number` - 批处理过期时的 Unix 时间戳(以秒为单位)。 + 该批次过期时的 Unix 时间戳(秒)。 - `expires_at: optional number` - 批处理将过期时的 Unix 时间戳(以秒为单位)。 + 该批次将过期时的 Unix 时间戳(秒)。 - `failed_at: optional number` - 批处理失败时的 Unix 时间戳(以秒为单位)。 + 该批次失败时的 Unix 时间戳(秒)。 - `finalizing_at: optional number` - 批处理开始最终确定时的 Unix 时间戳(以秒为单位)。 + 该批次开始终结时的 Unix 时间戳(秒)。 - `in_progress_at: optional number` - 批处理开始处理时的 Unix 时间戳(以秒为单位)。 + 该批次开始处理时的 Unix 时间戳(秒)。 - `metadata: optional Metadata or null` - 可附加到对象上的 16 组键值对。这可用于 - 以结构化格式存储关于该对象的额外信息, - 并通过 API 或控制面板查询对象。 + 可附加到对象的 16 组键值对。可用于 + 用于以结构化格式存储对象的附加信息, + 并通过 API 或控制台查询对象。 键为字符串,最大长度为 64 个字符。值为字符串, 最大长度为 512 个字符。 - `model: optional string` - 用于处理批次的模型 ID,例如 `gpt-5-2025-08-07`。OpenAI - 提供多种具有不同能力、性能特点 - 和价格点的模型。请参阅 [模型 + 用于处理该批处理的模型 ID,例如 `gpt-5.6-sol`。OpenAI + 提供了多种具备不同能力、性能 + 特征和价位的模型。请参阅 [模型 指南](/docs/models) 以浏览和比较可用模型。 - `output_file_id: optional string` - 包含成功执行请求输出的文件 ID。 + 包含已成功执行请求输出内容的文件 ID。 - `request_counts: optional BatchRequestCounts` - 批次中不同状态的请求计数。 + 该批处理中不同状态的请求计数。 - `completed: number` - 已成功完成的请求数。 + 已成功完成的请求数量。 - `failed: number` - 已失败的请求数。 + 已失败的请求数量。 - `total: number` - 批次中的请求总数。 + 该批处理中的请求总数。 - `usage: optional BatchUsage` - 表示令牌使用详情,包括输入令牌、输出令牌、 - 输出令牌的明细以及使用的令牌总数。仅填补于 - 2025 年 9 月 7 日之后创建的批次。 + 表示 token 使用详情,包括输入 token、输出 token、输出 + token 的细分以及使用的 token 总数。仅在 + 2025 年 9 月 7 日之后创建的批处理上填充。 - `input_tokens: number` - 输入令牌数。 + 输入 token 的数量。 - `input_tokens_details: object { cached_tokens }` - 输入令牌的详细细分。 + 输入 token 的详细明细。 - `cached_tokens: number` - 从缓存中检索的令牌数。 [更多信息 - 提示缓存](/docs/guides/prompt-caching). + 从缓存中检索到的 token 数。 [了解更多 + prompt caching](/docs/guides/prompt-caching). - `output_tokens: number` - 输出令牌数。 + 输出 token 数。 - `output_tokens_details: object { reasoning_tokens }` - 输出令牌的详细细分。 + 输出 token 的详细明细。 - `reasoning_tokens: number` - 推理令牌数。 + 推理 token 数。 - `total_tokens: number` - 使用的令牌总数。 + 使用的 token 总数。 ### 示例 @@ -297,23 +297,23 @@ curl https://api.openai.com/v1/batches/batch_abc123/cancel \ } ``` -## 创建批次 +## 创建批处理 -**post** `/batches` +**后** `/batches` -根据上传的请求文件创建并执行一个批次 +从已上传的请求文件创建并执行批量任务 ### 正文参数 - `completion_window: "24h"` - 批处理应被处理的时间范围。目前仅支持 `24h` 。 + 批量应在该时间范围内处理。目前仅支持 `24h` 。 - `"24h"` - `endpoint: "/v1/responses" or "/v1/chat/completions" or "/v1/embeddings" or 5 more` - 批处理中所有请求将使用的端点。目前支持 `/v1/responses`, `/v1/chat/completions`, `/v1/embeddings`, `/v1/completions`, `/v1/moderations`, `/v1/images/generations`, `/v1/images/edits`,以及 `/v1/videos` 。请注意, `/v1/embeddings` 批处理中的所有请求合计最多只能包含 50,000 个嵌入输入。 + 用于该批处理中所有请求的端点。目前支持 `/v1/responses`, `/v1/chat/completions`, `/v1/embeddings`, `/v1/completions`, `/v1/moderations`, `/v1/images/generations`, `/v1/images/edits`,和 `/v1/videos` 。请注意, `/v1/embeddings` 批量还限制该批处理中所有请求的嵌入输入总数上限为 50,000 个。 - `"/v1/responses"` @@ -337,32 +337,32 @@ curl https://api.openai.com/v1/batches/batch_abc123/cancel \ 请参阅 [上传文件](/docs/api-reference/files/create) 了解如何上传文件。 - 你的输入文件必须格式化为 [JSONL 文件](/docs/api-reference/batch/request-input),并且必须以上传目的 `batch`。进行上传。该文件最多可包含 50,000 个请求,大小可达 200 MB。 + 你的输入文件必须格式化为 [JSONL 文件](/docs/api-reference/batch/request-input),并必须以该用途上传 `batch`。文件最多可包含 50,000 个请求,大小可达 200 MB。 - `metadata: optional Metadata or null` - 一组 16 个键值对,可附加到对象上。这可以 - 用于以结构化格式存储关于对象的附加信息, - 并通过 API 或仪表板查询对象。 + 可附加到对象的 16 组键值对。可用于 + 用于以结构化格式存储对象的附加信息, + 并通过 API 或控制台查询对象。 - 键是字符串,最大长度为 64 个字符。值是字符串, + 键为字符串,最大长度为 64 个字符。值为字符串, 最大长度为 512 个字符。 - `output_expires_after: optional object { anchor, seconds }` - 为批处理生成的输出文件和/或错误文件的过期策略。 + 为某个批次生成的输出文件和/或错误文件的过期策略。 - `anchor: "created_at"` - 过期策略开始生效的锚点时间戳。支持的锚点: `created_at`。请注意,锚点是文件创建时间,而非批次创建时间。 + 过期策略生效所基于的锚点时间戳。支持以下锚点: `created_at`. 请注意,锚点是文件的创建时间,而非批次的创建时间。 - `"created_at"` - `seconds: number` - 锚点时间之后文件过期的秒数。必须在 3600(1小时)到 2592000(30天)之间。 + 距锚点时间多少秒后文件过期。必须介于 3600(1 小时)到 2592000(30 天)之间。 -### 返回 +### 返回值 - `Batch object { id, completion_window, created_at, 19 more }` @@ -370,19 +370,19 @@ curl https://api.openai.com/v1/batches/batch_abc123/cancel \ - `completion_window: string` - 批次应在该时间范围内处理。 + 处理该批次的时间窗口。 - `created_at: number` - 批次创建时的 Unix 时间戳(以秒为单位)。 + 批次创建时的 Unix 时间戳(秒)。 - `endpoint: string` - 批次使用的 OpenAI API 端点。 + 该批次所使用的 OpenAI API 端点。 - `input_file_id: string` - 批次输入文件的 ID。 + 该批次的输入文件 ID。 - `object: "batch"` @@ -392,7 +392,7 @@ curl https://api.openai.com/v1/batches/batch_abc123/cancel \ - `status: "validating" or "failed" or "in_progress" or 5 more` - 批次的当前状态。 + 该批次当前的状态。 - `"validating"` @@ -412,19 +412,19 @@ curl https://api.openai.com/v1/batches/batch_abc123/cancel \ - `cancelled_at: optional number` - 批次被取消时的 Unix 时间戳(以秒为单位)。 + 该批次被取消时的 Unix 时间戳(秒)。 - `cancelling_at: optional number` - 批次开始取消时的 Unix 时间戳(以秒为单位)。 + 该批次开始取消时的 Unix 时间戳(秒)。 - `completed_at: optional number` - 批次完成时的 Unix 时间戳(以秒为单位)。 + 该批次完成时的 Unix 时间戳(秒)。 - `error_file_id: optional string` - 包含出错请求输出内容的文件 ID。 + 包含请求错误输出的文件 ID。 - `errors: optional object { data, object }` @@ -436,15 +436,15 @@ curl https://api.openai.com/v1/batches/batch_abc123/cancel \ - `line: optional number or null` - 错误发生时输入文件中对应的行号(如适用)。 + 发生错误的输入文件行号(如果适用)。 - `message: optional string` - 提供有关错误更多详细信息的人类可读消息。 + 提供更多错误细节的人类可读消息。 - `param: optional string or null` - 导致错误的参数名称(如适用)。 + 引发错误的参数名称(如果适用)。 - `object: optional string` @@ -452,47 +452,47 @@ curl https://api.openai.com/v1/batches/batch_abc123/cancel \ - `expired_at: optional number` - 批次过期时的 Unix 时间戳(以秒为单位)。 + 该批次过期时的 Unix 时间戳(秒)。 - `expires_at: optional number` - 批次即将过期时的 Unix 时间戳(以秒为单位)。 + 该批次将过期时的 Unix 时间戳(秒)。 - `failed_at: optional number` - 批次失败时的 Unix 时间戳(以秒为单位)。 + 该批次失败时的 Unix 时间戳(秒)。 - `finalizing_at: optional number` - 批次开始定稿时的 Unix 时间戳(以秒为单位)。 + 该批次开始终结时的 Unix 时间戳(秒)。 - `in_progress_at: optional number` - 批次开始处理时的 Unix 时间戳(以秒为单位)。 + 该批次开始处理时的 Unix 时间戳(秒)。 - `metadata: optional Metadata or null` - 一组 16 个键值对,可附加到对象上。这可以 - 用于以结构化方式存储关于对象的额外信息, - 并通过 API 或仪表板查询对象。 + 可附加到对象的 16 组键值对。可用于 + 用于以结构化格式存储对象的附加信息, + 并通过 API 或控制台查询对象。 - 键是字符串,最大长度为 64 个字符。值是字符串 - ,最大长度为 512 个字符。 + 键为字符串,最大长度为 64 个字符。值为字符串, + 最大长度为 512 个字符。 - `model: optional string` - 用于处理批次的模型 ID,如 `gpt-5-2025-08-07`。OpenAI - 提供多种模型,具有不同的功能、性能 - 特征和价格点。请参阅 [模型 + 用于处理该批处理的模型 ID,例如 `gpt-5.6-sol`。OpenAI + 提供了多种具备不同能力、性能 + 特征和价位的模型。请参阅 [模型 指南](/docs/models) 以浏览和比较可用模型。 - `output_file_id: optional string` - 包含成功执行请求输出的文件的 ID。 + 包含已成功执行请求输出内容的文件 ID。 - `request_counts: optional BatchRequestCounts` - 批次内不同状态的请求计数。 + 该批处理中不同状态的请求计数。 - `completed: number` @@ -500,17 +500,17 @@ curl https://api.openai.com/v1/batches/batch_abc123/cancel \ - `failed: number` - 失败的请求数量。 + 已失败的请求数量。 - `total: number` - 批次中的请求总数。 + 该批处理中的请求总数。 - `usage: optional BatchUsage` - 表示令牌使用详情,包括输入令牌、输出令牌、输出令牌的 - 细分以及使用的总令牌。仅在 - 2025 年 9 月 7 日之后创建的批次中填充。 + 表示 token 使用详情,包括输入 token、输出 token、输出 + token 的细分以及使用的 token 总数。仅在 + 2025 年 9 月 7 日之后创建的批处理上填充。 - `input_tokens: number` @@ -518,24 +518,24 @@ curl https://api.openai.com/v1/batches/batch_abc123/cancel \ - `input_tokens_details: object { cached_tokens }` - 输入 token 的详细分解。 + 输入 token 的详细明细。 - `cached_tokens: number` - 从缓存中检索的 token 数量。 [更多关于 - 提示缓存](/docs/guides/prompt-caching). + 从缓存中检索到的 token 数。 [了解更多 + prompt caching](/docs/guides/prompt-caching). - `output_tokens: number` - 输出 token 的数量。 + 输出 token 数。 - `output_tokens_details: object { reasoning_tokens }` - 输出 token 的详细分解。 + 输出 token 的详细明细。 - `reasoning_tokens: number` - 推理 token 的数量。 + 推理 token 数。 - `total_tokens: number` @@ -656,7 +656,7 @@ curl https://api.openai.com/v1/batches \ } ``` -## 列出批次 +## 列出批量任务 **get** `/batches` @@ -666,13 +666,13 @@ curl https://api.openai.com/v1/batches \ - `after: optional string` - 用于分页的游标。 `after` 是一个对象 ID,用于定义你在列表中的位置。例如,如果你发出一个列表请求并收到 100 个对象,以 obj_foo 结尾,那么你随后的调用可以包含 after=obj_foo,以便获取列表的下一页。 + 用于分页游标的对象 ID。 `after` 是用于定义你在列表中所处位置的对象 ID。例如,如果你发起列表请求并收到 100 个对象,最后一个为 obj_foo,则后续调用可以包含 after=obj_foo 以获取列表的下一页。 - `limit: optional number` - 对返回对象数量的限制。限制范围可以在 1 到 100 之间,默认值为 20。 + 返回对象数量的上限。范围介于 1 到 100 之间,默认值为 20。 -### 返回 +### 返回值 - `data: array of Batch` @@ -680,19 +680,19 @@ curl https://api.openai.com/v1/batches \ - `completion_window: string` - 批处理应被处理的时间范围。 + 处理该批次的时间窗口。 - `created_at: number` - 批处理创建时的 Unix 时间戳(秒)。 + 批次创建时的 Unix 时间戳(秒)。 - `endpoint: string` - 批处理使用的 OpenAI API 端点。 + 该批次所使用的 OpenAI API 端点。 - `input_file_id: string` - 批处理的输入文件的 ID。 + 该批次的输入文件 ID。 - `object: "batch"` @@ -702,7 +702,7 @@ curl https://api.openai.com/v1/batches \ - `status: "validating" or "failed" or "in_progress" or 5 more` - 批处理的当前状态。 + 该批次当前的状态。 - `"validating"` @@ -722,19 +722,19 @@ curl https://api.openai.com/v1/batches \ - `cancelled_at: optional number` - 批处理被取消时的 Unix 时间戳(秒)。 + 该批次被取消时的 Unix 时间戳(秒)。 - `cancelling_at: optional number` - 批处理开始取消时的 Unix 时间戳(秒)。 + 该批次开始取消时的 Unix 时间戳(秒)。 - `completed_at: optional number` - 批处理完成时的 Unix 时间戳(秒)。 + 该批次完成时的 Unix 时间戳(秒)。 - `error_file_id: optional string` - 包含请求错误输出的文件的 ID。 + 包含请求错误输出的文件 ID。 - `errors: optional object { data, object }` @@ -742,19 +742,19 @@ curl https://api.openai.com/v1/batches \ - `code: optional string` - 标识错误类型的错误代码。 + 用于标识错误类型的错误代码。 - `line: optional number or null` - 错误发生的输入文件行号(如适用)。 + 发生错误的输入文件行号(如果适用)。 - `message: optional string` - 提供有关错误的更多信息的人类可读消息。 + 提供更多错误细节的人类可读消息。 - `param: optional string or null` - 导致错误的参数的名称(如适用)。 + 引发错误的参数名称(如果适用)。 - `object: optional string` @@ -762,47 +762,47 @@ curl https://api.openai.com/v1/batches \ - `expired_at: optional number` - 批处理过期时的 Unix 时间戳(秒)。 + 该批次过期时的 Unix 时间戳(秒)。 - `expires_at: optional number` - 批处理将过期时的 Unix 时间戳(秒)。 + 该批次将过期时的 Unix 时间戳(秒)。 - `failed_at: optional number` - 批处理失败时的 Unix 时间戳(秒)。 + 该批次失败时的 Unix 时间戳(秒)。 - `finalizing_at: optional number` - 批处理开始完成时的 Unix 时间戳(秒)。 + 该批次开始终结时的 Unix 时间戳(秒)。 - `in_progress_at: optional number` - 批处理开始处理时的 Unix 时间戳(秒)。 + 该批次开始处理时的 Unix 时间戳(秒)。 - `metadata: optional Metadata or null` - 可附加到对象上的 16 个键值对集合。这可用于 - 以结构化格式存储有关该对象的附加信息,并可通过 - API 或仪表盘查询对象。 + 可附加到对象的 16 组键值对。可用于 + 用于以结构化格式存储对象的附加信息, + 并通过 API 或控制台查询对象。 - 键是字符串,最大长度为 64 个字符。值是字符串, + 键为字符串,最大长度为 64 个字符。值为字符串, 最大长度为 512 个字符。 - `model: optional string` - 用于处理批次的模型 ID,例如 `gpt-5-2025-08-07`。OpenAI - 提供多种具有不同能力、性能特征和价格点的模型。请参阅 - 模型 [指南 - 以浏览和比较可用模型。](/docs/models) 以浏览和比较可用模型。 + 用于处理该批处理的模型 ID,例如 `gpt-5.6-sol`。OpenAI + 提供了多种具备不同能力、性能 + 特征和价位的模型。请参阅 [模型 + 指南](/docs/models) 以浏览和比较可用模型。 - `output_file_id: optional string` - 包含成功执行请求输出结果的文件 ID。 + 包含已成功执行请求输出内容的文件 ID。 - `request_counts: optional BatchRequestCounts` - 批次内不同状态的请求计数。 + 该批处理中不同状态的请求计数。 - `completed: number` @@ -814,42 +814,42 @@ curl https://api.openai.com/v1/batches \ - `total: number` - 批次中的请求总数。 + 该批处理中的请求总数。 - `usage: optional BatchUsage` - 表示令牌使用详情,包括输入令牌、输出令牌、输出令牌的细分以及使用的总令牌数。仅在 - 2025 年 9 月 7 日之后创建的批次上填充。 - 2025 年 9 月 7 日之后创建的批次上填充。 + 表示 token 使用详情,包括输入 token、输出 token、输出 + token 的细分以及使用的 token 总数。仅在 + 2025 年 9 月 7 日之后创建的批处理上填充。 - `input_tokens: number` - 输入令牌的数量。 + 输入 token 的数量。 - `input_tokens_details: object { cached_tokens }` - 输入令牌的详细分解。 + 输入 token 的详细明细。 - `cached_tokens: number` - 从缓存中检索到的令牌数量。 [更多信息 - 提示缓存](/docs/guides/prompt-caching). + 从缓存中检索到的 token 数。 [了解更多 + prompt caching](/docs/guides/prompt-caching). - `output_tokens: number` - 输出令牌的数量。 + 输出 token 数。 - `output_tokens_details: object { reasoning_tokens }` - 输出令牌的详细分解。 + 输出 token 的详细明细。 - `reasoning_tokens: number` - 推理令牌的数量。 + 推理 token 数。 - `total_tokens: number` - 使用的令牌总数。 + 使用的 token 总数。 - `has_more: boolean` @@ -982,7 +982,7 @@ curl https://api.openai.com/v1/batches?limit=2 \ } ``` -## 检索批次 +## Retrieve batch **get** `/batches/{batch_id}` @@ -1000,19 +1000,19 @@ curl https://api.openai.com/v1/batches?limit=2 \ - `completion_window: string` - 批处理应被处理的时间范围。 + 处理该批次的时间窗口。 - `created_at: number` - 批次创建时的 Unix 时间戳(以秒为单位)。 + 批次创建时的 Unix 时间戳(秒)。 - `endpoint: string` - 批次使用的 OpenAI API 端点。 + 该批次所使用的 OpenAI API 端点。 - `input_file_id: string` - 批次输入文件的 ID。 + 该批次的输入文件 ID。 - `object: "batch"` @@ -1022,7 +1022,7 @@ curl https://api.openai.com/v1/batches?limit=2 \ - `status: "validating" or "failed" or "in_progress" or 5 more` - 批次的当前状态。 + 该批次当前的状态。 - `"validating"` @@ -1042,19 +1042,19 @@ curl https://api.openai.com/v1/batches?limit=2 \ - `cancelled_at: optional number` - 批次被取消时的 Unix 时间戳(以秒为单位)。 + 该批次被取消时的 Unix 时间戳(秒)。 - `cancelling_at: optional number` - 批次开始取消时的 Unix 时间戳(以秒为单位)。 + 该批次开始取消时的 Unix 时间戳(秒)。 - `completed_at: optional number` - 批次完成时的 Unix 时间戳(以秒为单位)。 + 该批次完成时的 Unix 时间戳(秒)。 - `error_file_id: optional string` - 包含错误请求输出的文件 ID。 + 包含请求错误输出的文件 ID。 - `errors: optional object { data, object }` @@ -1062,19 +1062,19 @@ curl https://api.openai.com/v1/batches?limit=2 \ - `code: optional string` - 标识错误类型的错误代码。 + 用于标识错误类型的错误代码。 - `line: optional number or null` - 发生错误的输入文件行号,如果适用的话。 + 发生错误的输入文件行号(如果适用)。 - `message: optional string` - 提供关于错误的更多详细信息的人类可读消息。 + 提供更多错误细节的人类可读消息。 - `param: optional string or null` - 导致错误的参数名称,如果适用的话。 + 引发错误的参数名称(如果适用)。 - `object: optional string` @@ -1082,65 +1082,65 @@ curl https://api.openai.com/v1/batches?limit=2 \ - `expired_at: optional number` - 批次过期时的 Unix 时间戳(以秒为单位)。 + 该批次过期时的 Unix 时间戳(秒)。 - `expires_at: optional number` - 批次将过期时的 Unix 时间戳(以秒为单位)。 + 该批次将过期时的 Unix 时间戳(秒)。 - `failed_at: optional number` - 批次失败时的 Unix 时间戳(以秒为单位)。 + 该批次失败时的 Unix 时间戳(秒)。 - `finalizing_at: optional number` - 批次开始最终确定时的 Unix 时间戳(以秒为单位)。 + 该批次开始终结时的 Unix 时间戳(秒)。 - `in_progress_at: optional number` - 批次开始处理时的 Unix 时间戳(以秒为单位)。 + 该批次开始处理时的 Unix 时间戳(秒)。 - `metadata: optional Metadata or null` - 一组最多 16 个键值对,可附加到对象上。这 - 有助于以结构化格式存储有关该对象的额外信息, - 并可通过 API 或仪表板查询对象。 + 可附加到对象的 16 组键值对。可用于 + 用于以结构化格式存储对象的附加信息, + 并通过 API 或控制台查询对象。 键为字符串,最大长度为 64 个字符。值为字符串, 最大长度为 512 个字符。 - `model: optional string` - 用于处理批次的模型 ID,例如 `gpt-5-2025-08-07`。OpenAI - 提供多种具有不同能力、性能 - 特性和价格点的模型。请参阅 [模型 + 用于处理该批处理的模型 ID,例如 `gpt-5.6-sol`。OpenAI + 提供了多种具备不同能力、性能 + 特征和价位的模型。请参阅 [模型 指南](/docs/models) 以浏览和比较可用模型。 - `output_file_id: optional string` - 包含成功执行请求输出的文件的 ID。 + 包含已成功执行请求输出内容的文件 ID。 - `request_counts: optional BatchRequestCounts` - 批次中不同状态的请求计数。 + 该批处理中不同状态的请求计数。 - `completed: number` - 已成功完成的请求数。 + 已成功完成的请求数量。 - `failed: number` - 失败的请求数。 + 已失败的请求数量。 - `total: number` - 批次中的请求总数。 + 该批处理中的请求总数。 - `usage: optional BatchUsage` - 表示令牌使用详情,包括输入令牌、输出令牌、输出令牌的 - 细分以及使用的令牌总数。仅对 2025 年 9 月 7 日之后创建 - 的批次填充。 + 表示 token 使用详情,包括输入 token、输出 token、输出 + token 的细分以及使用的 token 总数。仅在 + 2025 年 9 月 7 日之后创建的批处理上填充。 - `input_tokens: number` @@ -1148,24 +1148,24 @@ curl https://api.openai.com/v1/batches?limit=2 \ - `input_tokens_details: object { cached_tokens }` - 输入 token 的详细分类。 + 输入 token 的详细明细。 - `cached_tokens: number` - 从缓存中检索的 token 数量。 [更多关于 - 提示缓存](/docs/guides/prompt-caching). + 从缓存中检索到的 token 数。 [了解更多 + prompt caching](/docs/guides/prompt-caching). - `output_tokens: number` - 输出 token 的数量。 + 输出 token 数。 - `output_tokens_details: object { reasoning_tokens }` - 输出 token 的详细分类。 + 输出 token 的详细明细。 - `reasoning_tokens: number` - 推理 token 的数量。 + 推理 token 数。 - `total_tokens: number` @@ -1275,9 +1275,9 @@ curl https://api.openai.com/v1/batches/batch_abc123 \ } ``` -## 域类型 +## Domain Types -### 批处理 +### Batch - `Batch object { id, completion_window, created_at, 19 more }` @@ -1285,7 +1285,7 @@ curl https://api.openai.com/v1/batches/batch_abc123 \ - `completion_window: string` - 批次应在该时间范围内处理。 + 处理该批次的时间窗口。 - `created_at: number` @@ -1293,11 +1293,11 @@ curl https://api.openai.com/v1/batches/batch_abc123 \ - `endpoint: string` - 批次使用的 OpenAI API 端点。 + 该批次所使用的 OpenAI API 端点。 - `input_file_id: string` - 批次输入文件的 ID。 + 该批次的输入文件 ID。 - `object: "batch"` @@ -1307,7 +1307,7 @@ curl https://api.openai.com/v1/batches/batch_abc123 \ - `status: "validating" or "failed" or "in_progress" or 5 more` - 批次的当前状态。 + 该批次当前的状态。 - `"validating"` @@ -1327,19 +1327,19 @@ curl https://api.openai.com/v1/batches/batch_abc123 \ - `cancelled_at: optional number` - 批次取消时的 Unix 时间戳(秒)。 + 该批次被取消时的 Unix 时间戳(秒)。 - `cancelling_at: optional number` - 批次开始取消时的 Unix 时间戳(秒)。 + 该批次开始取消时的 Unix 时间戳(秒)。 - `completed_at: optional number` - 批次完成时的 Unix 时间戳(秒)。 + 该批次完成时的 Unix 时间戳(秒)。 - `error_file_id: optional string` - 包含出错请求输出的文件 ID。 + 包含请求错误输出的文件 ID。 - `errors: optional object { data, object }` @@ -1347,19 +1347,19 @@ curl https://api.openai.com/v1/batches/batch_abc123 \ - `code: optional string` - 标识错误类型的错误代码。 + 用于标识错误类型的错误代码。 - `line: optional number or null` - 错误发生时输入文件的行号(如适用)。 + 发生错误的输入文件行号(如果适用)。 - `message: optional string` - 提供错误更多细节的人类可读消息。 + 提供更多错误细节的人类可读消息。 - `param: optional string or null` - 导致错误的参数名称(如适用)。 + 引发错误的参数名称(如果适用)。 - `object: optional string` @@ -1367,47 +1367,47 @@ curl https://api.openai.com/v1/batches/batch_abc123 \ - `expired_at: optional number` - 批次过期时的 Unix 时间戳(秒)。 + 该批次过期时的 Unix 时间戳(秒)。 - `expires_at: optional number` - 批次将过期时的 Unix 时间戳(秒)。 + 该批次将过期时的 Unix 时间戳(秒)。 - `failed_at: optional number` - 批次失败时的 Unix 时间戳(秒)。 + 该批次失败时的 Unix 时间戳(秒)。 - `finalizing_at: optional number` - 批次开始定稿时的 Unix 时间戳(秒)。 + 该批次开始终结时的 Unix 时间戳(秒)。 - `in_progress_at: optional number` - 批次开始处理时的 Unix 时间戳(秒)。 + 该批次开始处理时的 Unix 时间戳(秒)。 - `metadata: optional Metadata or null` - 可附加到对象上的 16 个键值对集合。这可以 - 用于以结构化格式存储有关该对象的额外信息, - 并通过 API 或仪表板查询对象。 + 可附加到对象的 16 组键值对。可用于 + 用于以结构化格式存储对象的附加信息, + 并通过 API 或控制台查询对象。 - 键是字符串,最大长度为 64 个字符。值是字符串, + 键为字符串,最大长度为 64 个字符。值为字符串, 最大长度为 512 个字符。 - `model: optional string` - 用于处理批次的模型 ID,如 `gpt-5-2025-08-07`。OpenAI - 提供多种具有不同能力、性能和 - 价格点的模型。请参阅 [模型 - 指南](/docs/models) 浏览并比较可用模型。 + 用于处理该批处理的模型 ID,例如 `gpt-5.6-sol`。OpenAI + 提供了多种具备不同能力、性能 + 特征和价位的模型。请参阅 [模型 + 指南](/docs/models) 以浏览和比较可用模型。 - `output_file_id: optional string` - 包含成功执行的请求输出的文件 ID。 + 包含已成功执行请求输出内容的文件 ID。 - `request_counts: optional BatchRequestCounts` - 批次中不同状态的请求计数。 + 该批处理中不同状态的请求计数。 - `completed: number` @@ -1415,17 +1415,17 @@ curl https://api.openai.com/v1/batches/batch_abc123 \ - `failed: number` - 失败的请求数量。 + 已失败的请求数量。 - `total: number` - 批次中的请求总数。 + 该批处理中的请求总数。 - `usage: optional BatchUsage` - 表示令牌使用详情,包括输入令牌、输出令牌、输出令牌的 - 细分以及使用的总令牌数。仅在 - 2025年9月7日之后创建的批次中填充。 + 表示 token 使用详情,包括输入 token、输出 token、输出 + token 的细分以及使用的 token 总数。仅在 + 2025 年 9 月 7 日之后创建的批处理上填充。 - `input_tokens: number` @@ -1433,54 +1433,54 @@ curl https://api.openai.com/v1/batches/batch_abc123 \ - `input_tokens_details: object { cached_tokens }` - 输入 token 的详细分解。 + 输入 token 的详细明细。 - `cached_tokens: number` - 从缓存中检索的 token 数量。 [更多关于 - 提示缓存](/docs/guides/prompt-caching). + 从缓存中检索到的 token 数。 [了解更多 + prompt caching](/docs/guides/prompt-caching). - `output_tokens: number` - 输出 token 的数量。 + 输出 token 数。 - `output_tokens_details: object { reasoning_tokens }` - 输出 token 的详细分解。 + 输出 token 的详细明细。 - `reasoning_tokens: number` - 推理 token 的数量。 + 推理 token 数。 - `total_tokens: number` 使用的 token 总数。 -### 批处理错误 +### Batch Error - `BatchError object { code, line, message, param }` - `code: optional string` - 标识错误类型的错误代码。 + 用于标识错误类型的错误代码。 - `line: optional number or null` - 发生错误的输入文件的行号(如适用)。 + 发生错误的输入文件行号(如果适用)。 - `message: optional string` - 提供有关错误的更多详细信息的人类可读消息。 + 提供更多错误细节的人类可读消息。 - `param: optional string or null` - 导致错误的参数名称(如适用)。 + 引发错误的参数名称(如果适用)。 -### 批量请求计数 +### Batch Request Counts - `BatchRequestCounts object { completed, failed, total }` - 批次中不同状态的请求计数。 + 该批处理中不同状态的请求计数。 - `completed: number` @@ -1492,41 +1492,41 @@ curl https://api.openai.com/v1/batches/batch_abc123 \ - `total: number` - 批次中的请求总数。 + 该批处理中的请求总数。 -### 批量使用 +### Batch Usage - `BatchUsage object { input_tokens, input_tokens_details, output_tokens, 2 more }` - 表示令牌用量明细,包括输入令牌、输出令牌、 - 输出令牌的拆分以及所用令牌总数。仅在 - 2025年9月7日之后创建的批次中填充。 + 表示 token 使用详情,包括输入 token、输出 token、输出 + token 的细分以及使用的 token 总数。仅在 + 2025 年 9 月 7 日之后创建的批处理上填充。 - `input_tokens: number` - 输入令牌的数量。 + 输入 token 的数量。 - `input_tokens_details: object { cached_tokens }` - 输入令牌的详细拆分。 + 输入 token 的详细明细。 - `cached_tokens: number` - 从缓存中检索到的令牌数量。 [更多关于 - 提示缓存](/docs/guides/prompt-caching). + 从缓存中检索到的 token 数。 [了解更多 + prompt caching](/docs/guides/prompt-caching). - `output_tokens: number` - 输出令牌的数量。 + 输出 token 数。 - `output_tokens_details: object { reasoning_tokens }` - 输出令牌的详细拆分。 + 输出 token 的详细明细。 - `reasoning_tokens: number` - 推理令牌的数量。 + 推理 token 数。 - `total_tokens: number` - 所用令牌的总数。 + 使用的 token 总数。 diff --git a/docs/zh/api/reference/resources/batches/methods/cancel.md b/docs/zh/api/reference/resources/batches/methods/cancel.md index c314a57..94e3617 100644 --- a/docs/zh/api/reference/resources/batches/methods/cancel.md +++ b/docs/zh/api/reference/resources/batches/methods/cancel.md @@ -1,10 +1,10 @@ -> 完整文档索引请参阅 [llms.txt](/llms.txt)。可通过在页面 URL 末尾添加 `.md` 获取文档页面的 Markdown 版本。 +> 完整文档索引请参阅 [llms.txt](/llms.txt)。可通过在页面 URL 末尾追加 `.md` 来获取文档页面的 Markdown 版本。 ## 取消批处理 **post** `/batches/{batch_id}/cancel` -取消进行中的批次。该批次将处于 `cancelling` 状态最多 10 分钟,之后变为 `cancelled`,届时输出文件中将包含部分结果(如果有)。 +取消正在进行的批量任务。批量任务将处于 `cancelling` 状态最长 10 分钟,然后变为 `cancelled`,状态,届时其输出文件中将提供部分结果(如果有)。 ### 路径参数 @@ -18,19 +18,19 @@ - `completion_window: string` - 批次应在此时间范围内完成。 + 应在该时间窗口内处理该批量任务。 - `created_at: number` - 批次创建时的 Unix 时间戳(以秒为单位)。 + 批量任务创建时的 Unix 时间戳(以秒为单位)。 - `endpoint: string` - 批次所使用的 OpenAI API 端点。 + 该批量任务所使用的 OpenAI API 端点。 - `input_file_id: string` - 批次输入文件的 ID。 + 该批量任务的输入文件 ID。 - `object: "batch"` @@ -40,7 +40,7 @@ - `status: "validating" or "failed" or "in_progress" or 5 more` - 批次的当前状态。 + 该批量任务的当前状态。 - `"validating"` @@ -60,19 +60,19 @@ - `cancelled_at: optional number` - 批次被取消时的 Unix 时间戳(以秒为单位)。 + 批量任务被取消时的 Unix 时间戳(以秒为单位)。 - `cancelling_at: optional number` - 批次开始取消时的 Unix 时间戳(以秒为单位)。 + 批量任务开始取消时的 Unix 时间戳(以秒为单位)。 - `completed_at: optional number` - 批次完成时的 Unix 时间戳(以秒为单位)。 + 批量任务完成时的 Unix 时间戳(以秒为单位)。 - `error_file_id: optional string` - 包含出错请求输出内容的文件 ID。 + 包含出错请求输出的文件 ID。 - `errors: optional object { data, object }` @@ -84,15 +84,15 @@ - `line: optional number or null` - 发生错误的输入文件所在行号(若适用)。 + 发生错误的输入文件行号(如果适用)。 - `message: optional string` - 提供更多错误详情的人类可读消息。 + 提供有关错误更多详情的人工可读消息。 - `param: optional string or null` - 导致错误的参数名称(若适用)。 + 导致错误的参数名称(如果适用)。 - `object: optional string` @@ -100,43 +100,43 @@ - `expired_at: optional number` - 批次过期时的 Unix 时间戳(以秒为单位)。 + 批量任务过期时的 Unix 时间戳(以秒为单位)。 - `expires_at: optional number` - 批次将过期时的 Unix 时间戳(以秒为单位)。 + 批量任务将要过期的 Unix 时间戳(以秒为单位)。 - `failed_at: optional number` - 批次失败时的 Unix 时间戳(以秒为单位)。 + 批量任务失败时的 Unix 时间戳(以秒为单位)。 - `finalizing_at: optional number` - 批次开始完成(finalizing)时的 Unix 时间戳(以秒为单位)。 + 批量任务开始终态化时的 Unix 时间戳(以秒为单位)。 - `in_progress_at: optional number` - 批次开始处理时的 Unix 时间戳(以秒为单位)。 + 批量任务开始处理时的 Unix 时间戳(以秒为单位)。 - `metadata: optional Metadata or null` - 可附加到对象的 16 组键值对。可用于 - 用于以结构化方式存储有关对象的附加信息, - 格式,以及通过 API 或控制台查询对象。 + 可附加到对象的 16 个键值对。这可以 + 可用于以结构化格式存储关于对象的附加信息,并通过 API 或仪表板查询对象。 + 通过 接口 或仪表板查询对象。 - 键是字符串,最大长度为 64 个字符。值是字符串 + 键是字符串,最大长度为 64 个字符。值是字符串,最大长度为 512 个字符。 最大长度为 512 个字符。 - `model: optional string` - 用于处理该批次的模型 ID,例如 `gpt-5-2025-08-07`。OpenAI - 提供多种具有不同能力、性能 - 特征和价位的模型。请参阅 [模型 - 指南](/docs/models) 浏览和比较可用的模型。 + 用于处理该批次的模型 ID,例如 `gpt-5.6-sol`。OpenAI + 提供了多种具有不同能力、性能特征和定价的模型。请参阅 + 模型 [指南 + 指南](/docs/models) 以浏览和比较可用的模型。 - `output_file_id: optional string` - 包含已成功执行请求输出内容的文件 ID。 + 包含已成功执行请求输出的文件的 ID。 - `request_counts: optional BatchRequestCounts` @@ -156,9 +156,9 @@ - `usage: optional BatchUsage` - 表示 token 使用详情,包括输入 token、输出 token、输出 - token 的细分以及所使用的 token 总数。仅在 - 2025 年 9 月 7 日之后创建的批次中填充。 + 表示 token 使用详情,包括输入 token、输出 token、输出 token 的细分以及使用的总 token。仅在 + 总 token。仅在 2025 年 9 月 7 日之后创建的批次上填充。 + 2025 年 9 月 7 日之后创建的批次上填充。 - `input_tokens: number` @@ -166,12 +166,12 @@ - `input_tokens_details: object { cached_tokens }` - 输入令牌的详细分解。 + 输入令牌的详细明细。 - `cached_tokens: number` 从缓存中检索到的令牌数量。 [了解更多 - 提示词缓存](/docs/guides/prompt-caching). + 提示缓存](/docs/guides/prompt-caching). - `output_tokens: number` @@ -179,7 +179,7 @@ - `output_tokens_details: object { reasoning_tokens }` - 输出令牌的详细分解。 + 输出令牌的详细明细。 - `reasoning_tokens: number` diff --git a/docs/zh/api/reference/resources/batches/methods/create.md b/docs/zh/api/reference/resources/batches/methods/create.md index fdb8056..ba70acc 100644 --- a/docs/zh/api/reference/resources/batches/methods/create.md +++ b/docs/zh/api/reference/resources/batches/methods/create.md @@ -1,22 +1,22 @@ -> 如需查看完整文档索引,请参阅 [llms.txt](/llms.txt)。可通过在页面 URL 末尾添加 `.md` 来获取该页面的 Markdown 版本。 +> 如需查看完整文档索引,请参阅 [llms.txt](/llms.txt)。文档页面的 Markdown 版本可通过在页面 URL 末尾添加 `.md` 获取。 -## Create batch +## 创建批量任务 **post** `/batches` -根据已上传的请求文件创建并执行批次 +根据已上传的请求文件创建并执行批量任务 ### 请求体参数 - `completion_window: "24h"` - 批量任务应在此时间窗口内被处理。目前仅支持 `24h` 。 + 批处理应在该时间范围内完成。目前仅支持 `24h` 。 - `"24h"` - `endpoint: "/v1/responses" or "/v1/chat/completions" or "/v1/embeddings" or 5 more` - 批量中所有请求所使用的端点。目前支持 `/v1/responses`, `/v1/chat/completions`, `/v1/embeddings`, `/v1/completions`, `/v1/moderations`, `/v1/images/generations`, `/v1/images/edits`,和 `/v1/videos` 。请注意, `/v1/embeddings` 批量还限制批量中所有请求的嵌入输入总数不得超过 50,000 个。 + 用于批处理中所有请求的端点。目前支持 `/v1/responses`, `/v1/chat/completions`, `/v1/embeddings`, `/v1/completions`, `/v1/moderations`, `/v1/images/generations`, `/v1/images/edits`,和 `/v1/videos` 。请注意, `/v1/embeddings` 批次在所有请求中最多也限制为 50,000 个嵌入输入。 - `"/v1/responses"` @@ -36,34 +36,34 @@ - `input_file_id: string` - 已上传文件的 ID,其中包含新批量的请求。 + 已上传文件的 ID,其中包含新批次的请求。 请参阅 [上传文件](/docs/api-reference/files/create) 了解如何上传文件。 - 你的输入文件必须以 [JSONL 文件](/docs/api-reference/batch/request-input),格式进行格式化,并且必须以用途 `batch`。进行上传。该文件最多可包含 50,000 个请求,文件大小可达 200 MB。 + 你的输入文件必须格式化为 [JSONL 文件](/docs/api-reference/batch/request-input),并且必须以 purpose 为 `batch`。上传。该文件最多可包含 50,000 个请求,文件大小最大可达 200 MB。 - `metadata: optional Metadata or null` - 可附加到对象的 16 个键值对集合。这可用于 - 以结构化格式存储对象的附加信息,并通过 API 或仪表板查询对象。 - 格式,以及通过 接口 或仪表板查询对象。 + 可附加到对象的 16 个键值对。这对于以结构化 + 格式存储有关对象的附加信息,并通过 API 或仪表板查询对象非常有用。 + 格式存储有关对象的附加信息,并通过 接口 或仪表板查询对象非常有用。 - 键为字符串,最大长度为 64 个字符。值为字符串 - ,最大长度为 512 个字符。 + 键为字符串,最大长度为 64 个字符。值为字符串, + 最大长度为 512 个字符。 - `output_expires_after: optional object { anchor, seconds }` - 为批量生成的输出文件和/或错误文件的过期策略。 + 为批次生成的输出和/或错误文件的过期策略。 - `anchor: "created_at"` - 过期策略所基于的锚点时间戳。支持以下锚点: `created_at`。请注意,该锚点是文件创建时间,而不是批处理任务的创建时间。 + 过期策略适用的锚定时间戳。支持以下锚点: `created_at`。注意,锚点是文件创建时间,而不是批处理创建时间。 - `"created_at"` - `seconds: number` - 锚点时间之后文件过期的秒数。必须介于 3600(1 小时)到 2592000(30 天)之间。 + 文件在锚点时间之后过期的秒数。必须介于 3600(1 小时)和 2592000(30 天)之间。 ### Returns @@ -73,19 +73,19 @@ - `completion_window: string` - 批量应在此时间范围内被处理。 + 批量应在此时间范围内完成处理。 - `created_at: number` - 批量创建时的 Unix 时间戳(以秒为单位)。 + 批量创建时的 Unix 时间戳(秒)。 - `endpoint: string` - 该批量所使用的 OpenAI API 端点。 + 批量使用的 OpenAI API 端点。 - `input_file_id: string` - 该批量的输入文件 ID。 + 批量输入文件的 ID。 - `object: "batch"` @@ -95,7 +95,7 @@ - `status: "validating" or "failed" or "in_progress" or 5 more` - 该批量的当前状态。 + 批量的当前状态。 - `"validating"` @@ -115,19 +115,19 @@ - `cancelled_at: optional number` - 批量被取消时的 Unix 时间戳(以秒为单位)。 + 批量被取消时的 Unix 时间戳(秒)。 - `cancelling_at: optional number` - 批量开始取消时的 Unix 时间戳(以秒为单位)。 + 批量开始取消时的 Unix 时间戳(秒)。 - `completed_at: optional number` - 批量已完成时的 Unix 时间戳(以秒为单位)。 + 批量完成时的 Unix 时间戳(秒)。 - `error_file_id: optional string` - 包含出错请求输出的文件 ID。 + 包含错误请求输出的文件 ID。 - `errors: optional object { data, object }` @@ -139,15 +139,15 @@ - `line: optional number or null` - 如适用,错误发生时输入文件中的行号。 + 发生错误的输入文件行号(如果适用)。 - `message: optional string` - 提供有关错误更多详情的人工可读消息。 + 提供有关错误更多详细信息的人类可读消息。 - `param: optional string or null` - 如适用,导致该错误的参数名称。 + 导致错误的参数名称(如果适用)。 - `object: optional string` @@ -155,47 +155,47 @@ - `expired_at: optional number` - 批量已过期时的 Unix 时间戳(以秒为单位)。 + 批量过期时的 Unix 时间戳(秒)。 - `expires_at: optional number` - 批量将过期时的 Unix 时间戳(以秒为单位)。 + 批量将要过期时的 Unix 时间戳(秒)。 - `failed_at: optional number` - 批量失败时的 Unix 时间戳(以秒为单位)。 + 批量失败时的 Unix 时间戳(秒)。 - `finalizing_at: optional number` - 批量开始完成时的 Unix 时间戳(以秒为单位)。 + 批量开始终结时的 Unix 时间戳(秒)。 - `in_progress_at: optional number` - 批量开始处理时的 Unix 时间戳(以秒为单位)。 + 批量开始处理时的 Unix 时间戳(秒)。 - `metadata: optional Metadata or null` - 可附加到对象的 16 个键值对集合。这可用于 - 以结构化格式存储对象的附加信息,并通过 API 或仪表板查询对象。 - 格式,以及通过 接口 或仪表板查询对象。 + 可附加到对象的 16 个键值对。这对于以结构化 + 格式存储有关对象的附加信息,并通过 API 或仪表板查询对象非常有用。 + 格式存储有关对象的附加信息,并通过 接口 或仪表板查询对象非常有用。 - 键为字符串,最大长度为 64 个字符。值为字符串 - ,最大长度为 512 个字符。 + 键为字符串,最大长度为 64 个字符。值为字符串, + 最大长度为 512 个字符。 - `model: optional string` - 用于处理该批量的模型 ID,例如 `gpt-5-2025-08-07`。OpenAI - 提供多种不同能力、性能 - 特性和价位的模型。请参阅 [模型 - 指南](/docs/models) 以浏览和比较可用的模型。 + 用于处理批量的模型 ID,例如 `gpt-5.6-sol`. OpenAI + 提供各种能力、性能 + 特性和价位各异的模型。参考 [模型 + 指南](/docs/models) 以查看和对比可用模型。 - `output_file_id: optional string` - 包含已成功执行请求输出内容的文件 ID。 + 包含成功执行请求输出的文件 ID。 - `request_counts: optional BatchRequestCounts` - 该批次中不同状态的请求计数。 + 该批次中不同状态对应的请求计数。 - `completed: number` @@ -211,30 +211,30 @@ - `usage: optional BatchUsage` - 表示令牌使用详情,包括输入令牌、输出令牌、 - 输出令牌的细分以及使用的令牌总数。仅在 + 表示 token 使用详情,包括输入 token、输出 token、 + 输出 token 的明细以及所使用的总 token。仅在 2025 年 9 月 7 日之后创建的批次上填充。 - `input_tokens: number` - 输入令牌的数量。 + 输入 token 的数量。 - `input_tokens_details: object { cached_tokens }` - 输入令牌的详细细分。 + 输入 token 的详细明细。 - `cached_tokens: number` - 从缓存中检索到的令牌数量。 [详细了解 - 提示缓存](/docs/guides/prompt-caching). + 从缓存中检索到的 token 数量。 [详细了解 + 提示词缓存](/docs/guides/prompt-caching). - `output_tokens: number` - 输出令牌的数量。 + 输出 token 的数量。 - `output_tokens_details: object { reasoning_tokens }` - 输出 token 的详细明细。 + 输出 token 的详细分类统计。 - `reasoning_tokens: number` @@ -242,7 +242,7 @@ - `total_tokens: number` - 使用的 token 总数。 + 已使用的 token 总数。 ### 示例 diff --git a/docs/zh/api/reference/resources/batches/methods/list.md b/docs/zh/api/reference/resources/batches/methods/list.md index a1c6a19..50a7488 100644 --- a/docs/zh/api/reference/resources/batches/methods/list.md +++ b/docs/zh/api/reference/resources/batches/methods/list.md @@ -1,4 +1,4 @@ -> 如需完整文档索引,请参阅 [llms.txt](/llms.txt)。在页面 URL 后追加 `.md` 即可获取该页面的 Markdown 版本。 +> 完整文档索引请参见 [llms.txt](/llms.txt)。可通过在页面 URL 末尾附加 `.md` 来获取文档页面的 Markdown 版本。 ## 列出批次 @@ -10,11 +10,11 @@ - `after: optional string` - 用于分页游标的对象 ID。 `after` 是一个对象 ID,用于定义你在列表中的位置。例如,如果你发起一次列表请求并收到 100 个对象,以 obj_foo 结尾,那么你的下一次调用可以在 after 参数中传入 obj_foo,以获取列表的下一页。 + 用于分页游标。 `after` 是一个对象 ID,用于定义你在列表中的位置。例如,如果你发起列表请求并收到 100 个对象,以 obj_foo 结尾,你的后续调用可以包含 after=obj_foo 以获取列表的下一页。 - `limit: optional number` - 返回对象数量的上限。范围为 1 到 100,默认值为 20。 + 返回对象数量的上限。Limit 的取值范围为 1 到 100,默认值为 20。 ### Returns @@ -24,19 +24,19 @@ - `completion_window: string` - 批处理应在该时间范围内完成。 + 应在此时间范围内处理该批量任务。 - `created_at: number` - 批处理创建时的 Unix 时间戳(单位:秒)。 + 批量任务创建时的 Unix 时间戳(单位:秒)。 - `endpoint: string` - 批处理所使用的 OpenAI API 端点。 + 批量任务所使用的 OpenAI API 端点。 - `input_file_id: string` - 批处理输入文件的 ID。 + 批量任务的输入文件 ID。 - `object: "batch"` @@ -46,7 +46,7 @@ - `status: "validating" or "failed" or "in_progress" or 5 more` - 批处理的当前状态。 + 批量任务的当前状态。 - `"validating"` @@ -66,19 +66,19 @@ - `cancelled_at: optional number` - 批处理被取消时的 Unix 时间戳(单位:秒)。 + 批量任务被取消时的 Unix 时间戳(单位:秒)。 - `cancelling_at: optional number` - 批处理开始取消时的 Unix 时间戳(单位:秒)。 + 批量任务开始取消时的 Unix 时间戳(单位:秒)。 - `completed_at: optional number` - 批处理完成时的 Unix 时间戳(单位:秒)。 + 批量任务完成时的 Unix 时间戳(单位:秒)。 - `error_file_id: optional string` - 包含出错请求输出内容的文件 ID。 + 包含出错请求输出的文件 ID。 - `errors: optional object { data, object }` @@ -98,7 +98,7 @@ - `param: optional string or null` - 导致错误的参数名称(如果适用)。 + 引发错误的参数名称(如果适用)。 - `object: optional string` @@ -106,43 +106,43 @@ - `expired_at: optional number` - 批处理过期时的 Unix 时间戳(单位:秒)。 + 批量任务过期时的 Unix 时间戳(单位:秒)。 - `expires_at: optional number` - 批处理将要过期的 Unix 时间戳(单位:秒)。 + 批量任务将过期时的 Unix 时间戳(单位:秒)。 - `failed_at: optional number` - 批处理失败时的 Unix 时间戳(单位:秒)。 + 批量任务失败时的 Unix 时间戳(单位:秒)。 - `finalizing_at: optional number` - 批处理开始进入终态时的 Unix 时间戳(单位:秒)。 + 批量任务开始进入最终处理阶段时的 Unix 时间戳(单位:秒)。 - `in_progress_at: optional number` - 批处理开始处理时的 Unix 时间戳(单位:秒)。 + 批量任务开始处理时的 Unix 时间戳(单位:秒)。 - `metadata: optional Metadata or null` 可附加到对象的 16 组键值对。可用于 - 用于以结构化方式存储有关对象的附加信息, - 并通过 API 或仪表板查询对象。 + 用于以结构化格式存储对象的附加信息 + ,并通过 API 或控制台查询对象。 键为字符串,最大长度为 64 个字符。值为字符串 - 最大长度为 512 个字符。 + ,最大长度为 512 个字符。 - `model: optional string` - 用于处理该批次的模型 ID,例如 `gpt-5-2025-08-07`。OpenAI - 提供多种具有不同能力、性能 - 特性和价格的模型。请参阅 [模型 - 指南](/docs/models) 以浏览和比较可用的模型。 + 用于处理该批次的模型 ID,例如 `gpt-5.6-sol`。OpenAI + 提供多种在能力、性能特征和价位上各有不同的模型。请参阅 + 模型 [模型 + 指南](/docs/models) 以浏览并比较可用的模型。 - `output_file_id: optional string` - 包含成功执行的请求输出内容的文件 ID。 + 包含成功执行请求的输出内容的文件 ID。 - `request_counts: optional BatchRequestCounts` @@ -163,8 +163,8 @@ - `usage: optional BatchUsage` 表示令牌使用详情,包括输入令牌、输出令牌、 - 输出令牌的细分以及所使用的总令牌。仅在 - 2025-09-07 之后创建的批次上填充。 + 输出令牌的细分以及使用的令牌总数。仅在 + 2025 年 9 月 7 日之后创建的批次中填充。 - `input_tokens: number` @@ -172,12 +172,12 @@ - `input_tokens_details: object { cached_tokens }` - 输入令牌的详细分类统计。 + 输入令牌的详细分类。 - `cached_tokens: number` 从缓存中检索到的令牌数量。 [了解更多 - 提示缓存](/docs/guides/prompt-caching). + prompt caching](/docs/guides/prompt-caching). - `output_tokens: number` @@ -185,7 +185,7 @@ - `output_tokens_details: object { reasoning_tokens }` - 输出令牌的详细分类统计。 + 输出令牌的详细分类。 - `reasoning_tokens: number` @@ -212,7 +212,7 @@ curl https://api.openai.com/v1/batches \ -H "Authorization: Bearer $OPENAI_API_KEY" ``` -#### Response +#### 响应 ```json { @@ -283,7 +283,7 @@ curl https://api.openai.com/v1/batches?limit=2 \ -H "Content-Type: application/json" ``` -#### Response +#### 响应 ```json { diff --git a/docs/zh/api/reference/resources/batches/methods/retrieve.md b/docs/zh/api/reference/resources/batches/methods/retrieve.md index a1ce8ab..d7c1899 100644 --- a/docs/zh/api/reference/resources/batches/methods/retrieve.md +++ b/docs/zh/api/reference/resources/batches/methods/retrieve.md @@ -1,16 +1,16 @@ -> 完整文档索引请参阅 [llms.txt](/llms.txt)。可通过在页面 URL 末尾追加 `.md` 来获取文档页面的 Markdown 版本。 +> 如需查看完整文档索引,请参阅 [llms.txt](/llms.txt)。在页面 URL 末尾追加 `.md` 即可获取该页面的 Markdown 版本。 -## 检索批次 +## Retrieve batch **get** `/batches/{batch_id}` -检索一个批量任务。 +检索一个批次。 ### 路径参数 - `batch_id: string` -### 返回 +### 返回值 - `Batch object { id, completion_window, created_at, 19 more }` @@ -18,19 +18,19 @@ - `completion_window: string` - 批量任务应在此时间范围内完成处理。 + 批量应在此时间范围内被处理。 - `created_at: number` - 批量任务创建时的 Unix 时间戳(以秒为单位)。 + 批量创建时的 Unix 时间戳(以秒为单位)。 - `endpoint: string` - 批量任务所使用的 OpenAI API 端点。 + 该批量所使用的 OpenAI API 端点。 - `input_file_id: string` - 批量任务的输入文件 ID。 + 该批量的输入文件 ID。 - `object: "batch"` @@ -40,7 +40,7 @@ - `status: "validating" or "failed" or "in_progress" or 5 more` - 批量任务的当前状态。 + 批量当前的状态。 - `"validating"` @@ -60,19 +60,19 @@ - `cancelled_at: optional number` - 批量任务被取消时的 Unix 时间戳(以秒为单位)。 + 批量被取消时的 Unix 时间戳(以秒为单位)。 - `cancelling_at: optional number` - 批量任务开始取消时的 Unix 时间戳(以秒为单位)。 + 批量开始取消时的 Unix 时间戳(以秒为单位)。 - `completed_at: optional number` - 批量任务完成时的 Unix 时间戳(以秒为单位)。 + 批量完成时的 Unix 时间戳(以秒为单位)。 - `error_file_id: optional string` - 包含请求出错输出的文件 ID。 + 包含请求出错时所产生输出的文件 ID。 - `errors: optional object { data, object }` @@ -84,11 +84,11 @@ - `line: optional number or null` - 错误发生所在的输入文件行号(如果适用)。 + 发生错误的输入文件行号(如果适用)。 - `message: optional string` - 提供更多错误详情的人类可读消息。 + 提供有关该错误更多详细信息的人类可读消息。 - `param: optional string or null` @@ -100,43 +100,43 @@ - `expired_at: optional number` - 批量任务过期时的 Unix 时间戳(以秒为单位)。 + 批量过期时的 Unix 时间戳(以秒为单位)。 - `expires_at: optional number` - 批量任务将要过期的 Unix 时间戳(以秒为单位)。 + 批量将要过期时的 Unix 时间戳(以秒为单位)。 - `failed_at: optional number` - 批量任务失败时的 Unix 时间戳(以秒为单位)。 + 批量失败时的 Unix 时间戳(以秒为单位)。 - `finalizing_at: optional number` - 批量任务开始进入最终处理阶段的 Unix 时间戳(以秒为单位)。 + 批量开始进入最终完成阶段时的 Unix 时间戳(以秒为单位)。 - `in_progress_at: optional number` - 批量任务开始处理时的 Unix 时间戳(以秒为单位)。 + 批量开始处理时的 Unix 时间戳(以秒为单位)。 - `metadata: optional Metadata or null` - 可附加到对象的 16 组键值对。可用于 - 可用于以结构化 - 格式存储对象的附加信息,并通过 API 或控制台查询对象。 + 可附加到对象的 16 个键值对集合。可用于 + useful for storing additional information about the object in a structured + format, and querying for objects via API or the dashboard. - 键为字符串,最大长度为 64 个字符。值为字符串 - 最大长度为 512 个字符。 + Keys are strings with a maximum length of 64 characters. Values are strings + with a maximum length of 512 characters. - `model: optional string` - 用于处理该批次的模型 ID,例如 `gpt-5-2025-08-07`。OpenAI - 提供多种不同能力、性能 - 特性和价位的模型。请参阅 [模型 - 指南](/docs/models) 以浏览和比较可用模型。 + Model ID used to process the batch, like `gpt-5.6-sol`. OpenAI + offers a wide range of models with different capabilities, performance + characteristics, and price points. Refer to the [model + guide](/docs/models) to browse and compare available models. - `output_file_id: optional string` - 包含已成功执行请求的输出文件的 ID。 + 包含成功执行请求输出内容的文件 ID。 - `request_counts: optional BatchRequestCounts` @@ -156,17 +156,17 @@ - `usage: optional BatchUsage` - 表示令牌使用详情,包括输入令牌、输出令牌、 - 输出令牌的细分以及使用的令牌总数。仅在 - 2025 年 9 月 7 日之后创建的批次上填充。 + Represents token usage details including input tokens, output tokens, a + breakdown of output tokens, and the total tokens used. Only populated on + batches created after September 7, 2025. - `input_tokens: number` - 输入令牌的数量。 + 输入 token 数量。 - `input_tokens_details: object { cached_tokens }` - 输入令牌的详细明细。 + 输入令牌的详细分类。 - `cached_tokens: number` @@ -179,7 +179,7 @@ - `output_tokens_details: object { reasoning_tokens }` - 输出令牌的详细明细。 + 输出令牌的详细分类。 - `reasoning_tokens: number` diff --git a/docs/zh/api/reference/resources/beta/subresources/responses/streaming-events.md b/docs/zh/api/reference/resources/beta/subresources/responses/streaming-events.md index b2323b3..e97df03 100644 --- a/docs/zh/api/reference/resources/beta/subresources/responses/streaming-events.md +++ b/docs/zh/api/reference/resources/beta/subresources/responses/streaming-events.md @@ -1,21 +1,21 @@ # Beta Responses 流式事件 -> 如需完整文档索引,请参阅 [llms.txt](/llms.txt)。文档页面的 Markdown 版本可通过在页面 URL 后追加 `.md` 获取。 +> 如需查看完整的文档索引,请参阅 [llms.txt](/llms.txt)。在页面 URL 末尾追加 `.md` 即可获得文档页面的 Markdown 版本。 -当你 [创建 Response](https://developers.openai.com/docs/api-reference/responses/create) 时,如果 -`stream` 设置为 `true`,服务器会在 Response 生成过程中向 -客户端发送服务端事件。本节列出了服务器所发出的事件。 -由服务器发送的事件包括: +当你 [创建 Response](https://developers.openai.com/docs/api-reference/responses/create) 时 +`stream` 设置为 `true`,服务器会向客户端发送服务端发送事件 +(server-sent events),在 Response 生成过程中推送。本节包含服务器 +所发送的事件。 -[了解流式 Response 的更多信息](https://developers.openai.com/docs/guides/streaming-responses?api-mode=responses). +[了解有关流式响应的更多信息](https://developers.openai.com/docs/guides/streaming-responses?api-mode=responses). ## response.created -当响应被创建时发出的事件。 +在响应创建时发出的事件。 ### Schema -Schema name: `BetaResponseCreatedEvent` +Schema 名称: `BetaResponseCreatedEvent` ```json { @@ -1108,7 +1108,7 @@ Schema name: `BetaResponseCreatedEvent` "oasRef": "#/components/schemas/BetaResponseProperties/properties/model", "deprecated": false, "key": "model", - "docstring": "Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", + "docstring": "Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/BetaResponseProperties/properties/model", @@ -1532,7 +1532,7 @@ Schema name: `BetaResponseCreatedEvent` ] }, "examples": [ - "gpt-5.1" + "gpt-5.6-sol" ], "optional": false, "nullable": false, @@ -2338,7 +2338,7 @@ Schema name: `BetaResponseCreatedEvent` "oasRef": "#/components/schemas/BetaResponse/allOf/2/properties/reasoning", "deprecated": false, "key": "reasoning", - "docstring": "**gpt-5 and o-series models only**\n\nConfiguration options for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\n", + "docstring": "Configuration options for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\n", "title": "Reasoning", "type": { "kind": "HttpTypeObject", @@ -3860,7 +3860,7 @@ Schema name: `BetaResponseCreatedEvent` }, "(resource) beta.responses > (model) beta_response > (schema) > (property) model > (variant) 0": { "kind": "HttpDeclTypeAlias", - "docstring": "Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", + "docstring": "Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", @@ -64208,7 +64208,7 @@ Schema name: `BetaResponseCreatedEvent` "incomplete_details": null, "instructions": null, "max_output_tokens": null, - "model": "gpt-4o-2024-08-06", + "model": "gpt-5.6-sol", "output": [], "parallel_tool_calls": true, "previous_response_id": null, @@ -64237,11 +64237,11 @@ Schema name: `BetaResponseCreatedEvent` ## response.in_progress -当响应进行中时发出。 +当响应正在进行时发出。 ### Schema -Schema name: `BetaResponseInProgressEvent` +Schema 名称: `BetaResponseInProgressEvent` ```json { @@ -65334,7 +65334,7 @@ Schema name: `BetaResponseInProgressEvent` "oasRef": "#/components/schemas/BetaResponseProperties/properties/model", "deprecated": false, "key": "model", - "docstring": "Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", + "docstring": "Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/BetaResponseProperties/properties/model", @@ -65758,7 +65758,7 @@ Schema name: `BetaResponseInProgressEvent` ] }, "examples": [ - "gpt-5.1" + "gpt-5.6-sol" ], "optional": false, "nullable": false, @@ -66564,7 +66564,7 @@ Schema name: `BetaResponseInProgressEvent` "oasRef": "#/components/schemas/BetaResponse/allOf/2/properties/reasoning", "deprecated": false, "key": "reasoning", - "docstring": "**gpt-5 and o-series models only**\n\nConfiguration options for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\n", + "docstring": "Configuration options for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\n", "title": "Reasoning", "type": { "kind": "HttpTypeObject", @@ -68086,7 +68086,7 @@ Schema name: `BetaResponseInProgressEvent` }, "(resource) beta.responses > (model) beta_response > (schema) > (property) model > (variant) 0": { "kind": "HttpDeclTypeAlias", - "docstring": "Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", + "docstring": "Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", @@ -128434,7 +128434,7 @@ Schema name: `BetaResponseInProgressEvent` "incomplete_details": null, "instructions": null, "max_output_tokens": null, - "model": "gpt-4o-2024-08-06", + "model": "gpt-5.6-sol", "output": [], "parallel_tool_calls": true, "previous_response_id": null, @@ -128467,7 +128467,7 @@ Schema name: `BetaResponseInProgressEvent` ### Schema -Schema name: `BetaResponseCompletedEvent` +Schema 名称: `BetaResponseCompletedEvent` ```json { @@ -129560,7 +129560,7 @@ Schema name: `BetaResponseCompletedEvent` "oasRef": "#/components/schemas/BetaResponseProperties/properties/model", "deprecated": false, "key": "model", - "docstring": "Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", + "docstring": "Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/BetaResponseProperties/properties/model", @@ -129984,7 +129984,7 @@ Schema name: `BetaResponseCompletedEvent` ] }, "examples": [ - "gpt-5.1" + "gpt-5.6-sol" ], "optional": false, "nullable": false, @@ -130790,7 +130790,7 @@ Schema name: `BetaResponseCompletedEvent` "oasRef": "#/components/schemas/BetaResponse/allOf/2/properties/reasoning", "deprecated": false, "key": "reasoning", - "docstring": "**gpt-5 and o-series models only**\n\nConfiguration options for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\n", + "docstring": "Configuration options for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\n", "title": "Reasoning", "type": { "kind": "HttpTypeObject", @@ -132312,7 +132312,7 @@ Schema name: `BetaResponseCompletedEvent` }, "(resource) beta.responses > (model) beta_response > (schema) > (property) model > (variant) 0": { "kind": "HttpDeclTypeAlias", - "docstring": "Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", + "docstring": "Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", @@ -192661,7 +192661,7 @@ Schema name: `BetaResponseCompletedEvent` "input": [], "instructions": null, "max_output_tokens": null, - "model": "gpt-4o-mini-2024-07-18", + "model": "gpt-5.6-sol", "output": [ { "id": "msg_123", @@ -192706,11 +192706,11 @@ Schema name: `BetaResponseCompletedEvent` ## response.failed -当响应失败时发出的事件。 +在响应失败时发出的事件。 ### Schema -Schema name: `BetaResponseFailedEvent` +Schema 名称: `BetaResponseFailedEvent` ```json { @@ -193803,7 +193803,7 @@ Schema name: `BetaResponseFailedEvent` "oasRef": "#/components/schemas/BetaResponseProperties/properties/model", "deprecated": false, "key": "model", - "docstring": "Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", + "docstring": "Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/BetaResponseProperties/properties/model", @@ -194227,7 +194227,7 @@ Schema name: `BetaResponseFailedEvent` ] }, "examples": [ - "gpt-5.1" + "gpt-5.6-sol" ], "optional": false, "nullable": false, @@ -195033,7 +195033,7 @@ Schema name: `BetaResponseFailedEvent` "oasRef": "#/components/schemas/BetaResponse/allOf/2/properties/reasoning", "deprecated": false, "key": "reasoning", - "docstring": "**gpt-5 and o-series models only**\n\nConfiguration options for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\n", + "docstring": "Configuration options for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\n", "title": "Reasoning", "type": { "kind": "HttpTypeObject", @@ -196555,7 +196555,7 @@ Schema name: `BetaResponseFailedEvent` }, "(resource) beta.responses > (model) beta_response > (schema) > (property) model > (variant) 0": { "kind": "HttpDeclTypeAlias", - "docstring": "Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", + "docstring": "Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", @@ -256906,7 +256906,7 @@ Schema name: `BetaResponseFailedEvent` "incomplete_details": null, "instructions": null, "max_output_tokens": null, - "model": "gpt-4o-mini-2024-07-18", + "model": "gpt-5.6-sol", "output": [], "previous_response_id": null, "reasoning_effort": null, @@ -256930,11 +256930,11 @@ Schema name: `BetaResponseFailedEvent` ## response.incomplete -当响应未完成结束时发出的事件。 +当响应未完成时发出的事件。 ### Schema -Schema name: `BetaResponseIncompleteEvent` +Schema 名称: `BetaResponseIncompleteEvent` ```json { @@ -258027,7 +258027,7 @@ Schema name: `BetaResponseIncompleteEvent` "oasRef": "#/components/schemas/BetaResponseProperties/properties/model", "deprecated": false, "key": "model", - "docstring": "Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", + "docstring": "Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/BetaResponseProperties/properties/model", @@ -258451,7 +258451,7 @@ Schema name: `BetaResponseIncompleteEvent` ] }, "examples": [ - "gpt-5.1" + "gpt-5.6-sol" ], "optional": false, "nullable": false, @@ -259257,7 +259257,7 @@ Schema name: `BetaResponseIncompleteEvent` "oasRef": "#/components/schemas/BetaResponse/allOf/2/properties/reasoning", "deprecated": false, "key": "reasoning", - "docstring": "**gpt-5 and o-series models only**\n\nConfiguration options for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\n", + "docstring": "Configuration options for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\n", "title": "Reasoning", "type": { "kind": "HttpTypeObject", @@ -260779,7 +260779,7 @@ Schema name: `BetaResponseIncompleteEvent` }, "(resource) beta.responses > (model) beta_response > (schema) > (property) model > (variant) 0": { "kind": "HttpDeclTypeAlias", - "docstring": "Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", + "docstring": "Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", @@ -321129,7 +321129,7 @@ Schema name: `BetaResponseIncompleteEvent` }, "instructions": null, "max_output_tokens": null, - "model": "gpt-4o-mini-2024-07-18", + "model": "gpt-5.6-sol", "output": [], "previous_response_id": null, "reasoning_effort": null, @@ -321154,11 +321154,11 @@ Schema name: `BetaResponseIncompleteEvent` ## response.output_item.added -当新增一个输出项时触发。 +添加新的输出项时触发。 ### Schema -Schema name: `BetaResponseOutputItemAddedEvent` +Schema 名称: `BetaResponseOutputItemAddedEvent` ```json { @@ -348687,11 +348687,11 @@ Schema name: `BetaResponseOutputItemAddedEvent` ## response.output_item.done -当某个输出项被标记为完成时发出。 +在某个输出项被标记为完成时触发。 ### Schema -Schema name: `BetaResponseOutputItemDoneEvent` +Schema 名称: `BetaResponseOutputItemDoneEvent` ```json { @@ -376226,11 +376226,11 @@ Schema name: `BetaResponseOutputItemDoneEvent` ## response.content_part.added -当新增内容片段时发出。 +添加新的内容部分时发出。 ### Schema -Schema name: `BetaResponseContentPartAddedEvent` +Schema 名称: `BetaResponseContentPartAddedEvent` ```json { @@ -377415,11 +377415,11 @@ Schema name: `BetaResponseContentPartAddedEvent` ## response.content_part.done -当某个内容部分完成时发出。 +当内容部分完成时发出。 ### Schema -Schema name: `BetaResponseContentPartDoneEvent` +Schema 名称: `BetaResponseContentPartDoneEvent` ```json { @@ -378604,11 +378604,11 @@ Schema name: `BetaResponseContentPartDoneEvent` ## response.output_text.delta -当出现额外的文本增量时发出。 +当存在额外的文本增量时发出。 ### Schema -Schema name: `BetaResponseTextDeltaEvent` +Schema 名称: `BetaResponseTextDeltaEvent` ```json { @@ -378933,11 +378933,11 @@ Schema name: `BetaResponseTextDeltaEvent` ## response.output_text.done -在文本内容最终确定时发出。 +当文本内容最终确定时发出。 ### Schema -Schema name: `BetaResponseTextDoneEvent` +Schema 名称: `BetaResponseTextDoneEvent` ```json { @@ -379266,7 +379266,7 @@ Schema name: `BetaResponseTextDoneEvent` ### Schema -Schema name: `BetaResponseRefusalDeltaEvent` +Schema 名称: `BetaResponseRefusalDeltaEvent` ```json { @@ -379467,11 +379467,11 @@ Schema name: `BetaResponseRefusalDeltaEvent` ## response.refusal.done -当拒绝文本确定后发出。 +当拒绝文本最终确定时发出。 ### Schema -Schema name: `BetaResponseRefusalDoneEvent` +Schema 名称: `BetaResponseRefusalDoneEvent` ```json { @@ -379672,11 +379672,11 @@ Schema name: `BetaResponseRefusalDoneEvent` ## response.function_call_arguments.delta -当存在部分函数调用参数的增量时触发。 +当存在部分函数调用参数的增量时发出。 ### Schema -Schema name: `BetaResponseFunctionCallArgumentsDeltaEvent` +Schema 名称: `BetaResponseFunctionCallArgumentsDeltaEvent` ```json { @@ -379862,7 +379862,7 @@ Schema name: `BetaResponseFunctionCallArgumentsDeltaEvent` ### Schema -Schema name: `BetaResponseFunctionCallArgumentsDoneEvent` +Schema 名称: `BetaResponseFunctionCallArgumentsDoneEvent` ```json { @@ -380066,7 +380066,7 @@ Schema name: `BetaResponseFunctionCallArgumentsDoneEvent` ### Schema -Schema name: `BetaResponseFileSearchCallInProgressEvent` +Schema 名称: `BetaResponseFileSearchCallInProgressEvent` ```json { @@ -380229,11 +380229,11 @@ Schema name: `BetaResponseFileSearchCallInProgressEvent` ## response.file_search_call.searching -在文件搜索正在执行搜索时发出。 +在 文件搜索 当前正在执行搜索时发出。 ### Schema -Schema name: `BetaResponseFileSearchCallSearchingEvent` +Schema 名称: `BetaResponseFileSearchCallSearchingEvent` ```json { @@ -380396,11 +380396,11 @@ Schema name: `BetaResponseFileSearchCallSearchingEvent` ## response.file_search_call.completed -当文件搜索调用完成(找到结果)时发出。 +当一次文件搜索调用完成(已找到结果)时发出。 ### Schema -Schema name: `BetaResponseFileSearchCallCompletedEvent` +Schema 名称: `BetaResponseFileSearchCallCompletedEvent` ```json { @@ -380567,7 +380567,7 @@ Schema name: `BetaResponseFileSearchCallCompletedEvent` ### Schema -Schema name: `BetaResponseWebSearchCallInProgressEvent` +Schema 名称: `BetaResponseWebSearchCallInProgressEvent` ```json { @@ -380730,11 +380730,11 @@ Schema name: `BetaResponseWebSearchCallInProgressEvent` ## response.web_search_call.searching -当 网页搜索 调用正在执行时发出。 +在执行网页搜索调用时发出。 ### Schema -Schema name: `BetaResponseWebSearchCallSearchingEvent` +Schema 名称: `BetaResponseWebSearchCallSearchingEvent` ```json { @@ -380901,7 +380901,7 @@ Schema name: `BetaResponseWebSearchCallSearchingEvent` ### Schema -Schema name: `BetaResponseWebSearchCallCompletedEvent` +Schema 名称: `BetaResponseWebSearchCallCompletedEvent` ```json { @@ -381064,11 +381064,11 @@ Schema name: `BetaResponseWebSearchCallCompletedEvent` ## response.reasoning_summary_part.added -当新增一个推理摘要部分时发出。 +当新增一个推理摘要片段时触发。 ### Schema -Schema name: `BetaResponseReasoningSummaryPartAddedEvent` +Schema 名称: `BetaResponseReasoningSummaryPartAddedEvent` ```json { @@ -381329,11 +381329,11 @@ Schema name: `BetaResponseReasoningSummaryPartAddedEvent` ## response.reasoning_summary_part.done -当某个推理摘要部分完成时触发。 +当推理摘要部分完成时发出。 ### Schema -Schema name: `BetaResponseReasoningSummaryPartDoneEvent` +Schema 名称: `BetaResponseReasoningSummaryPartDoneEvent` ```json { @@ -381633,7 +381633,7 @@ Schema name: `BetaResponseReasoningSummaryPartDoneEvent` ### Schema -Schema name: `BetaResponseReasoningSummaryTextDeltaEvent` +Schema 名称: `BetaResponseReasoningSummaryTextDeltaEvent` ```json { @@ -381834,11 +381834,11 @@ Schema name: `BetaResponseReasoningSummaryTextDeltaEvent` ## response.reasoning_summary_text.done -当推理摘要文本完成时触发。 +当推理摘要文本完成时发出。 ### Schema -Schema name: `BetaResponseReasoningSummaryTextDoneEvent` +Schema 名称: `BetaResponseReasoningSummaryTextDoneEvent` ```json { @@ -382039,11 +382039,11 @@ Schema name: `BetaResponseReasoningSummaryTextDoneEvent` ## response.reasoning_text.delta -当向推理文本添加增量时发出。 +在向推理文本添加增量时发出。 ### Schema -Schema name: `BetaResponseReasoningTextDeltaEvent` +Schema 名称: `BetaResponseReasoningTextDeltaEvent` ```json { @@ -382244,11 +382244,11 @@ Schema name: `BetaResponseReasoningTextDeltaEvent` ## response.reasoning_text.done -在推理文本完成时发出。 +当一段推理文本完成时发出。 ### Schema -Schema name: `BetaResponseReasoningTextDoneEvent` +Schema 名称: `BetaResponseReasoningTextDoneEvent` ```json { @@ -382449,11 +382449,11 @@ Schema name: `BetaResponseReasoningTextDoneEvent` ## response.image_generation_call.completed -当图像生成工具调用完成且最终图像可用时发出。 +当图片生成工具调用完成且最终图片可用时触发。 ### Schema -Schema name: `BetaResponseImageGenCallCompletedEvent` +Schema 名称: `BetaResponseImageGenCallCompletedEvent` ```json { @@ -382616,11 +382616,11 @@ Schema name: `BetaResponseImageGenCallCompletedEvent` ## response.image_generation_call.generating -在图像生成工具调用正在主动生成图像时触发(中间状态)。 +当图像生成工具调用正在主动生成图像时发出(中间状态)。 ### Schema -Schema name: `BetaResponseImageGenCallGeneratingEvent` +Schema 名称: `BetaResponseImageGenCallGeneratingEvent` ```json { @@ -382783,11 +382783,11 @@ Schema name: `BetaResponseImageGenCallGeneratingEvent` ## response.image_generation_call.in_progress -当图像生成工具调用正在进行时发出。 +当图像生成工具调用进行中时发出。 ### Schema -Schema name: `BetaResponseImageGenCallInProgressEvent` +Schema 名称: `BetaResponseImageGenCallInProgressEvent` ```json { @@ -382950,11 +382950,11 @@ Schema name: `BetaResponseImageGenCallInProgressEvent` ## response.image_generation_call.partial_image -在图像生成流式传输期间,当部分图像可用时发出。 +在图像生成流式传输期间,当有部分图像可用时发出。 ### Schema -Schema name: `BetaResponseImageGenCallPartialImageEvent` +Schema 名称: `BetaResponseImageGenCallPartialImageEvent` ```json { @@ -383227,11 +383227,11 @@ Schema name: `BetaResponseImageGenCallPartialImageEvent` ## response.mcp_call_arguments.delta -在 MCP 工具调用的参数产生增量(部分更新)时发出。 +当 MCP 工具调用的参数出现增量(部分更新)时触发。 ### Schema -Schema name: `BetaResponseMCPCallArgumentsDeltaEvent` +Schema 名称: `BetaResponseMCPCallArgumentsDeltaEvent` ```json { @@ -383417,7 +383417,7 @@ Schema name: `BetaResponseMCPCallArgumentsDeltaEvent` ### Schema -Schema name: `BetaResponseMCPCallArgumentsDoneEvent` +Schema 名称: `BetaResponseMCPCallArgumentsDoneEvent` ```json { @@ -383603,7 +383603,7 @@ Schema name: `BetaResponseMCPCallArgumentsDoneEvent` ### Schema -Schema name: `BetaResponseMCPCallCompletedEvent` +Schema 名称: `BetaResponseMCPCallCompletedEvent` ```json { @@ -383770,7 +383770,7 @@ Schema name: `BetaResponseMCPCallCompletedEvent` ### Schema -Schema name: `BetaResponseMCPCallFailedEvent` +Schema 名称: `BetaResponseMCPCallFailedEvent` ```json { @@ -383933,11 +383933,11 @@ Schema name: `BetaResponseMCPCallFailedEvent` ## response.mcp_call.in_progress -在 MCP 工具调用进行时发出。 +当 MCP 工具调用进行时发出。 ### Schema -Schema name: `BetaResponseMCPCallInProgressEvent` +Schema 名称: `BetaResponseMCPCallInProgressEvent` ```json { @@ -384100,11 +384100,11 @@ Schema name: `BetaResponseMCPCallInProgressEvent` ## response.mcp_list_tools.completed -成功检索可用 MCP 工具列表时发出。 +在成功获取可用 MCP 工具列表时发出。 ### Schema -Schema name: `BetaResponseMCPListToolsCompletedEvent` +Schema 名称: `BetaResponseMCPListToolsCompletedEvent` ```json { @@ -384267,11 +384267,11 @@ Schema name: `BetaResponseMCPListToolsCompletedEvent` ## response.mcp_list_tools.failed -在尝试列出可用 MCP 工具失败时发出。 +在尝试列出可用的 MCP 工具失败时发出。 ### Schema -Schema name: `BetaResponseMCPListToolsFailedEvent` +Schema 名称: `BetaResponseMCPListToolsFailedEvent` ```json { @@ -384434,11 +384434,11 @@ Schema name: `BetaResponseMCPListToolsFailedEvent` ## response.mcp_list_tools.in_progress -当系统正在检索可用的 MCP 工具列表时触发。 +当系统正在检索可用的 MCP 工具列表时发出。 ### Schema -Schema name: `BetaResponseMCPListToolsInProgressEvent` +Schema 名称: `BetaResponseMCPListToolsInProgressEvent` ```json { @@ -384601,11 +384601,11 @@ Schema name: `BetaResponseMCPListToolsInProgressEvent` ## response.code_interpreter_call.in_progress -当代码解释器调用进行时发出。 +当代码解释器调用进行中时发出。 ### Schema -Schema name: `BetaResponseCodeInterpreterCallInProgressEvent` +Schema 名称: `BetaResponseCodeInterpreterCallInProgressEvent` ```json { @@ -384768,11 +384768,11 @@ Schema name: `BetaResponseCodeInterpreterCallInProgressEvent` ## response.code_interpreter_call.interpreting -在代码解释器正在主动解释代码片段时触发。 +在代码解释器正在主动解释代码片段时发出。 ### Schema -Schema name: `BetaResponseCodeInterpreterCallInterpretingEvent` +Schema 名称: `BetaResponseCodeInterpreterCallInterpretingEvent` ```json { @@ -384935,11 +384935,11 @@ Schema name: `BetaResponseCodeInterpreterCallInterpretingEvent` ## response.code_interpreter_call.completed -在代码解释器调用完成时发出。 +当代码解释器调用完成时触发。 ### Schema -Schema name: `BetaResponseCodeInterpreterCallCompletedEvent` +Schema 名称: `BetaResponseCodeInterpreterCallCompletedEvent` ```json { @@ -385102,11 +385102,11 @@ Schema name: `BetaResponseCodeInterpreterCallCompletedEvent` ## response.code_interpreter_call_code.delta -当代码解释器流式传输部分代码片段时发出。 +当代码解释器流式传输部分代码片段时触发。 ### Schema -Schema name: `BetaResponseCodeInterpreterCallCodeDeltaEvent` +Schema 名称: `BetaResponseCodeInterpreterCallCodeDeltaEvent` ```json { @@ -385288,11 +385288,11 @@ Schema name: `BetaResponseCodeInterpreterCallCodeDeltaEvent` ## response.code_interpreter_call_code.done -当代码片段由代码解释器最终确定时发出。 +当代码解释器完成代码片段时发出。 ### Schema -Schema name: `BetaResponseCodeInterpreterCallCodeDoneEvent` +Schema 名称: `BetaResponseCodeInterpreterCallCodeDoneEvent` ```json { @@ -385474,11 +385474,11 @@ Schema name: `BetaResponseCodeInterpreterCallCodeDoneEvent` ## response.output_text.annotation.added -当向输出文本内容添加注解时发出。 +当有标注被添加到输出文本内容时发出。 ### Schema -Schema name: `BetaResponseOutputTextAnnotationAddedEvent` +Schema 名称: `BetaResponseOutputTextAnnotationAddedEvent` ```json { @@ -386240,11 +386240,11 @@ Schema name: `BetaResponseOutputTextAnnotationAddedEvent` ## response.queued -当响应被排队并等待处理时发出。 +当响应被排队等待处理时触发。 ### Schema -Schema name: `BetaResponseQueuedEvent` +Schema 名称: `BetaResponseQueuedEvent` ```json { @@ -387337,7 +387337,7 @@ Schema name: `BetaResponseQueuedEvent` "oasRef": "#/components/schemas/BetaResponseProperties/properties/model", "deprecated": false, "key": "model", - "docstring": "Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", + "docstring": "Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/BetaResponseProperties/properties/model", @@ -387761,7 +387761,7 @@ Schema name: `BetaResponseQueuedEvent` ] }, "examples": [ - "gpt-5.1" + "gpt-5.6-sol" ], "optional": false, "nullable": false, @@ -388567,7 +388567,7 @@ Schema name: `BetaResponseQueuedEvent` "oasRef": "#/components/schemas/BetaResponse/allOf/2/properties/reasoning", "deprecated": false, "key": "reasoning", - "docstring": "**gpt-5 and o-series models only**\n\nConfiguration options for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\n", + "docstring": "Configuration options for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\n", "title": "Reasoning", "type": { "kind": "HttpTypeObject", @@ -390089,7 +390089,7 @@ Schema name: `BetaResponseQueuedEvent` }, "(resource) beta.responses > (model) beta_response > (schema) > (property) model > (variant) 0": { "kind": "HttpDeclTypeAlias", - "docstring": "Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", + "docstring": "Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", @@ -450443,7 +450443,7 @@ Schema name: `BetaResponseQueuedEvent` ### Schema -Schema name: `BetaResponseCustomToolCallInputDeltaEvent` +Schema 名称: `BetaResponseCustomToolCallInputDeltaEvent` ```json { @@ -450624,11 +450624,11 @@ Schema name: `BetaResponseCustomToolCallInputDeltaEvent` ## response.custom_tool_call_input.done -表示自定义工具调用的输入已完整的事件。 +表示自定义工具调用的输入已完成的事件。 ### Schema -Schema name: `BetaResponseCustomToolCallInputDoneEvent` +Schema 名称: `BetaResponseCustomToolCallInputDoneEvent` ```json { @@ -450809,11 +450809,11 @@ Schema name: `BetaResponseCustomToolCallInputDoneEvent` ## error -发生错误时触发。 +在发生错误时发出。 ### Schema -Schema name: `BetaResponseErrorEvent` +Schema 名称: `BetaResponseErrorEvent` ```json { @@ -450999,7 +450999,7 @@ Schema name: `BetaResponseErrorEvent` ### Schema -Schema name: `BetaResponseAudioDeltaEvent` +Schema 名称: `BetaResponseAudioDeltaEvent` ```json { @@ -451144,11 +451144,11 @@ Schema name: `BetaResponseAudioDeltaEvent` ## response.audio.done -在音频响应完成时发出。 +当音频响应完成时发出。 ### Schema -Schema name: `BetaResponseAudioDoneEvent` +Schema 名称: `BetaResponseAudioDoneEvent` ```json { @@ -451274,11 +451274,11 @@ Schema name: `BetaResponseAudioDoneEvent` ## response.audio.transcript.delta -当存在音频的部分转写文本时触发。 +当存在音频的部分转录时发出。 ### Schema -Schema name: `BetaResponseAudioTranscriptDeltaEvent` +Schema 名称: `BetaResponseAudioTranscriptDeltaEvent` ```json { @@ -451427,7 +451427,7 @@ Schema name: `BetaResponseAudioTranscriptDeltaEvent` ### Schema -Schema name: `BetaResponseAudioTranscriptDoneEvent` +Schema 名称: `BetaResponseAudioTranscriptDoneEvent` ```json { @@ -451553,11 +451553,11 @@ Schema name: `BetaResponseAudioTranscriptDoneEvent` ## response.shell_call_command.added -一个流式事件,用于指示一条 shell 命令已被添加到工具调用中。 +一个流式事件,用于指示已将 shell 命令添加到工具调用中。 ### Schema -Schema name: `BetaResponseShellCallCommandAddedStreamingEvent` +Schema 名称: `BetaResponseShellCallCommandAddedStreamingEvent` ```json { @@ -451743,11 +451743,11 @@ Schema name: `BetaResponseShellCallCommandAddedStreamingEvent` ## response.shell_call_command.delta -一个流事件,用于指示 shell 命令被增量更新。 +表示 shell 命令被增量更新的流式事件。 ### Schema -Schema name: `BetaResponseShellCallCommandDeltaStreamingEvent` +Schema 名称: `BetaResponseShellCallCommandDeltaStreamingEvent` ```json { @@ -451956,7 +451956,7 @@ Schema name: `BetaResponseShellCallCommandDeltaStreamingEvent` ### Schema -Schema name: `BetaResponseShellCallCommandDoneStreamingEvent` +Schema 名称: `BetaResponseShellCallCommandDoneStreamingEvent` ```json { @@ -452142,11 +452142,11 @@ Schema name: `BetaResponseShellCallCommandDoneStreamingEvent` ## response.shell_call_output_content.delta -一个流式事件,用于表示 shell 调用输出被增量添加。 +表示 shell 调用输出被增量添加的流式事件。 ### Schema -Schema name: `BetaResponseShellCallOutputContentDeltaStreamingEvent` +Schema 名称: `BetaResponseShellCallOutputContentDeltaStreamingEvent` ```json { @@ -452395,11 +452395,11 @@ Schema name: `BetaResponseShellCallOutputContentDeltaStreamingEvent` ## response.shell_call_output_content.done -表示 shell 调用输出已完成的流式事件。 +指示 shell 调用输出已完成的一个流事件。 ### Schema -Schema name: `BetaResponseShellCallOutputContentDoneStreamingEvent` +Schema 名称: `BetaResponseShellCallOutputContentDoneStreamingEvent` ```json { diff --git a/docs/zh/api/reference/resources/beta/subresources/responses/websocket-events.md b/docs/zh/api/reference/resources/beta/subresources/responses/websocket-events.md index f99fdcc..ca17735 100644 --- a/docs/zh/api/reference/resources/beta/subresources/responses/websocket-events.md +++ b/docs/zh/api/reference/resources/beta/subresources/responses/websocket-events.md @@ -1,6 +1,6 @@ -# WebSocket 事件 +# WebSocket events -> 完整文档索引请参阅 [llms.txt](/llms.txt). 在页面 URL 末尾附加 `.md` 即可获取该页面的 Markdown 版本。 +> 如需查看完整文档索引,请参阅 [llms.txt](/llms.txt). 文档页面的 Markdown 版本可通过在页面 URL 后追加 `.md` 获取。 通过持久化的 Responses API WebSocket 连接发送客户端事件并接收服务端事件。 [详细了解 WebSocket 模式。](https://developers.openai.com/api/docs/guides/websocket-mode) @@ -10,18 +10,18 @@ ### response.create -用于在持久 WebSocket 连接上创建响应的客户端事件。 -此 payload 使用与 `POST /v1/responses`,相同的顶层字段,以及 +用于通过持久 WebSocket 连接创建 response 的客户端事件。 +此负载使用与 `POST /v1/responses`,相同的顶层字段,外加 仅限 WebSocket 的信封元数据。 -注意: -- `stream` 在 WebSocket 上隐式生效,不应发送。 +备注: +- `stream` 在 WebSocket 上是隐式的,不应发送。 - `background` 在 WebSocket 上不支持。 - `stream_id` 仅适用于 WebSocket,不属于 `POST /v1/responses`. #### Schema -Schema name: `BetaResponsesClientEventResponseCreate` +Schema 名称: `BetaResponsesClientEventResponseCreate` ```json { @@ -1216,7 +1216,7 @@ Schema name: `BetaResponsesClientEventResponseCreate` "oasRef": "#/components/schemas/BetaResponseProperties/properties/model", "deprecated": false, "key": "model", - "docstring": "Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", + "docstring": "Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/BetaResponseProperties/properties/model", @@ -1640,7 +1640,7 @@ Schema name: `BetaResponsesClientEventResponseCreate` ] }, "examples": [ - "gpt-5.1" + "gpt-5.6-sol" ], "optional": true, "nullable": false, @@ -1833,7 +1833,7 @@ Schema name: `BetaResponsesClientEventResponseCreate` "oasRef": "#/components/schemas/BetaCreateResponse/allOf/2/properties/reasoning", "deprecated": false, "key": "reasoning", - "docstring": "**gpt-5 and o-series models only**\n\nConfiguration options for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\n", + "docstring": "Configuration options for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\n", "title": "Reasoning", "type": { "kind": "HttpTypeObject", @@ -3668,7 +3668,7 @@ Schema name: `BetaResponsesClientEventResponseCreate` }, "(resource) beta.responses > (model) beta_responses_client_event > (schema) > (variant) 0 > (property) model > (variant) 0": { "kind": "HttpDeclTypeAlias", - "docstring": "Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", + "docstring": "Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", @@ -40049,20 +40049,20 @@ Schema name: `BetaResponsesClientEventResponseCreate` { "type": "response.create", "stream_id": "agent_1", - "model": "gpt-5.5", + "model": "gpt-5.6-sol", "input": "Say hello." } ``` ### response.inject -通过 WebSocket 连接将输入项注入到活动的响应中。 -这些项会被验证并以原子方式提交。目前,服务端 -接受可恢复处于等待中的智能体的客户端拥有的工具输出。 +通过 WebSocket 连接向正在进行的响应注入输入项。 +这些项会被原子性地校验并提交。目前,服务端 +接受客户端拥有的工具输出,以恢复正在等待的智能体。 #### Schema -Schema name: `BetaResponseInjectEvent` +Schema 名称: `BetaResponseInjectEvent` ```json { @@ -68622,17 +68622,17 @@ Schema name: `BetaResponseInjectEvent` } ``` -## 服务端事件(仅 WebSocket) +## 服务端事件(仅限 WebSocket) -仅通过 Responses API WebSocket 连接发送的事件。 +仅通过 Responses API WebSocket 连接发出的事件。 ### error -在处理 Responses WebSocket 请求时发生错误时发出。 +在处理 Responses WebSocket 请求过程中发生错误时触发。 #### Schema -Schema name: `BetaResponseWsError` +Schema 名称: `BetaResponseWsError` ```json { @@ -68923,12 +68923,12 @@ Schema name: `BetaResponseWsError` ### response.inject.created -当所有注入的输入项都已校验并提交到 -当前 response 时触发。 +当所有注入的输入项都已通过校验并提交到 +当前响应时触发。 #### Schema -Schema name: `BetaResponseInjectCreatedEvent` +Schema 名称: `BetaResponseInjectCreatedEvent` ```json { @@ -69050,13 +69050,13 @@ Schema name: `BetaResponseInjectCreatedEvent` ### response.inject.failed -当注入的输入无法提交到响应时发出。该事件 -返回未提交的原始输入,以便客户端可以在另一个 -响应中酌情重试。 +当注入的输入无法提交到响应时触发。该事件 +返回未提交的原始输入,以便客户端在另一个 +响应中适时进行重试。 #### Schema -Schema name: `BetaResponseInjectFailedEvent` +Schema 名称: `BetaResponseInjectFailedEvent` ```json { @@ -97744,18 +97744,18 @@ Schema name: `BetaResponseInjectFailedEvent` } ``` -## 服务器事件 +## 服务端事件 -这些事件在 WebSocket 和 *上使用相同的负载 +这些事件在 WebSocket 和 [HTTP 流式传输](https://developers.openai.com/api/reference/resources/beta/subresources/responses/streaming-events). ### response.created -在创建响应时发出的事件。 +当响应被创建时发出的事件。 #### Schema -Schema name: `BetaResponseCreatedEvent` +Schema 名称: `BetaResponseCreatedEvent` ```json { @@ -98883,7 +98883,7 @@ Schema name: `BetaResponseCreatedEvent` "oasRef": "#/components/schemas/BetaResponseProperties/properties/model", "deprecated": false, "key": "model", - "docstring": "Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", + "docstring": "Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/BetaResponseProperties/properties/model", @@ -99307,7 +99307,7 @@ Schema name: `BetaResponseCreatedEvent` ] }, "examples": [ - "gpt-5.1" + "gpt-5.6-sol" ], "optional": false, "nullable": false, @@ -100113,7 +100113,7 @@ Schema name: `BetaResponseCreatedEvent` "oasRef": "#/components/schemas/BetaResponse/allOf/2/properties/reasoning", "deprecated": false, "key": "reasoning", - "docstring": "**gpt-5 and o-series models only**\n\nConfiguration options for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\n", + "docstring": "Configuration options for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\n", "title": "Reasoning", "type": { "kind": "HttpTypeObject", @@ -101635,7 +101635,7 @@ Schema name: `BetaResponseCreatedEvent` }, "(resource) beta.responses > (model) beta_response > (schema) > (property) model > (variant) 0": { "kind": "HttpDeclTypeAlias", - "docstring": "Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", + "docstring": "Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", @@ -161983,7 +161983,7 @@ Schema name: `BetaResponseCreatedEvent` "incomplete_details": null, "instructions": null, "max_output_tokens": null, - "model": "gpt-4o-2024-08-06", + "model": "gpt-5.6-sol", "output": [], "parallel_tool_calls": true, "previous_response_id": null, @@ -162012,11 +162012,11 @@ Schema name: `BetaResponseCreatedEvent` ### response.in_progress -在响应进行中触发。 +在响应进行中时发出。 #### Schema -Schema name: `BetaResponseInProgressEvent` +Schema 名称: `BetaResponseInProgressEvent` ```json { @@ -163144,7 +163144,7 @@ Schema name: `BetaResponseInProgressEvent` "oasRef": "#/components/schemas/BetaResponseProperties/properties/model", "deprecated": false, "key": "model", - "docstring": "Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", + "docstring": "Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/BetaResponseProperties/properties/model", @@ -163568,7 +163568,7 @@ Schema name: `BetaResponseInProgressEvent` ] }, "examples": [ - "gpt-5.1" + "gpt-5.6-sol" ], "optional": false, "nullable": false, @@ -164374,7 +164374,7 @@ Schema name: `BetaResponseInProgressEvent` "oasRef": "#/components/schemas/BetaResponse/allOf/2/properties/reasoning", "deprecated": false, "key": "reasoning", - "docstring": "**gpt-5 and o-series models only**\n\nConfiguration options for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\n", + "docstring": "Configuration options for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\n", "title": "Reasoning", "type": { "kind": "HttpTypeObject", @@ -165896,7 +165896,7 @@ Schema name: `BetaResponseInProgressEvent` }, "(resource) beta.responses > (model) beta_response > (schema) > (property) model > (variant) 0": { "kind": "HttpDeclTypeAlias", - "docstring": "Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", + "docstring": "Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", @@ -226244,7 +226244,7 @@ Schema name: `BetaResponseInProgressEvent` "incomplete_details": null, "instructions": null, "max_output_tokens": null, - "model": "gpt-4o-2024-08-06", + "model": "gpt-5.6-sol", "output": [], "parallel_tool_calls": true, "previous_response_id": null, @@ -226273,11 +226273,11 @@ Schema name: `BetaResponseInProgressEvent` ### response.completed -当模型响应完成时发出。 +在模型响应完成时发出。 #### Schema -Schema name: `BetaResponseCompletedEvent` +Schema 名称: `BetaResponseCompletedEvent` ```json { @@ -227405,7 +227405,7 @@ Schema name: `BetaResponseCompletedEvent` "oasRef": "#/components/schemas/BetaResponseProperties/properties/model", "deprecated": false, "key": "model", - "docstring": "Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", + "docstring": "Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/BetaResponseProperties/properties/model", @@ -227829,7 +227829,7 @@ Schema name: `BetaResponseCompletedEvent` ] }, "examples": [ - "gpt-5.1" + "gpt-5.6-sol" ], "optional": false, "nullable": false, @@ -228635,7 +228635,7 @@ Schema name: `BetaResponseCompletedEvent` "oasRef": "#/components/schemas/BetaResponse/allOf/2/properties/reasoning", "deprecated": false, "key": "reasoning", - "docstring": "**gpt-5 and o-series models only**\n\nConfiguration options for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\n", + "docstring": "Configuration options for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\n", "title": "Reasoning", "type": { "kind": "HttpTypeObject", @@ -230157,7 +230157,7 @@ Schema name: `BetaResponseCompletedEvent` }, "(resource) beta.responses > (model) beta_response > (schema) > (property) model > (variant) 0": { "kind": "HttpDeclTypeAlias", - "docstring": "Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", + "docstring": "Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", @@ -290506,7 +290506,7 @@ Schema name: `BetaResponseCompletedEvent` "input": [], "instructions": null, "max_output_tokens": null, - "model": "gpt-4o-mini-2024-07-18", + "model": "gpt-5.6-sol", "output": [ { "id": "msg_123", @@ -290555,7 +290555,7 @@ Schema name: `BetaResponseCompletedEvent` #### Schema -Schema name: `BetaResponseFailedEvent` +Schema 名称: `BetaResponseFailedEvent` ```json { @@ -291683,7 +291683,7 @@ Schema name: `BetaResponseFailedEvent` "oasRef": "#/components/schemas/BetaResponseProperties/properties/model", "deprecated": false, "key": "model", - "docstring": "Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", + "docstring": "Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/BetaResponseProperties/properties/model", @@ -292107,7 +292107,7 @@ Schema name: `BetaResponseFailedEvent` ] }, "examples": [ - "gpt-5.1" + "gpt-5.6-sol" ], "optional": false, "nullable": false, @@ -292913,7 +292913,7 @@ Schema name: `BetaResponseFailedEvent` "oasRef": "#/components/schemas/BetaResponse/allOf/2/properties/reasoning", "deprecated": false, "key": "reasoning", - "docstring": "**gpt-5 and o-series models only**\n\nConfiguration options for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\n", + "docstring": "Configuration options for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\n", "title": "Reasoning", "type": { "kind": "HttpTypeObject", @@ -294435,7 +294435,7 @@ Schema name: `BetaResponseFailedEvent` }, "(resource) beta.responses > (model) beta_response > (schema) > (property) model > (variant) 0": { "kind": "HttpDeclTypeAlias", - "docstring": "Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", + "docstring": "Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", @@ -354786,7 +354786,7 @@ Schema name: `BetaResponseFailedEvent` "incomplete_details": null, "instructions": null, "max_output_tokens": null, - "model": "gpt-4o-mini-2024-07-18", + "model": "gpt-5.6-sol", "output": [], "previous_response_id": null, "reasoning_effort": null, @@ -354810,11 +354810,11 @@ Schema name: `BetaResponseFailedEvent` ### response.incomplete -当响应以不完整状态结束时发出的事件。 +当响应以未完成状态结束时发出的事件。 #### Schema -Schema name: `BetaResponseIncompleteEvent` +Schema 名称: `BetaResponseIncompleteEvent` ```json { @@ -355942,7 +355942,7 @@ Schema name: `BetaResponseIncompleteEvent` "oasRef": "#/components/schemas/BetaResponseProperties/properties/model", "deprecated": false, "key": "model", - "docstring": "Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", + "docstring": "Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/BetaResponseProperties/properties/model", @@ -356366,7 +356366,7 @@ Schema name: `BetaResponseIncompleteEvent` ] }, "examples": [ - "gpt-5.1" + "gpt-5.6-sol" ], "optional": false, "nullable": false, @@ -357172,7 +357172,7 @@ Schema name: `BetaResponseIncompleteEvent` "oasRef": "#/components/schemas/BetaResponse/allOf/2/properties/reasoning", "deprecated": false, "key": "reasoning", - "docstring": "**gpt-5 and o-series models only**\n\nConfiguration options for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\n", + "docstring": "Configuration options for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\n", "title": "Reasoning", "type": { "kind": "HttpTypeObject", @@ -358694,7 +358694,7 @@ Schema name: `BetaResponseIncompleteEvent` }, "(resource) beta.responses > (model) beta_response > (schema) > (property) model > (variant) 0": { "kind": "HttpDeclTypeAlias", - "docstring": "Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", + "docstring": "Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", @@ -419044,7 +419044,7 @@ Schema name: `BetaResponseIncompleteEvent` }, "instructions": null, "max_output_tokens": null, - "model": "gpt-4o-mini-2024-07-18", + "model": "gpt-5.6-sol", "output": [], "previous_response_id": null, "reasoning_effort": null, @@ -419069,11 +419069,11 @@ Schema name: `BetaResponseIncompleteEvent` ### response.output_item.added -在添加新的输出项时发出。 +当新增输出项时发出。 #### Schema -Schema name: `BetaResponseOutputItemAddedEvent` +Schema 名称: `BetaResponseOutputItemAddedEvent` ```json { @@ -446637,11 +446637,11 @@ Schema name: `BetaResponseOutputItemAddedEvent` ### response.output_item.done -在某个输出项被标记为完成时发出。 +当输出项被标记为完成时发出。 #### Schema -Schema name: `BetaResponseOutputItemDoneEvent` +Schema 名称: `BetaResponseOutputItemDoneEvent` ```json { @@ -474211,11 +474211,11 @@ Schema name: `BetaResponseOutputItemDoneEvent` ### response.content_part.added -当新增一个内容部分时发出。 +当新增内容片段时发出。 #### Schema -Schema name: `BetaResponseContentPartAddedEvent` +Schema 名称: `BetaResponseContentPartAddedEvent` ```json { @@ -475435,11 +475435,11 @@ Schema name: `BetaResponseContentPartAddedEvent` ### response.content_part.done -在某个内容片段生成完毕时发出。 +当内容部分完成时发出。 #### Schema -Schema name: `BetaResponseContentPartDoneEvent` +Schema 名称: `BetaResponseContentPartDoneEvent` ```json { @@ -476663,7 +476663,7 @@ Schema name: `BetaResponseContentPartDoneEvent` #### Schema -Schema name: `BetaResponseTextDeltaEvent` +Schema 名称: `BetaResponseTextDeltaEvent` ```json { @@ -477023,11 +477023,11 @@ Schema name: `BetaResponseTextDeltaEvent` ### response.output_text.done -在文本内容被最终确定时触发。 +在文本内容最终确定时发出。 #### Schema -Schema name: `BetaResponseTextDoneEvent` +Schema 名称: `BetaResponseTextDoneEvent` ```json { @@ -477387,11 +477387,11 @@ Schema name: `BetaResponseTextDoneEvent` ### response.refusal.delta -存在部分拒绝文本时发出。 +在存在部分拒绝文本时发出。 #### Schema -Schema name: `BetaResponseRefusalDeltaEvent` +Schema 名称: `BetaResponseRefusalDeltaEvent` ```json { @@ -477631,7 +477631,7 @@ Schema name: `BetaResponseRefusalDeltaEvent` #### Schema -Schema name: `BetaResponseRefusalDoneEvent` +Schema 名称: `BetaResponseRefusalDoneEvent` ```json { @@ -477867,11 +477867,11 @@ Schema name: `BetaResponseRefusalDoneEvent` ### response.function_call_arguments.delta -当存在部分函数调用参数的增量时发出。 +在出现部分函数调用参数增量时发出。 #### Schema -Schema name: `BetaResponseFunctionCallArgumentsDeltaEvent` +Schema 名称: `BetaResponseFunctionCallArgumentsDeltaEvent` ```json { @@ -478088,11 +478088,11 @@ Schema name: `BetaResponseFunctionCallArgumentsDeltaEvent` ### response.function_call_arguments.done -当函数调用参数确定后发出。 +在函数调用参数最终确定时发出。 #### Schema -Schema name: `BetaResponseFunctionCallArgumentsDoneEvent` +Schema 名称: `BetaResponseFunctionCallArgumentsDoneEvent` ```json { @@ -478331,7 +478331,7 @@ Schema name: `BetaResponseFunctionCallArgumentsDoneEvent` #### Schema -Schema name: `BetaResponseFileSearchCallInProgressEvent` +Schema 名称: `BetaResponseFileSearchCallInProgressEvent` ```json { @@ -478529,11 +478529,11 @@ Schema name: `BetaResponseFileSearchCallInProgressEvent` ### response.file_search_call.searching -当 文件搜索 正在执行搜索时触发。 +当 文件搜索 正在进行搜索时触发。 #### Schema -Schema name: `BetaResponseFileSearchCallSearchingEvent` +Schema 名称: `BetaResponseFileSearchCallSearchingEvent` ```json { @@ -478731,11 +478731,11 @@ Schema name: `BetaResponseFileSearchCallSearchingEvent` ### response.file_search_call.completed -当文件搜索调用完成时发出(已找到结果)。 +在 文件搜索 调用完成时触发(已找到结果)。 #### Schema -Schema name: `BetaResponseFileSearchCallCompletedEvent` +Schema 名称: `BetaResponseFileSearchCallCompletedEvent` ```json { @@ -478937,7 +478937,7 @@ Schema name: `BetaResponseFileSearchCallCompletedEvent` #### Schema -Schema name: `BetaResponseWebSearchCallInProgressEvent` +Schema 名称: `BetaResponseWebSearchCallInProgressEvent` ```json { @@ -479135,11 +479135,11 @@ Schema name: `BetaResponseWebSearchCallInProgressEvent` ### response.web_search_call.searching -在网页搜索调用执行时触发。 +当一次网页搜索调用正在执行时发出。 #### Schema -Schema name: `BetaResponseWebSearchCallSearchingEvent` +Schema 名称: `BetaResponseWebSearchCallSearchingEvent` ```json { @@ -479337,11 +479337,11 @@ Schema name: `BetaResponseWebSearchCallSearchingEvent` ### response.web_search_call.completed -当 网页搜索 调用完成时触发。 +在一次网页搜索调用完成时发出。 #### Schema -Schema name: `BetaResponseWebSearchCallCompletedEvent` +Schema 名称: `BetaResponseWebSearchCallCompletedEvent` ```json { @@ -479539,11 +479539,11 @@ Schema name: `BetaResponseWebSearchCallCompletedEvent` ### response.reasoning_summary_part.added -在添加新的推理摘要分块时发出。 +当新增一个推理摘要片段时发出。 #### Schema -Schema name: `BetaResponseReasoningSummaryPartAddedEvent` +Schema 名称: `BetaResponseReasoningSummaryPartAddedEvent` ```json { @@ -479839,11 +479839,11 @@ Schema name: `BetaResponseReasoningSummaryPartAddedEvent` ### response.reasoning_summary_part.done -当推理摘要片段完成时触发。 +当某个推理摘要部分完成时发出。 #### Schema -Schema name: `BetaResponseReasoningSummaryPartDoneEvent` +Schema 名称: `BetaResponseReasoningSummaryPartDoneEvent` ```json { @@ -480174,11 +480174,11 @@ Schema name: `BetaResponseReasoningSummaryPartDoneEvent` ### response.reasoning_summary_text.delta -当推理摘要文本中添加 delta 时触发。 +当向推理摘要文本添加增量时发出。 #### Schema -Schema name: `BetaResponseReasoningSummaryTextDeltaEvent` +Schema 名称: `BetaResponseReasoningSummaryTextDeltaEvent` ```json { @@ -480414,11 +480414,11 @@ Schema name: `BetaResponseReasoningSummaryTextDeltaEvent` ### response.reasoning_summary_text.done -当推理摘要文本完成时触发。 +在推理摘要文本完成时触发。 #### Schema -Schema name: `BetaResponseReasoningSummaryTextDoneEvent` +Schema 名称: `BetaResponseReasoningSummaryTextDoneEvent` ```json { @@ -480654,11 +480654,11 @@ Schema name: `BetaResponseReasoningSummaryTextDoneEvent` ### response.reasoning_text.delta -当向推理文本添加增量时触发。 +当向推理文本添加增量时发出。 #### Schema -Schema name: `BetaResponseReasoningTextDeltaEvent` +Schema 名称: `BetaResponseReasoningTextDeltaEvent` ```json { @@ -480894,11 +480894,11 @@ Schema name: `BetaResponseReasoningTextDeltaEvent` ### response.reasoning_text.done -当推理文本完成时发出。 +在推理文本完成时发出。 #### Schema -Schema name: `BetaResponseReasoningTextDoneEvent` +Schema 名称: `BetaResponseReasoningTextDoneEvent` ```json { @@ -481134,11 +481134,11 @@ Schema name: `BetaResponseReasoningTextDoneEvent` ### response.image_generation_call.completed -当图像生成工具调用已完成且最终图像可用时发出。 +在图像生成工具调用已完成且最终图像可用时发出。 #### Schema -Schema name: `BetaResponseImageGenCallCompletedEvent` +Schema 名称: `BetaResponseImageGenCallCompletedEvent` ```json { @@ -481336,11 +481336,11 @@ Schema name: `BetaResponseImageGenCallCompletedEvent` ### response.image_generation_call.generating -当图像生成工具调用正在主动生成图像时触发(中间状态)。 +当图像生成工具调用正在主动生成图像时发出(中间状态)。 #### Schema -Schema name: `BetaResponseImageGenCallGeneratingEvent` +Schema 名称: `BetaResponseImageGenCallGeneratingEvent` ```json { @@ -481542,7 +481542,7 @@ Schema name: `BetaResponseImageGenCallGeneratingEvent` #### Schema -Schema name: `BetaResponseImageGenCallInProgressEvent` +Schema 名称: `BetaResponseImageGenCallInProgressEvent` ```json { @@ -481740,11 +481740,11 @@ Schema name: `BetaResponseImageGenCallInProgressEvent` ### response.image_generation_call.partial_image -在图像生成流式传输过程中,当有部分图像可用时发出。 +在图像生成流式传输期间,当部分图像可用时发出。 #### Schema -Schema name: `BetaResponseImageGenCallPartialImageEvent` +Schema 名称: `BetaResponseImageGenCallPartialImageEvent` ```json { @@ -482052,11 +482052,11 @@ Schema name: `BetaResponseImageGenCallPartialImageEvent` ### response.mcp_call_arguments.delta -当 MCP 工具调用的参数存在增量(部分更新)时触发。 +当 MCP 工具调用的参数出现增量(部分更新)时发出。 #### Schema -Schema name: `BetaResponseMCPCallArgumentsDeltaEvent` +Schema 名称: `BetaResponseMCPCallArgumentsDeltaEvent` ```json { @@ -482273,11 +482273,11 @@ Schema name: `BetaResponseMCPCallArgumentsDeltaEvent` ### response.mcp_call_arguments.done -在 MCP 工具调用的参数最终确定时触发。 +当 MCP 工具调用的参数最终确定时触发。 #### Schema -Schema name: `BetaResponseMCPCallArgumentsDoneEvent` +Schema 名称: `BetaResponseMCPCallArgumentsDoneEvent` ```json { @@ -482494,11 +482494,11 @@ Schema name: `BetaResponseMCPCallArgumentsDoneEvent` ### response.mcp_call.completed -当 MCP 工具调用成功完成时发出。 +当 MCP 工具调用成功完成时发出。 #### Schema -Schema name: `BetaResponseMCPCallCompletedEvent` +Schema 名称: `BetaResponseMCPCallCompletedEvent` ```json { @@ -482700,7 +482700,7 @@ Schema name: `BetaResponseMCPCallCompletedEvent` #### Schema -Schema name: `BetaResponseMCPCallFailedEvent` +Schema 名称: `BetaResponseMCPCallFailedEvent` ```json { @@ -482902,7 +482902,7 @@ Schema name: `BetaResponseMCPCallFailedEvent` #### Schema -Schema name: `BetaResponseMCPCallInProgressEvent` +Schema 名称: `BetaResponseMCPCallInProgressEvent` ```json { @@ -483100,11 +483100,11 @@ Schema name: `BetaResponseMCPCallInProgressEvent` ### response.mcp_list_tools.completed -已成功获取可用 MCP 工具列表时发出。 +在成功检索到可用的 MCP 工具列表时发出。 #### Schema -Schema name: `BetaResponseMCPListToolsCompletedEvent` +Schema 名称: `BetaResponseMCPListToolsCompletedEvent` ```json { @@ -483306,7 +483306,7 @@ Schema name: `BetaResponseMCPListToolsCompletedEvent` #### Schema -Schema name: `BetaResponseMCPListToolsFailedEvent` +Schema 名称: `BetaResponseMCPListToolsFailedEvent` ```json { @@ -483504,11 +483504,11 @@ Schema name: `BetaResponseMCPListToolsFailedEvent` ### response.mcp_list_tools.in_progress -当系统正在检索可用的 MCP 工具列表时发出。 +在系统正在检索可用的 MCP 工具列表时发出。 #### Schema -Schema name: `BetaResponseMCPListToolsInProgressEvent` +Schema 名称: `BetaResponseMCPListToolsInProgressEvent` ```json { @@ -483706,11 +483706,11 @@ Schema name: `BetaResponseMCPListToolsInProgressEvent` ### response.code_interpreter_call.in_progress -当代码解释器调用正在进行时发出。 +在代码解释器调用进行中时发出。 #### Schema -Schema name: `BetaResponseCodeInterpreterCallInProgressEvent` +Schema 名称: `BetaResponseCodeInterpreterCallInProgressEvent` ```json { @@ -483912,7 +483912,7 @@ Schema name: `BetaResponseCodeInterpreterCallInProgressEvent` #### Schema -Schema name: `BetaResponseCodeInterpreterCallInterpretingEvent` +Schema 名称: `BetaResponseCodeInterpreterCallInterpretingEvent` ```json { @@ -484114,7 +484114,7 @@ Schema name: `BetaResponseCodeInterpreterCallInterpretingEvent` #### Schema -Schema name: `BetaResponseCodeInterpreterCallCompletedEvent` +Schema 名称: `BetaResponseCodeInterpreterCallCompletedEvent` ```json { @@ -484312,11 +484312,11 @@ Schema name: `BetaResponseCodeInterpreterCallCompletedEvent` ### response.code_interpreter_call_code.delta -当代码解释器流式传输部分代码片段时发出。 +当代码解释器流式输出部分代码片段时触发。 #### Schema -Schema name: `BetaResponseCodeInterpreterCallCodeDeltaEvent` +Schema 名称: `BetaResponseCodeInterpreterCallCodeDeltaEvent` ```json { @@ -484537,7 +484537,7 @@ Schema name: `BetaResponseCodeInterpreterCallCodeDeltaEvent` #### Schema -Schema name: `BetaResponseCodeInterpreterCallCodeDoneEvent` +Schema 名称: `BetaResponseCodeInterpreterCallCodeDoneEvent` ```json { @@ -484754,11 +484754,11 @@ Schema name: `BetaResponseCodeInterpreterCallCodeDoneEvent` ### response.output_text.annotation.added -当注解被添加到输出文本内容时发出。 +当注解被添加到输出文本内容时触发。 #### Schema -Schema name: `BetaResponseOutputTextAnnotationAddedEvent` +Schema 名称: `BetaResponseOutputTextAnnotationAddedEvent` ```json { @@ -485555,11 +485555,11 @@ Schema name: `BetaResponseOutputTextAnnotationAddedEvent` ### response.queued -当响应被排入队列并等待处理时发出。 +在响应已加入队列并等待处理时发出。 #### Schema -Schema name: `BetaResponseQueuedEvent` +Schema 名称: `BetaResponseQueuedEvent` ```json { @@ -486687,7 +486687,7 @@ Schema name: `BetaResponseQueuedEvent` "oasRef": "#/components/schemas/BetaResponseProperties/properties/model", "deprecated": false, "key": "model", - "docstring": "Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", + "docstring": "Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", "type": { "kind": "HttpTypeUnion", "oasRef": "#/components/schemas/BetaResponseProperties/properties/model", @@ -487111,7 +487111,7 @@ Schema name: `BetaResponseQueuedEvent` ] }, "examples": [ - "gpt-5.1" + "gpt-5.6-sol" ], "optional": false, "nullable": false, @@ -487917,7 +487917,7 @@ Schema name: `BetaResponseQueuedEvent` "oasRef": "#/components/schemas/BetaResponse/allOf/2/properties/reasoning", "deprecated": false, "key": "reasoning", - "docstring": "**gpt-5 and o-series models only**\n\nConfiguration options for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\n", + "docstring": "Configuration options for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning).\n", "title": "Reasoning", "type": { "kind": "HttpTypeObject", @@ -489439,7 +489439,7 @@ Schema name: `BetaResponseQueuedEvent` }, "(resource) beta.responses > (model) beta_response > (schema) > (property) model > (variant) 0": { "kind": "HttpDeclTypeAlias", - "docstring": "Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", + "docstring": "Model ID used to generate the response, like `gpt-5.6-sol`. OpenAI\noffers a wide range of models with different capabilities, performance\ncharacteristics, and price points. Refer to the [model guide](/docs/models)\nto browse and compare available models.\n", "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", @@ -549789,11 +549789,11 @@ Schema name: `BetaResponseQueuedEvent` ### response.custom_tool_call_input.delta -表示对自定义工具调用的输入进行增量(部分更新)的事件。 +表示对自定义工具调用输入的增量(部分更新)的事件。 #### Schema -Schema name: `BetaResponseCustomToolCallInputDeltaEvent` +Schema 名称: `BetaResponseCustomToolCallInputDeltaEvent` ```json { @@ -550009,11 +550009,11 @@ Schema name: `BetaResponseCustomToolCallInputDeltaEvent` ### response.custom_tool_call_input.done -表示自定义工具调用的输入已完成的事件。 +表示自定义工具调用的输入已完整的事件。 #### Schema -Schema name: `BetaResponseCustomToolCallInputDoneEvent` +Schema 名称: `BetaResponseCustomToolCallInputDoneEvent` ```json { @@ -550233,7 +550233,7 @@ Schema name: `BetaResponseCustomToolCallInputDoneEvent` #### Schema -Schema name: `BetaResponseAudioDeltaEvent` +Schema 名称: `BetaResponseAudioDeltaEvent` ```json { @@ -550417,7 +550417,7 @@ Schema name: `BetaResponseAudioDeltaEvent` #### Schema -Schema name: `BetaResponseAudioDoneEvent` +Schema 名称: `BetaResponseAudioDoneEvent` ```json { @@ -550578,11 +550578,11 @@ Schema name: `BetaResponseAudioDoneEvent` ### response.audio.transcript.delta -当存在音频的部分转写文本时发出。 +当存在音频的部分转录文本时发出。 #### Schema -Schema name: `BetaResponseAudioTranscriptDeltaEvent` +Schema 名称: `BetaResponseAudioTranscriptDeltaEvent` ```json { @@ -550762,11 +550762,11 @@ Schema name: `BetaResponseAudioTranscriptDeltaEvent` ### response.audio.transcript.done -在完整音频转写完成时发出。 +在完整音频转录完成时发出。 #### Schema -Schema name: `BetaResponseAudioTranscriptDoneEvent` +Schema 名称: `BetaResponseAudioTranscriptDoneEvent` ```json { @@ -550927,11 +550927,11 @@ Schema name: `BetaResponseAudioTranscriptDoneEvent` ### response.shell_call_command.added -表示已将 shell 命令添加到工具调用的流式事件。 +一个流式事件,指示某个 shell 命令已添加到工具调用中。 #### Schema -Schema name: `BetaResponseShellCallCommandAddedStreamingEvent` +Schema 名称: `BetaResponseShellCallCommandAddedStreamingEvent` ```json { @@ -551152,11 +551152,11 @@ Schema name: `BetaResponseShellCallCommandAddedStreamingEvent` ### response.shell_call_command.delta -一个流式事件,指示 shell 命令被增量更新。 +一个流式事件,表示某个 shell 命令被增量更新。 #### Schema -Schema name: `BetaResponseShellCallCommandDeltaStreamingEvent` +Schema 名称: `BetaResponseShellCallCommandDeltaStreamingEvent` ```json { @@ -551396,11 +551396,11 @@ Schema name: `BetaResponseShellCallCommandDeltaStreamingEvent` ### response.shell_call_command.done -指示 shell 命令已完成的一次流式事件。 +指示 shell 命令已完成的流式事件。 #### Schema -Schema name: `BetaResponseShellCallCommandDoneStreamingEvent` +Schema 名称: `BetaResponseShellCallCommandDoneStreamingEvent` ```json { @@ -551621,11 +551621,11 @@ Schema name: `BetaResponseShellCallCommandDoneStreamingEvent` ### response.shell_call_output_content.delta -一个流式事件,用于指示 shell 调用输出被增量添加。 +一个流式事件,用于表示 shell 调用输出正在被增量添加。 #### Schema -Schema name: `BetaResponseShellCallOutputContentDeltaStreamingEvent` +Schema 名称: `BetaResponseShellCallOutputContentDeltaStreamingEvent` ```json { @@ -551909,11 +551909,11 @@ Schema name: `BetaResponseShellCallOutputContentDeltaStreamingEvent` ### response.shell_call_output_content.done -一个流式事件,用于指示 shell 调用输出已完成。 +指示 shell 调用输出已完成的事件。 #### Schema -Schema name: `BetaResponseShellCallOutputContentDoneStreamingEvent` +Schema 名称: `BetaResponseShellCallOutputContentDoneStreamingEvent` ```json { diff --git a/docs/zh/api/reference/resources/chat.md b/docs/zh/api/reference/resources/chat.md index e966ad0..f70e421 100644 --- a/docs/zh/api/reference/resources/chat.md +++ b/docs/zh/api/reference/resources/chat.md @@ -1,6 +1,6 @@ # Chat -> 完整的文档索引请参见 [llms.txt](/llms.txt)。在页面 URL 末尾追加 `.md` 即可获取文档页面的 Markdown 版本。 +> 完整文档索引请参见 [llms.txt](/llms.txt)。文档页面的 Markdown 版本可通过在页面 URL 末尾追加 `.md` 获取。 # Completions @@ -8,39 +8,39 @@ **post** `/chat/completions` -**开始新项目?** 我们建议尝试 [Responses](/docs/api-reference/responses) -以使用最新的 OpenAI 平台功能。比较 +**开始新项目?** 我们推荐尝试 [Responses](/docs/api-reference/responses) +以充分利用 OpenAI 平台的最新特性。比较 [Chat Completions 与 Responses](/docs/guides/responses-vs-chat-completions?api-mode=responses). --- -为给定的聊天对话创建模型响应。更多信息请参阅 +为给定的聊天对话创建模型响应。更多内容请参阅 [文本生成](/docs/guides/text-generation), [视觉](/docs/guides/vision), 和 [音频](/docs/guides/audio) 指南。 -参数支持可能因用于生成 -响应的模型而异,尤其是较新的推理模型。仅限 -推理模型支持的参数在下方注明。有关推理模型中不受支持参数的当前情况, -请参阅推理指南, -[推理指南](/docs/guides/reasoning). +可支持的参数可能因用于生成 +响应的模型而异,尤其是较新的推理模型。仅 +支持推理模型的参数会在下方注明。有关推理模型中 +不受支持参数的当前情况,请, +[参阅推理指南](/docs/guides/reasoning). -返回一个聊天完成对象,如果请求被流式传输,则返回按顺序排列的聊天完成 -块对象。 +返回一个聊天补全对象,若请求以流式传输,则返回一系列聊天补全 +分块对象。 -### 请求体参数 +### Body Parameters - `messages: array of ChatCompletionMessageParam` - 由消息组成的列表,包含迄今为止的对话内容。根据所使用的 - [model](/docs/models) 不同,支持不同的消息类型(模态),例如 - ,例如 [text](/docs/guides/text-generation), - [images](/docs/guides/vision),和 [audio](/docs/guides/audio). + 到目前为止组成对话的消息列表。根据所使用的 + [model](/docs/models) ,支持不同的消息类型(模态),例如 + 支持的,例如 [text](/docs/guides/text-generation), + [images](/docs/guides/vision),以及 [audio](/docs/guides/audio). - `ChatCompletionDeveloperMessageParam object { content, role, name }` - 由开发者提供的指令,模型应遵循这些指令,无论用户发送了什么消息。对于 o1 及更新的模型, - 不支持这些参数。 `developer` messages - 替换之前的 `system` messages。 + 开发者提供的指令,无论用户发送什么 + 消息,模型都应遵循。对于 o1 及更新的模型, `developer` messages + 将取代先前的 `system` messages。 - `content: string or array of ChatCompletionContentPartText` @@ -52,7 +52,7 @@ - `ArrayOfContentParts = array of ChatCompletionContentPartText` - 由已定义类型组成的内容部分数组。对于开发者消息,仅支持类型 `text` 。 + 具有已定义类型的 content parts 数组。对于开发者消息,仅支持 type `text` 类型。 - `text: string` @@ -66,7 +66,7 @@ - `prompt_cache_breakpoint: optional object { mode }` - 标记可复用提示前缀的精确结束位置。该断点会沿用请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。 + 标记可复用提示前缀的确切结束位置。该断点继承自请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。 - `mode: "explicit"` @@ -82,13 +82,13 @@ - `name: optional string` - 该参与者的可选名称。为模型提供信息,以便区分相同角色的不同参与者。 + 参与者的可选名称。为模型提供信息,以便区分同一角色的不同参与者。 - `ChatCompletionSystemMessageParam object { content, role, name }` - 由开发者提供的指令,模型应遵循这些指令,无论用户发送了什么消息。对于 o1 及更新的模型, - 由用户发送的消息。对于 o1 及更新的模型,请使用 `developer` messages - 来代替实现此目的。 + 开发者提供的指令,无论用户发送什么 + 用户发送的消息。对于 o1 及更高版本的模型,请改用 `developer` messages + 来实现此目的。 - `content: string or array of ChatCompletionContentPartText` @@ -100,7 +100,7 @@ - `ArrayOfContentParts = array of ChatCompletionContentPartText` - 具有指定类型的内容部分数组。对于系统消息,仅支持 type `text` 。 + 具有已定义类型的内容部分数组。对于系统消息,仅支持类型 `text` 类型。 - `text: string` @@ -112,7 +112,7 @@ - `prompt_cache_breakpoint: optional object { mode }` - 标记可复用提示前缀的精确结束位置。该断点会沿用请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。 + 标记可复用提示前缀的确切结束位置。该断点继承自请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。 - `role: "system"` @@ -122,7 +122,7 @@ - `name: optional string` - 该参与者的可选名称。为模型提供信息,以便区分相同角色的不同参与者。 + 参与者的可选名称。为模型提供信息,以便区分同一角色的不同参与者。 - `ChatCompletionUserMessageParam object { content, role, name }` @@ -139,7 +139,7 @@ - `ArrayOfContentParts = array of ChatCompletionContentPart` - 具有指定类型的内容部分数组。支持选项因用于生成响应的 [model](/docs/models) 而有所不同。可以包含文本、图像或音频输入。 + 具有已定义类型的内容部分数组。支持的具体选项因用于生成响应的 [model](/docs/models) 而异。可以包含文本、图像或音频输入。 - `ChatCompletionContentPartText object { text, type, prompt_cache_breakpoint }` @@ -155,7 +155,7 @@ - `prompt_cache_breakpoint: optional object { mode }` - 标记可复用提示前缀的精确结束位置。该断点会沿用请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。 + 标记可复用提示前缀的确切结束位置。该断点继承自请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。 - `ChatCompletionContentPartImage object { image_url, type, prompt_cache_breakpoint }` @@ -169,7 +169,7 @@ - `detail: optional "auto" or "low" or "high"` - 指定图像的细节级别。在 [视觉指南](/docs/guides/vision#low-or-high-fidelity-image-understanding). + 指定图像的细节级别。更多信息请参阅 [视觉指南](/docs/guides/vision#low-or-high-fidelity-image-understanding). - `"auto"` @@ -185,7 +185,7 @@ - `prompt_cache_breakpoint: optional object { mode }` - 标记可复用提示前缀的精确结束位置。该断点会沿用请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。 + 标记可复用提示前缀的确切结束位置。该断点继承自请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。 - `mode: "explicit"` @@ -219,7 +219,7 @@ - `prompt_cache_breakpoint: optional object { mode }` - 标记可复用提示前缀的精确结束位置。该断点会沿用请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。 + 标记可复用提示前缀的确切结束位置。该断点继承自请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。 - `mode: "explicit"` @@ -235,8 +235,8 @@ - `file_data: optional string` - Base64 编码的文件数据,在将文件作为字符串传递给模型时使用 - 。 + base64 编码的文件数据,在将文件传递给模型时使用 + 字符串。 - `file_id: optional string` @@ -244,8 +244,8 @@ - `filename: optional string` - 文件的名称,在将文件作为字符串传递给模型时使用 - 。 + 文件的名称,在将文件以 + 字符串形式传递给模型时使用。 - `type: "file"` @@ -255,7 +255,7 @@ - `prompt_cache_breakpoint: optional object { mode }` - 标记可复用提示前缀的精确结束位置。该断点会沿用请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。 + 标记可复用提示前缀的确切结束位置。该断点继承自请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。 - `mode: "explicit"` @@ -271,7 +271,7 @@ - `name: optional string` - 该参与者的可选名称。为模型提供信息,以便区分相同角色的不同参与者。 + 参与者的可选名称。为模型提供信息,以便区分同一角色的不同参与者。 - `ChatCompletionAssistantMessageParam object { role, audio, content, 4 more }` @@ -285,7 +285,7 @@ - `audio: optional object { id } or null` - 关于模型先前音频响应的数据。 + 模型先前音频响应的相关数据。 [了解更多](/docs/guides/audio). - `id: string` @@ -294,7 +294,7 @@ - `content: optional string or array of ChatCompletionContentPartText or ChatCompletionContentPartRefusal or null` - 助手消息的内容。除非指定了 `tool_calls` 或 `function_call` ,否则必填。 + 助手消息的内容。除非指定了 `tool_calls` 或 `function_call` ,否则此字段为必填。 - `TextContent = string` @@ -302,7 +302,7 @@ - `ArrayOfContentParts = array of ChatCompletionContentPartText or ChatCompletionContentPartRefusal` - 由已定义类型组成的内容部分数组。可以包含一个或多个类型为 `text`,或恰好一个类型为 `refusal`. + 具有已定义类型的内容片段数组。可以是以下类型的一个或多个 `text`,或以下类型的恰好一个 `refusal`. - `ChatCompletionContentPartText object { text, type, prompt_cache_breakpoint }` @@ -312,7 +312,7 @@ - `refusal: string` - 模型生成的拒绝消息。 + 由模型生成的拒绝消息。 - `type: "refusal"` @@ -322,11 +322,11 @@ - `function_call: optional object { arguments, name } or null` - 已弃用,由 `tool_calls`。替代。模型生成的应被调用的函数名称和参数。 + 已弃用,由 `tool_calls`。替代。应调用的函数的名称和参数,由模型生成。 - `arguments: string` - 以 JSON 格式传递给函数的参数,由模型生成。请注意,模型并不总是生成有效的 JSON,并且可能会虚构函数 schema 中未定义的参数。在调用函数之前,请在代码中校验这些参数。 + 调用函数时使用的参数,以 JSON 格式由模型生成。请注意,模型并不总是生成有效的 JSON,并且可能会虚构你的函数 schema 中未定义的参数。在调用函数之前,请在代码中校验这些参数。 - `name: string` @@ -334,11 +334,11 @@ - `name: optional string` - 该参与者的可选名称。为模型提供信息,以便区分相同角色的不同参与者。 + 参与者的可选名称。为模型提供信息,以便区分同一角色的不同参与者。 - `refusal: optional string or null` - 助手给出的拒绝消息。 + 助手生成的拒绝消息。 - `tool_calls: optional array of ChatCompletionMessageToolCall` @@ -358,7 +358,7 @@ - `arguments: string` - 以 JSON 格式传递给函数的参数,由模型生成。请注意,模型并不总是生成有效的 JSON,并且可能会虚构函数 schema 中未定义的参数。在调用函数之前,请在代码中校验这些参数。 + 调用函数时使用的参数,以 JSON 格式由模型生成。请注意,模型并不总是生成有效的 JSON,并且可能会虚构你的函数 schema 中未定义的参数。在调用函数之前,请在代码中校验这些参数。 - `name: string` @@ -366,7 +366,7 @@ - `type: "function"` - 工具的类型。目前,仅 `function` 。 + 工具的类型。目前,仅 `function` 类型。 - `"function"` @@ -408,7 +408,7 @@ - `ArrayOfContentParts = array of ChatCompletionContentPartText` - 由指定类型组成的内容片段数组。对于工具消息,仅支持 type `text` 。 + 由已定义类型组成的内容分块数组。对于工具消息,仅支持类型 `text` 类型。 - `text: string` @@ -420,7 +420,7 @@ - `prompt_cache_breakpoint: optional object { mode }` - 标记可复用提示前缀的精确结束位置。该断点会沿用请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。 + 标记可复用提示前缀的确切结束位置。该断点继承自请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。 - `role: "tool"` @@ -450,18 +450,18 @@ - `model: string or "gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 80 more` - 用于生成响应的模型 ID,例如 `gpt-4o` 或 `o3`。OpenAI - 提供了大量具有不同能力、性能 - 特性和价位的模型。请参阅 [模型指南](/docs/models) + 用于生成响应的模型 ID,例如 `gpt-5.6-sol` 或 `o3`。OpenAI + 提供了大量能力、性能和价格各异的模型。请参阅 + 模型指南 [模型指南](/docs/models) 以浏览和比较可用的模型。 - `string` - `"gpt-5.6-sol" or "gpt-5.6-terra" or "gpt-5.6-luna" or 80 more` - 用于生成响应的模型 ID,例如 `gpt-4o` 或 `o3`。OpenAI - 提供了大量具有不同能力、性能 - 特性和价位的模型。请参阅 [模型指南](/docs/models) + 用于生成响应的模型 ID,例如 `gpt-5.6-sol` 或 `o3`。OpenAI + 提供了大量能力、性能和价格各异的模型。请参阅 + 模型指南 [模型指南](/docs/models) 以浏览和比较可用的模型。 - `"gpt-5.6-sol"` @@ -632,12 +632,12 @@ - `audio: optional ChatCompletionAudioParam or null` - 音频输出的参数。在请求音频输出时必填,需配合 + 音频输出的参数。当使用以下方式请求音频输出时为必填项 `modalities: ["audio"]`. [了解更多](/docs/guides/audio). - `format: "wav" or "aac" or "mp3" or 3 more` - 指定输出音频格式。必须是以下值之一 `wav`, `mp3`, `flac`, + 指定输出音频格式。必须是以下之一 `wav`, `mp3`, `flac`, `opus`,或 `pcm16`. - `"wav"` @@ -654,10 +654,10 @@ - `voice: string or "alloy" or "ash" or "ballad" or 7 more or object { id }` - 模型用于回复所使用的语音。支持的内置语音包括 + 模型用于回复的声音。支持的内置声音包括 `alloy`, `ash`, `ballad`, `coral`, `echo`, `fable`, `nova`, `onyx`, - `sage`, `shimmer`, `marin`,和 `cedar`。你也可以提供一个 - custom voice 对象,其中包含 `id`,例如 `{ "id": "voice_1234" }`. + `sage`, `shimmer`, `marin`,以及 `cedar`。你也可以提供带有 + 的自定义声音对象,使用 `id`,例如 `{ "id": "voice_1234" }`. - `string` @@ -685,39 +685,39 @@ - `ID object { id }` - 自定义语音引用。 + 自定义声音引用。 - `id: string` - 自定义语音 ID,例如 `voice_1234`. + 自定义声音 ID,例如 `voice_1234`. - `frequency_penalty: optional number or null` - 介于 -2.0 和 2.0 之间的数值。正值会根据 - 新 token 在文本中已有的出现频率对其进行惩罚,从而降低模型 - 逐字重复相同内容的可能性。 + 介于 -2.0 和 2.0 之间的数字。正值会根据新 token 在 + 已有文本中的出现频率对其进行惩罚,从而降低模型原样 + 重复相同语句的可能性。 - `function_call: optional "none" or "auto" or ChatCompletionFunctionCallOption` 已弃用,推荐使用 `tool_choice`. - 控制由模型调用哪个函数(如果有)。 + 控制模型调用哪个函数(如果有)。 `none` 表示模型不会调用函数,而是生成一条 消息。 - `auto` 表示模型可以在生成消息和调用函数之间选择。 + `auto` 表示模型可以在生成消息和调用函数之间进行选择, 函数。 - 通过以下方式指定某个具体函数 `{"name": "my_function"}` 强制模型 - 调用该函数。 + 通过 `{"name": "my_function"}` 指定某个特定函数会强制 + 模型调用该函数。 - `none` 在没有函数时的默认值。 `auto` 是默认值 + `none` 是当没有任何函数时的默认值。 `auto` 是默认值 (当存在函数时)。 - `"none" or "auto"` - `none` 表示模型不会调用函数,而是生成一条消息。 `auto` 表示模型可以在生成消息和调用函数之间选择。 + `none` 表示模型不会调用函数,而是生成一条消息。 `auto` 表示模型可以在生成消息和调用函数之间进行选择。 - `"none"` @@ -725,7 +725,7 @@ - `ChatCompletionFunctionCallOption object { name }` - 通过以下方式指定某个具体函数 `{"name": "my_function"}` 强制模型调用该函数。 + 通过 `{"name": "my_function"}` 强制模型调用该函数。 - `name: string` @@ -739,67 +739,67 @@ - `name: string` - 要调用的函数名称。必须由 a-z、A-Z、0-9 组成,或包含下划线和连字符,最大长度为 64。 + 要调用的函数名称。必须为 a-z、A-Z、0-9,或包含下划线和短横线,最大长度为 64。 - `description: optional string` - 对函数功能的描述,模型据此选择何时以及如何调用该函数。 + 对函数作用的描述,模型据此选择何时以及如何调用该函数。 - `parameters: optional FunctionParameters` - 函数接受的参数,使用 JSON Schema 对象描述。请参阅 [指南](/docs/guides/function-calling) 中的示例,以及 [JSON Schema 参考](https://json-schema.org/understanding-json-schema/) ,了解相关格式的文档。 + 函数接受的参数,以 JSON Schema 对象描述。参阅 [指南](/docs/guides/function-calling) 中的示例,以及 [JSON Schema 参考](https://json-schema.org/understanding-json-schema/) 获取有关该格式的文档。 - 省略 `parameters` 定义了一个参数列表为空的函数。 + 省略 `parameters` 用于定义一个参数列表为空的函数。 - `logit_bias: optional map[number] or null` - 修改指定 token 出现在补全中的可能性。 + 修改指定标记在 completion 中出现的可能性。 - 接受一个 JSON 对象,该对象将 token(按其在 - 分词器中的 token ID 指定)映射到 -100 到 100 之间的关联偏差值。数学上, - 该偏差会在采样之前加到模型生成的 logits 上。 - 具体效果因模型而异,但 -1 到 1 之间的值应该会 - 降低或提高被选中的可能性;像 -100 或 100 这样的值 - 应会导致禁止或唯一选中相关 token。 + 接受一个 JSON 对象,该对象将标记(由分词器中的标记 ID 指定)映射到 -100 到 100 的关联偏差值。在数学上, + 分词器中的标记 ID 指定)映射到 -100 到 100 的关联偏差值。在数学上, + 该偏差会在采样之前添加到模型生成的 logits 上。 + 具体效果因模型而异,但介于 -1 到 1 之间的值应 + 会降低或提高被选中的可能性;像 -100 或 100 这样的值 + 应导致相应标记被禁止或被独占选中。 - `logprobs: optional boolean or null` - 是否返回输出 token 的对数概率。如果为 true, - 则返回所返回的每个输出 token 的对数概率,格式在 - `content` 中 `message`. + 是否返回输出标记的对数概率。如果为 true, + 则返回所返回的每个输出标记的 + `content` 的 `message`. - `max_completion_tokens: optional number or null` - 补全可生成 token 数量的上限,包括可见的输出 token 和 [推理 token](/docs/guides/reasoning). + 单次 completion 可生成标记数的上限,包括可见输出标记和 [推理标记](/docs/guides/reasoning). - `max_tokens: optional number or null` - 可在 [聊天补全](/tokenizer) 中生成的最大 - token 数量。此值可用于控制 + 可在 [聊天 completion](/tokenizer) 中生成的最大 + 标记数。该值可用于控制 [成本](https://openai.com/api/pricing/) 用于通过 API 生成的文本。 此值现已弃用,推荐使用 `max_completion_tokens`,并且 - 与 [o-series models](/docs/guides/reasoning). + 与 [o 系列模型](/docs/guides/reasoning). - `metadata: optional Metadata or null` - 可以附加到对象的 16 组键值对。这可以用于 - 以结构化格式存储有关对象的附加信息,并通过 API 或控制台查询对象。 - 以结构化格式存储有关对象的附加信息,并通过 接口 或控制台查询对象。 + 可附加到对象的 16 组键值对。可用于 + 以结构化格式存储有关对象的其他信息,并通过 API 或控制台查询对象。 + 以结构化格式存储有关对象的其他信息,并通过 接口 或控制台查询对象。 - 键是字符串,最大长度为 64 个字符。值是字符串, + 键为字符串,最大长度为 64 个字符。值为字符串, 最大长度为 512 个字符。 - `modalities: optional array of "text" or "audio" or null` 你希望模型生成的输出类型。 - 大多数模型能够生成文本,这是默认值: + 大多数模型都能生成文本,这也是默认方式: `["text"]` - 该 `gpt-4o-audio-preview` 模型也可用于 - [generate audio](/docs/guides/audio)。若要请求该模型同时生成 - 文本和音频响应,你可以使用: + 该 `gpt-4o-audio-preview` 模型还可以用于 + [生成音频](/docs/guides/audio).要让该模型生成 + 同时获取文本和音频响应,你可以使用: `["text", "audio"]` @@ -809,15 +809,15 @@ - `moderation: optional object { model, policy } or null` - 对请求输入和生成输出运行内容审核的配置。 + 对请求输入和生成输出运行审查的配置。 - `model: string` - 用于已审核补全的内容审核模型,例如 'omni-moderation-latest'。 + 用于审查补全的审查模型,例如 'omni-moderation-latest'。 - `policy: optional object { input, output } or null` - 应用于已审核响应输入和输出的策略。 + 应用于审查响应输入和输出的策略。 - `input: optional object { mode } or null` @@ -841,31 +841,31 @@ - `n: optional number or null` - 为每条输入消息生成多少个聊天补全选项。请注意,费用将根据所有选项中生成的 token 总数计算。请将 n 保持为 1 `n` 以 `1` 最小化成本。 + 为每个输入消息生成多少个聊天补全选项。请注意,你将根据所有选项中生成的 token 总数计费。请尽量将 n 保持为 1 `n` 以 `1` 降低成本。 - `parallel_tool_calls: optional boolean` - 是否在工具使用期间启用 [并行函数调用](/docs/guides/function-calling#configuring-parallel-function-calling) 。 + 是否启用 [并行函数调用](/docs/guides/function-calling#configuring-parallel-function-calling) ,以便在工具使用期间调用。 - `prediction: optional ChatCompletionPredictionContent or null` 静态预测输出内容,例如正在重新生成的文本文件的内容。 - being regenerated. + 正在重新生成。 - `content: string or array of ChatCompletionContentPartText` 生成模型响应时应匹配的内容。 - 如果生成的 token 与该内容匹配,则可以更快地返回完整的模型响应。 - can be returned much more quickly. + 如果生成的 token 与该内容匹配,则可以更快地返回整个模型响应。 + 可以更快地返回。 - `TextContent = string` - 用于 Predicted Output 的内容。这通常是 + 用于预测输出的内容。这通常是 你正在重新生成且仅有少量改动的文件文本。 - `ArrayOfContentParts = array of ChatCompletionContentPartText` - 具有指定类型的内容部分数组。支持选项因用于生成响应的 [model](/docs/models) 用于生成响应。可以包含文本输入。 + 具有已定义类型的内容部分数组。支持的具体选项因用于生成响应的 [model](/docs/models) 正在用于生成响应。可以包含文本输入。 - `text: string` @@ -877,32 +877,32 @@ - `prompt_cache_breakpoint: optional object { mode }` - 标记可复用提示前缀的精确结束位置。该断点会沿用请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。 + 标记可复用提示前缀的确切结束位置。该断点继承自请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。 - `type: "content"` - 你希望提供的预测内容的类型。该类型目前始终为 - currently always `content`. + 你希望提供的预测内容的类型。该类型 + 目前始终为 `content`. - `"content"` - `presence_penalty: optional number or null` - 介于 -2.0 和 2.0 之间的数值。正值会根据 - whether they appear in the text so far, increasing the model's likelihood - 以讨论新主题。 + 介于 -2.0 和 2.0 之间的数字。正值会根据新 token 在 + 无论它们是否已出现在迄今为止的文本中,都会提高模型讨论新主题的可能性 + 讨论新主题的可能性。 - `prompt_cache_key: optional string or null` - 由 OpenAI 使用来为相似请求缓存响应,以优化你的缓存命中率。取代 `user` 字段。 [了解更多](/docs/guides/prompt-caching). + 由 OpenAI 用于缓存相似请求的响应,以优化你的缓存命中率。取代了 `user` 字段。 [了解更多](/docs/guides/prompt-caching). - `prompt_cache_options: optional object { mode, ttl }` - 提示缓存的选项。支持 `gpt-5.6` 及更高版本模型。默认情况下,OpenAI 会自动选择一个隐式缓存断点。你可以使用 `prompt_cache_breakpoint`。向内容块添加显式断点。每个请求最多可以写入四个断点。在缓存匹配时,OpenAI 会考虑会话中最近最多 80 个断点,且没有内容块回溯限制。将 `mode` 设置为 `explicit` 可禁用隐式断点。 `ttl` 默认为 `30m`,目前是唯一支持的值。请参阅 [提示缓存指南](/docs/guides/prompt-caching) 了解当前详情。 + 提示缓存的选项。支持 `gpt-5.6` 及更高版本模型。默认情况下,OpenAI 会自动选择一个隐式缓存断点。你可以使用 `prompt_cache_breakpoint`。为内容块添加显式断点。每个请求最多可以写入四个断点。对于缓存匹配,OpenAI 会考虑对话中最近的 80 个断点,没有内容块回溯限制。设置 `mode` 为 `explicit` 以禁用隐式断点。 `ttl` 默认为 `30m`,这是当前唯一支持的值。请参阅 [提示缓存指南](/docs/guides/prompt-caching) 了解当前详情。 - `mode: optional "implicit" or "explicit"` - 控制 OpenAI 是否自动创建隐式缓存断点。默认为 `implicit`。使用 `implicit`,时,OpenAI 会创建一个隐式断点,并在请求中写入最近最多三个显式断点。使用 `explicit`,时,OpenAI 不会创建隐式断点,并写入最近最多四个显式断点。如果没有显式断点,则请求不会使用提示缓存。 + 控制 OpenAI 是否自动创建隐式缓存断点。默认为 `implicit`。使用 `implicit`,时,OpenAI 会创建一个隐式断点,并在请求中写入最多最新的三个显式断点。使用 `explicit`,时,OpenAI 不会创建隐式断点,并写入最多最新的四个显式断点。如果没有显式断点,则该请求不使用提示缓存。 - `"implicit"` @@ -910,24 +910,24 @@ - `ttl: optional "30m"` - 应用于请求写入的每个隐式和显式缓存断点的最短生存时间。默认为 `30m`,目前是唯一支持的值。后端可能将缓存条目保留更长时间。 + 应用于该请求写入的每个隐式和显式缓存断点的最短生命周期。默认为 `30m`,这是当前唯一支持的值。后端可能会将缓存条目保留更长时间。 - `"30m"` - `prompt_cache_retention: optional "in_memory" or "24h" or null` - 已弃用。请使用 `prompt_cache_options.ttl` 替代。 + 已弃用。请使用 `prompt_cache_options.ttl` 代替。 - 提示缓存的保留策略。设置为 `24h` 以启用扩展的提示缓存,使缓存的前缀保持更长时间的活跃状态,最长可达 24 小时。 [了解更多](/docs/guides/prompt-caching#prompt-cache-retention). + 提示缓存的保留策略。设置为 `24h` 用于启用扩展的提示缓存,使缓存的前缀保持更长时间,最长可达 24 小时。 [了解更多](/docs/guides/prompt-caching#prompt-cache-retention). 该字段表示最大保留策略,而 - `prompt_cache_options.ttl` 表示最小缓存生命周期。两个 - 字段是独立的,互不影响。 - 对于 `gpt-5.5`, `gpt-5.5-pro`,以及未来模型,仅 `24h` 。 + `prompt_cache_options.ttl` 表示最短缓存生命周期。两个 + 字段相互独立,不会相互影响。 + 对于 `gpt-5.5`, `gpt-5.5-pro`,及以后的模型,仅 `24h` 类型。 - 对于同时支持两者的旧模型, `in_memory` 和 `24h`,默认值取决于你的组织的数据保留策略: + 对于同时支持两者的旧模型, `in_memory` 和 `24h`,的默认值取决于你所在组织的数据保留策略: - 未启用 ZDR 的组织默认为 `24h`. - - 启用 ZDR 的组织默认为 `in_memory` 当 `prompt_cache_retention` 未指定时。 + - 已启用 ZDR 的组织默认为 `in_memory` 当未指定 `prompt_cache_retention` 时。 - `"in_memory"` @@ -935,13 +935,13 @@ - `reasoning_effort: optional ReasoningEffort or null` - 限制推理模型在推理上的投入程度。当前支持的 - 取值为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,和 `max`. - 降低推理投入程度可以使响应更快,并减少响应中用于推理的 token 数量。并非所有推理模型都支持每个 - 取值。请参阅 - 推理指南 - [推理指南](https://platform.openai.com/docs/guides/reasoning) - 以了解特定模型的支持情况。 + 限制推理模型在推理上的投入程度。当前支持的值 + 为 `none`, `minimal`, `low`, `medium`, `high`, `xhigh`,以及 `max`. + 降低推理投入程度可以让响应更快,并减少在响应中用于推理的 token 数量。并非所有推理模型都支持每个 + 值。请参阅推理指南了解模型相关的支持情况。 + 值。请参阅 + [reasoning guide](https://platform.openai.com/docs/guides/reasoning) + 了解模型相关的支持情况。 - `"none"` @@ -959,20 +959,20 @@ - `response_format: optional ResponseFormatText or ResponseFormatJSONSchema or ResponseFormatJSONObject` - 用于指定模型必须输出的格式的对象。 + 一个对象,用于指定模型必须输出的格式。 - 设置为 `{ "type": "json_schema", "json_schema": {...} }` 可启用 - 结构化输出(Structured Outputs),确保模型与你提供的 JSON - 模式匹配。详细了解请参阅 [结构化输出 + 设置为 `{ "type": "json_schema", "json_schema": {...} }` 启用 + 结构化输出,确保模型匹配你提供的 JSON + schema。了解更多,请参阅 [Structured Outputs 指南](/docs/guides/structured-outputs). 设置为 `{ "type": "json_object" }` 启用旧的 JSON 模式,它 - 确保模型生成的消息是合法 JSON。对于支持 `json_schema` - 的模型,建议优先使用它。 + 确保模型生成的消息是有效的 JSON。使用 `json_schema` + 对于支持它的模型是首选。 - `ResponseFormatText object { type }` - 默认的响应格式。用于生成文本响应。 + 默认响应格式。用于生成文本响应。 - `type: "text"` @@ -982,8 +982,8 @@ - `ResponseFormatJSONSchema object { json_schema, type }` - JSON Schema 响应格式。用于生成结构化 JSON 响应。 - 详细了解 [结构化输出](/docs/guides/structured-outputs). + JSON Schema 响应格式。用于生成结构化的 JSON 响应。 + 了解更多关于 [Structured Outputs](/docs/guides/structured-outputs). - `json_schema: object { name, description, schema, strict }` @@ -991,25 +991,25 @@ - `name: string` - 响应格式的名称。必须由 a-z、A-Z、0-9 组成,或包含 - 下划线和短横线,最大长度为 64 个字符。 + 响应格式的名称。必须为 a-z、A-Z、0-9,或包含 + 下划线和连字符,最大长度为 64。 - `description: optional string` - 对响应格式用途的描述,模型据此 - 决定如何按该格式进行响应。 + 响应格式用途的描述,由模型用于 + 决定如何以该格式进行响应。 - `schema: optional map[unknown]` - 响应格式的 schema,以 JSON Schema 对象描述。 + 响应格式的 schema,描述为一个 JSON Schema 对象。 了解如何构建 JSON schema [此处](https://json-schema.org/). - `strict: optional boolean or null` 是否在生成输出时启用严格的模式遵循。 - 如果设为 true,模型将始终遵循所定义的精确模式 - 在 `schema` 字段中。当 - `strict` 为 `true`。时,仅支持 JSON Schema 的一个子集。了解更多,请阅读 [结构化输出 + 若设置为 true,模型将始终遵循所定义的精确模式 + 字段中。仅支持 JSON Schema 的一个子集,当 `schema` 字段时。如需了解更多信息,请参阅 + `strict` 为 `true`。时。如需了解更多信息,请参阅 [Structured Outputs 指南](/docs/guides/structured-outputs). - `type: "json_schema"` @@ -1022,7 +1022,7 @@ JSON 对象响应格式。一种较旧的生成 JSON 响应的方法。 使用 `json_schema` 建议用于支持它的模型。请注意, - 模型在没有系统或用户消息指示的情况下不会生成 JSON, + 如果没有系统或用户消息指示模型生成 JSON,模型将不会生成 JSON。 以执行此操作。 - `type: "json_object"` @@ -1033,26 +1033,26 @@ - `safety_identifier: optional string or null` - 一个稳定的标识符,用于帮助检测可能违反 OpenAI 使用政策的应用程序用户。 - 该 ID 应为一个字符串,用于唯一标识每个用户,最大长度为 64 个字符。建议对其用户名或电子邮件地址进行哈希处理,以避免向我们发送任何识别信息。 [了解更多](/docs/guides/safety-best-practices#safety-identifiers). + 一个稳定的标识符,用于帮助检测可能违反 OpenAI 使用策略的应用程序用户。 + 该 ID 应为一个字符串,用于唯一标识每个用户,最大长度为 64 个字符。我们建议对其用户名或电子邮件地址进行哈希处理,以避免向我们发送任何识别信息。 [了解更多](/docs/guides/safety-best-practices#safety-identifiers). - `seed: optional number or null` - 此功能处于 Beta 阶段。 - 如果指定,我们的系统将尽最大努力进行确定性采样,以便具有相同 `seed` 和参数的重复请求返回相同的结果。 - 确定性无法保证,你应该参考 `system_fingerprint` 响应参数来监控后端的变化。 + 此功能处于测试阶段。 + 如果指定,我们的系统将尽最大努力进行确定性采样,以便使用相同 `seed` 和参数的重复请求应返回相同的结果。 + 不保证确定性,你应当参考 `system_fingerprint` 响应参数来监控后端的变化。 - `service_tier: optional "auto" or "default" or "flex" or 3 more or null` 指定用于处理请求的处理类型。 - - 如果设置为 'auto',则请求将按照项目设置中配置的服务层级处理。除非另行配置,项目将使用 'default'。 - - 如果设置为 'default',则请求将以所选模型的标准定价和性能进行处理。 + - 如果设置为 'auto',则请求将使用 Project 设置中配置的服务层级进行处理。除非另行配置,否则该 Project 将使用 'default'。 + - 如果设置为 'default',则请求将使用所选模型的标准定价和性能进行处理。 - 如果设置为 '[flex](/docs/guides/flex-processing)',则请求将使用 Flex Processing 服务层级进行处理。 - - 若要在请求级别启用 [Fast mode](/api/docs/guides/fast-mode) ,请在 Responses 或 Chat Completions 中包含 `service_tier=fast` 或 `service_tier=priority` 参数。响应中将显示 `service_tier=priority` ,无论你是否在请求中指定了 `service_tier=fast` 或 `priority` 。 + - 要在请求级别启用 [Fast mode](/api/docs/guides/fast-mode) ,请在 Responses 或 Chat Completions 中包含 `service_tier=fast` 或 `service_tier=priority` 参数。响应中将显示 `service_tier=priority` ,无论你是否在请求中指定 `service_tier=fast` 或 `priority` 。 - 未设置时,默认行为为 'auto'。 - 当 `service_tier` 参数被设置时,响应体将根据实际用于处理请求的处理模式返回 `service_tier` 值。该响应值可能与参数中设置的值不同。 + 当设置了 `service_tier` 参数时,响应主体将根据实际用于处理该请求的处理模式包含对应的 `service_tier` 值。该响应值可能与参数中设置的值不同。 - `"auto"` @@ -1068,10 +1068,10 @@ - `stop: optional string or array of string or null` - 不支持最新的推理模型 `o3` 和 `o4-mini`. + 最新的推理模型不支持该参数 `o3` 和 `o4-mini`. - 最多 4 个序列,在这些序列处 API 将停止生成更多 token。 - 返回的文本将不包含停止序列。 + 最多 4 个序列,当出现这些序列时,API 将停止生成更多 token。返回的 + 文本不会包含该停止序列。 - `string` @@ -1079,63 +1079,63 @@ - `store: optional boolean or null` - 是否存储此聊天补全请求的输出以用于 - 我们的 [model distillation](/docs/guides/distillation) 或 + 是否存储此次聊天补全请求的输出以用于 + 我们后续的 [model distillation](/docs/guides/distillation) 或 [evals](/docs/guides/evals) 产品。 支持文本和图像输入。注意:超过 8MB 的图像输入将被丢弃。 - `stream: optional boolean or null` - 如果设置为 true,模型响应数据将在生成时使用 - 流式传输到客户端 [服务端发送事件](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format). - 请参阅下方 [Streaming 部分](/docs/api-reference/chat/streaming) - 了解更多信息,以及 [流式响应](/docs/guides/streaming-responses) - 指南,了解如何处理流式事件。 + 如果设置为 true,模型响应数据将通过 + 边生成边使用 [服务端发送事件](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format). + 请参阅下方的 [流式传输部分](/docs/api-reference/chat/streaming) + 以获取更多信息,以及 [流式响应](/docs/guides/streaming-responses) + 指南,了解如何处理流式事件的更多信息。 - `stream_options: optional ChatCompletionStreamOptions or null` - 流式响应的选项。仅在设置 `stream: true`. + 流式响应的选项。仅在设置了 stream: true 时设置此参数。 `stream: true`. - `include_obfuscation: optional boolean` - 当为 true 时,将启用流混淆。流混淆会向 - 字段添加随机字符,用于 `obfuscation` 流式增量事件中的字段,以 - 规范化负载大小,作为对某些侧信道攻击的缓解措施。 - 默认情况下会包含这些混淆字段,但会为数据流增加少量 - 开销。如果信任客户端与 接口 之间的 `include_obfuscation` 设置为 - false 以优化带宽网络链路 + 如果为 true,将启用流混淆。流混淆会向流式增量事件上的 obfuscation 字段添加 + 随机字符,以规范化负载大小,作为对某些侧信道攻击的缓解措施。这些混淆字段默认包含,但会增加少量数据流的开销。如果你信任客户端与 接口 之间的网络链路,可以将 include_obfuscation 设置为 `obfuscation` field on streaming delta events to + normalize payload sizes as a mitigation to certain side-channel attacks. + These obfuscation fields are included by default, but add a small amount + of overhead to the data stream. You can set `include_obfuscation` 为 + false to optimize for bandwidth if you trust the network links between 你的应用与 OpenAI API 之间。 - `include_usage: optional boolean` - 如果设置了该参数,在 [choices] 字段之前会额外流式传输一个 [chunk]。 `data: [DONE]` - 消息。该数据块上的 `usage` 字段展示了整个请求的令牌使用统计信息, - 对于整个请求而言, `choices` 字段始终为一个空的 + 如果设置了该参数,则会在 `data: [DONE]` + 消息之前额外流式返回一个分块。该 `usage` 字段显示整个请求的 token 用量统计信息, + 而该请求的 `choices` 字段将始终为空 数组。 - 所有其他数据块也会包含一个 `usage` 字段,但值为 - null。 **注意:** 如果流被中断,你可能无法收到包含该请求总令牌使用量的 - 最后一个 usage 数据块。 + 所有其他分块也会包含一个 `usage` 字段,但其值为 + null。 **注意:** 如果流被中断,你可能不会收到包含该请求 + 总 token 用量的最后一个 usage 分块。 - `temperature: optional number or null` - 使用的采样温度,取值范围为 0 到 2。较高的值(如 0.8)会使输出更加随机,而较低的值(如 0.2)会使输出更加聚焦和确定。 + 使用的采样温度,介于 0 和 2 之间。较高的值(如 0.8)会使输出更加随机,而较低的值(如 0.2)会使输出更加集中和确定。 我们通常建议修改该参数或 `top_p` ,但不要同时修改两者。 - `tool_choice: optional ChatCompletionToolChoiceOption` - 控制模型调用哪个工具(如果有)。 + 控制模型调用哪些工具(如果有的话)。 `none` 表示模型不会调用任何工具,而是生成一条消息。 - `auto` 表示模型可以在生成消息或调用一个或多个工具之间选择。 + `auto` 表示模型可以在生成消息或调用一个或多个工具之间进行选择。 `required` 表示模型必须调用一个或多个工具。 - 通过指定特定工具 `{"type": "function", "function": {"name": "my_function"}}` 强制模型调用该工具。 + 通过指定特定工具来 `{"type": "function", "function": {"name": "my_function"}}` 强制模型调用该工具。 - `none` 是未提供任何工具时的默认值。 `auto` 是提供了工具时的默认值。 + `none` 是未提供任何工具时的默认行为。 `auto` 是提供了工具时的默认行为。 - `ToolChoiceMode = "none" or "auto" or "required"` - `none` 表示模型不会调用任何工具,而是生成一条消息。 `auto` 表示模型可以在生成消息或调用一个或多个工具之间选择。 `required` 表示模型必须调用一个或多个工具。 + `none` 表示模型不会调用任何工具,而是生成一条消息。 `auto` 表示模型可以在生成消息或调用一个或多个工具之间进行选择。 `required` 表示模型必须调用一个或多个工具。 - `"none"` @@ -1145,17 +1145,17 @@ - `ChatCompletionAllowedToolChoice object { allowed_tools, type }` - 将模型可用的工具限制为预定义的集合。 + 将模型可使用的工具限制为预定义的集合。 - `allowed_tools: ChatCompletionAllowedTools` - 将模型可用的工具限制为预定义的集合。 + 将模型可使用的工具限制为预定义的集合。 - `mode: "auto" or "required"` - 将模型可用的工具限制为预定义的集合。 + 将模型可使用的工具限制为预定义的集合。 - `auto` 允许模型从允许的工具中选取并生成 + `auto` 允许模型从允许的工具中选择并生成 消息。 `required` 要求模型调用一个或多个允许的工具。 @@ -1166,9 +1166,9 @@ - `tools: array of map[unknown]` - 允许模型调用的工具定义列表。 + 模型可调用的工具定义列表。 - 对于 Chat Completions API,工具定义列表可能如下所示: + 对于 Chat Completions API,工具定义列表可能如下: ```json [ @@ -1217,7 +1217,7 @@ - `tools: optional array of ChatCompletionTool` - 模型可以调用的工具列表。你可以提供 + 模型可调用的工具列表。你可以提供 [自定义工具](/docs/guides/function-calling#custom-tools) 或 [函数工具](/docs/guides/function-calling). @@ -1229,25 +1229,25 @@ - `name: string` - 要调用的函数名称。必须由 a-z、A-Z、0-9 组成,或包含下划线和连字符,最大长度为 64。 + 要调用的函数名称。必须为 a-z、A-Z、0-9,或包含下划线和短横线,最大长度为 64。 - `description: optional string` - 对函数功能的描述,模型据此选择何时以及如何调用该函数。 + 对函数作用的描述,模型据此选择何时以及如何调用该函数。 - `parameters: optional FunctionParameters` - 函数接受的参数,使用 JSON Schema 对象描述。请参阅 [指南](/docs/guides/function-calling) 中的示例,以及 [JSON Schema 参考](https://json-schema.org/understanding-json-schema/) ,了解相关格式的文档。 + 函数接受的参数,以 JSON Schema 对象描述。参阅 [指南](/docs/guides/function-calling) 中的示例,以及 [JSON Schema 参考](https://json-schema.org/understanding-json-schema/) 获取有关该格式的文档。 - 省略 `parameters` 定义了一个参数列表为空的函数。 + 省略 `parameters` 用于定义一个参数列表为空的函数。 - `strict: optional boolean or null` - 在生成函数调用时是否启用严格的模式遵循。如果设置为 true,模型将遵循 `parameters` 字段中。当 `strict` 为 `true`。中定义的确切模式。在函数调用指南中了解更多关于结构化输出的信息。 [function calling 指南](/docs/guides/function-calling). + 在生成函数调用时是否启用严格模式遵循。如果设置为 true,模型将遵循 `parameters` 字段时。如需了解更多信息,请参阅 `strict` 为 `true`。中定义的确切模式。详细了解结构化输出,请参阅 [function calling guide](/docs/guides/function-calling). - `type: "function"` - 工具的类型。目前,仅 `function` 。 + 工具的类型。目前,仅 `function` 类型。 - `"function"` @@ -1295,7 +1295,7 @@ - `syntax: "lark" or "regex"` - 语法定义的语法格式。可选值为 `lark` 或 `regex`. + 语法定义的语法格式,取值之一为 `lark` 或 `regex`. - `"lark"` @@ -1315,32 +1315,32 @@ - `top_logprobs: optional number or null` - 介于 0 和 20 之间的整数,指定在每个 token 位置返回的最大最可能 - token 数量,每个 token 附带一个对数 + 一个介于 0 到 20 之间的整数,用于指定在每个 token 位置返回的最可能 + token 的最大数量,每个 token 都有一个关联的对数 概率。在某些情况下,返回的 token 数量可能少于 - 所请求的数量。 - `logprobs` 必须设置为 `true` 才能使用此参数。 + 请求的数量。 + `logprobs` 必须设置为 `true` 如果使用此参数。 - `top_p: optional number or null` - 一种 temperature 采样的替代方法,称为核采样(nucleus sampling), - 其中模型会考虑概率质量处于 top_p 的标记的结果 - 。因此 0.1 表示只考虑构成前 10% 概率质量的标记 + 一种称为核心采样的温度采样替代方案, + 模型只考虑概率累计达到 top_p 的标记结果 + 质量。因此 0.1 表示仅考虑构成前 10% 概率质量的标记 会被纳入考虑。 我们通常建议修改该参数或 `temperature` ,但不要同时修改两者。 - `user: optional string` - 此字段正被替换为 `safety_identifier` 和 `prompt_cache_key`,请改用 `prompt_cache_key` 以保持缓存优化效果。 - 用于标识最终用户的稳定标识符。 + 此字段将被替换为 `safety_identifier` 和 `prompt_cache_key`。使用 `prompt_cache_key` 以保持缓存优化。 + 终端用户的稳定标识符。 用于通过更好地对相似请求进行分桶来提高缓存命中率,并帮助 OpenAI 检测和防止滥用。 [了解更多](/docs/guides/safety-best-practices#safety-identifiers). - `verbosity: optional "low" or "medium" or "high" or null` - 约束模型响应的冗长度。较低的值会导致 - 数值越低,回复越简洁;数值越高,回复越详细。 - 当前支持的值包括 `low`, `medium`,和 `high`。默认值为 + 约束模型回复的详细程度。较低的值会生成 + 更简洁的回复,而较高的值会生成更详尽的回复。 + 当前支持的值包括 `low`, `medium`,以及 `high`。默认值为 `medium`. - `"low"` @@ -1351,13 +1351,13 @@ - `web_search_options: optional object { search_context_size, user_location }` - 此工具会在网页中搜索相关结果以供回复使用。 - 了解更多关于 [网页搜索 工具](/docs/guides/tools-web-search?api-mode=chat). + 该工具可在网络上搜索相关结果以用于回复中。 + 详细了解 [网页搜索工具](/docs/guides/tools-web-search?api-mode=chat). - `search_context_size: optional "low" or "medium" or "high"` - 关于该 - 搜索所用上下文窗口空间的高层级用量指导,取值为以下之一 `low`, `medium`,或 `high`. `medium` 为默认值。 + 用于搜索的上下文窗口空间使用量的高层级指导。取值之一为 + 搜索的。取值之一为 `low`, `medium`,或 `high`. `medium` 是默认值。 - `"low"` @@ -1367,11 +1367,11 @@ - `user_location: optional object { approximate, type } or null` - 搜索所用的大致位置参数。 + 搜索的近似位置参数。 - `approximate: object { city, country, region, timezone }` - 搜索所用的大致位置参数。 + 搜索的近似位置参数。 - `city: optional string` @@ -1380,7 +1380,7 @@ - `country: optional string` 两位字母的 - [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) (针对用户), + [ISO 国家代码](https://en.wikipedia.org/wiki/ISO_3166-1) 所属国家, 例如。 `US`. - `region: optional string` @@ -1390,19 +1390,19 @@ - `timezone: optional string` 该 [IANA 时区](https://timeapi.io/documentation/iana-timezones) - (针对用户),例如。 `America/Los_Angeles`. + 用户的所在地区,例如。 `America/Los_Angeles`. - `type: "approximate"` - 位置近似值的类型。始终为 `approximate`. + 位置近似的方式。始终 `approximate`. - `"approximate"` -### Returns +### 返回值 - `ChatCompletion object { id, choices, created, 7 more }` - 表示模型基于提供的输入返回的聊天补全响应。 + 表示模型根据提供的输入返回的聊天补全响应。 - `id: string` @@ -1410,15 +1410,15 @@ - `choices: array of object { finish_reason, index, logprobs, message }` - 聊天补全选项的列表。如果 `n` 大于 1,则可以包含多个。 + 聊天补全选项的列表。如果 `n` 大于 1,则可能不止一个。 - `finish_reason: "stop" or "length" or "tool_calls" or 2 more` - 模型停止生成 token 的原因。当出现以下情况时,该值将为 `stop` :模型遇到自然停止点或达到提供的停止序列, - `length` :请求中指定的最大 token 数已达到, - `content_filter` :内容因我们的内容过滤器的标记而被省略, - `tool_calls` :模型调用了工具,或 `function_call` (已弃用):模型调用了函数。 - 请阅读 [Model Spec](https://model-spec.openai.com/2025-12-18.html) 了解更多信息。 + 模型停止生成 token 的原因。如果模型遇到自然停止点或提供的停止序列,则为 `stop` ;如果达到请求中指定的最大 token 数,则为, + `length` ;如果因我们的内容过滤器标记而被省略内容,则为, + `content_filter` ;如果模型调用了工具,则为, + `tool_calls` ;如果模型调用了函数,则为 `function_call` (已弃用)。 + 请参阅 [Model Spec](https://model-spec.openai.com/2025-12-18.html) 了解更多信息。 - `"stop"` @@ -1432,7 +1432,7 @@ - `index: number` - 该选项在选项列表中的索引。 + 选项在选项列表中的索引。 - `logprobs: object { content, refusal } or null` @@ -1448,15 +1448,15 @@ - `bytes: array of number or null` - 一个整数列表,表示该 token 的 UTF-8 字节表示。在某些字符由多个 token 表示,且必须组合其字节表示才能生成正确文本表示的情况下非常有用。如果 `null` ,则表示该 token 没有字节表示。 + 表示该 token UTF-8 字节表示的整数列表。在字符由多个 token 表示且必须组合其字节表示才能生成正确文本表示时非常有用。如果该 token 没有字节表示,则可以为 `null` 。 - `logprob: number` - 如果该 token 位于概率最高的前 20 个 token 之内,则为其对数概率。否则,值 `-9999.0` 用于表示该 token 出现的可能性极低。 + 该 token 的对数概率(如果它位于概率最高的 20 个 token 之内)。否则,值为 `-9999.0` 表示该 token 极不可能出现。 - `top_logprobs: array of object { token, bytes, logprob }` - 在该 token 位置处最可能出现的 token 列表及其对数概率。条目数量可能少于请求的 `top_logprobs`. + 在该 token 位置上,最可能出现的 token 及其对数概率的列表。条目数量可能少于所请求的 `top_logprobs`. - `token: string` @@ -1464,15 +1464,15 @@ - `bytes: array of number or null` - 一个整数列表,表示该 token 的 UTF-8 字节表示。在某些字符由多个 token 表示,且必须组合其字节表示才能生成正确文本表示的情况下非常有用。如果 `null` ,则表示该 token 没有字节表示。 + 表示该 token UTF-8 字节表示的整数列表。在字符由多个 token 表示且必须组合其字节表示才能生成正确文本表示时非常有用。如果该 token 没有字节表示,则可以为 `null` 。 - `logprob: number` - 如果该 token 位于概率最高的前 20 个 token 之内,则为其对数概率。否则,值 `-9999.0` 用于表示该 token 出现的可能性极低。 + 该 token 的对数概率(如果它位于概率最高的 20 个 token 之内)。否则,值为 `-9999.0` 表示该 token 极不可能出现。 - `refusal: array of ChatCompletionTokenLogprob or null` - 包含对数概率信息的消息拒绝 token 列表。 + 包含对数概率信息的拒绝消息 token 列表。 - `token: string` @@ -1480,19 +1480,19 @@ - `bytes: array of number or null` - 一个整数列表,表示该 token 的 UTF-8 字节表示。在某些字符由多个 token 表示,且必须组合其字节表示才能生成正确文本表示的情况下非常有用。如果 `null` ,则表示该 token 没有字节表示。 + 表示该 token UTF-8 字节表示的整数列表。在字符由多个 token 表示且必须组合其字节表示才能生成正确文本表示时非常有用。如果该 token 没有字节表示,则可以为 `null` 。 - `logprob: number` - 如果该 token 位于概率最高的前 20 个 token 之内,则为其对数概率。否则,值 `-9999.0` 用于表示该 token 出现的可能性极低。 + 该 token 的对数概率(如果它位于概率最高的 20 个 token 之内)。否则,值为 `-9999.0` 表示该 token 极不可能出现。 - `top_logprobs: array of object { token, bytes, logprob }` - 在该 token 位置处最可能出现的 token 列表及其对数概率。条目数量可能少于请求的 `top_logprobs`. + 在该 token 位置上,最可能出现的 token 及其对数概率的列表。条目数量可能少于所请求的 `top_logprobs`. - `message: ChatCompletionMessage` - 由模型生成的聊天补全消息。 + 由模型生成的聊天完成消息。 - `content: string or null` @@ -1500,18 +1500,18 @@ - `refusal: string or null` - 模型生成的拒绝消息。 + 由模型生成的拒绝消息。 - `role: "assistant"` - 此消息作者的角色。 + 该消息作者的角色。 - `"assistant"` - `annotations: optional array of object { type, url_citation }` - 消息的注解(如适用),例如使用 - [网页搜索 工具](/docs/guides/tools-web-search?api-mode=chat). + 消息的注释(如果适用),例如在使用 + [网页搜索工具](/docs/guides/tools-web-search?api-mode=chat). - `type: "url_citation"` @@ -1529,7 +1529,7 @@ - `start_index: number` - 消息中 URL 引用第一个字符的索引。 + 消息中 URL 引用的第一个字符的索引。 - `title: string` @@ -1541,8 +1541,8 @@ - `audio: optional ChatCompletionAudio or null` - 如果请求了音频输出模态,则此对象包含 - 来自模型的音频响应的相关数据。 [了解更多](/docs/guides/audio). + 如果请求了音频输出模态,该对象包含来自模型的音频 + 响应的相关数据。 [了解更多](/docs/guides/audio). - `id: string` @@ -1550,14 +1550,14 @@ - `data: string` - 由模型生成的 Base64 编码音频字节,格式为 + 模型生成的 Base64 编码音频字节,格式为 请求中指定的格式。 - `expires_at: number` - 此音频响应在服务端不再可访问的 Unix 时间戳(秒),用于多轮 - 对话中的后续使用。 - conversations。 + 此音频响应在服务端上无法再被用于多轮 + 访问的 Unix 时间戳(秒)。 + 对话。 - `transcript: string` @@ -1565,11 +1565,11 @@ - `function_call: optional object { arguments, name }` - 已弃用,由 `tool_calls`。替代。模型生成的应被调用的函数名称和参数。 + 已弃用,由 `tool_calls`。替代。应调用的函数的名称和参数,由模型生成。 - `arguments: string` - 以 JSON 格式传递给函数的参数,由模型生成。请注意,模型并不总是生成有效的 JSON,并且可能会虚构函数 schema 中未定义的参数。在调用函数之前,请在代码中校验这些参数。 + 调用函数时使用的参数,以 JSON 格式由模型生成。请注意,模型并不总是生成有效的 JSON,并且可能会虚构你的函数 schema 中未定义的参数。在调用函数之前,请在代码中校验这些参数。 - `name: string` @@ -1593,7 +1593,7 @@ - `arguments: string` - 以 JSON 格式传递给函数的参数,由模型生成。请注意,模型并不总是生成有效的 JSON,并且可能会虚构函数 schema 中未定义的参数。在调用函数之前,请在代码中校验这些参数。 + 调用函数时使用的参数,以 JSON 格式由模型生成。请注意,模型并不总是生成有效的 JSON,并且可能会虚构你的函数 schema 中未定义的参数。在调用函数之前,请在代码中校验这些参数。 - `name: string` @@ -1601,7 +1601,7 @@ - `type: "function"` - 工具的类型。目前,仅 `function` 。 + 工具的类型。目前,仅 `function` 类型。 - `"function"` @@ -1637,7 +1637,7 @@ - `model: string` - 用于聊天补全的模型。 + 用于该聊天补全的模型。 - `object: "chat.completion"` @@ -1647,21 +1647,21 @@ - `metadata: optional Metadata or null` - 可以附加到对象的 16 组键值对。这可以用于 - 以结构化格式存储有关对象的附加信息,并通过 API 或控制台查询对象。 - 以结构化格式存储有关对象的附加信息,并通过 接口 或控制台查询对象。 + 可附加到对象的 16 组键值对。可用于 + 以结构化格式存储有关对象的其他信息,并通过 API 或控制台查询对象。 + 以结构化格式存储有关对象的其他信息,并通过 接口 或控制台查询对象。 - 键是字符串,最大长度为 64 个字符。值是字符串, + 键为字符串,最大长度为 64 个字符。值为字符串, 最大长度为 512 个字符。 - `moderation: optional object { input, output } or null` - 请求输入和生成输出的审核结果(若请求了审核补全) - completions。 + 请求输入和生成输出的审核结果(如果请求了 + 补全审核)。 - `input: object { model, results, type } or object { code, message, type }` - 请求输入的审核结果。 + 对请求输入的审核。 - `ModerationResults object { model, results, type }` @@ -1677,11 +1677,11 @@ - `categories: map[boolean]` - 审核类别到布尔值的字典,若输入在该类别下被标记则为 True。 + 一个从审核类别到布尔值的字典,若输入在该类别下被标记则为 True。 - `category_applied_input_types: map[array of "text" or "image"]` - 每个类别的分数所对应的输入模态。 + 每个类别的分数所反映的输入模态。 - `"text"` @@ -1689,19 +1689,19 @@ - `category_scores: map[number]` - 审核类别到分数的字典。 + 一个从审核类别到分数的字典。 - `flagged: boolean` - 指示内容是否被任意类别标记的布尔值。 + 一个布尔值,指示内容是否被任何类别标记。 - `model: string` - 生成该结果的审核模型。 + 生成此结果的审核模型。 - `type: "moderation_result"` - 对象类型,过去始终为 `moderation_result` (用于成功的审核结果)。 + 对象类型,在成功的审核结果中始终为 `moderation_result` 。 - `"moderation_result"` @@ -1721,7 +1721,7 @@ - `message: string` - 错误信息。 + 错误消息。 - `type: "error"` @@ -1731,7 +1731,7 @@ - `output: object { model, results, type } or object { code, message, type }` - 对生成输出的内容审核。 + 生成输出的审核。 - `ModerationResults object { model, results, type }` @@ -1747,11 +1747,11 @@ - `categories: map[boolean]` - 审核类别到布尔值的字典,若输入在该类别下被标记则为 True。 + 一个从审核类别到布尔值的字典,若输入在该类别下被标记则为 True。 - `category_applied_input_types: map[array of "text" or "image"]` - 每个类别的分数所对应的输入模态。 + 每个类别的分数所反映的输入模态。 - `"text"` @@ -1759,19 +1759,19 @@ - `category_scores: map[number]` - 审核类别到分数的字典。 + 一个从审核类别到分数的字典。 - `flagged: boolean` - 指示内容是否被任意类别标记的布尔值。 + 一个布尔值,指示内容是否被任何类别标记。 - `model: string` - 生成该结果的审核模型。 + 生成此结果的审核模型。 - `type: "moderation_result"` - 对象类型,过去始终为 `moderation_result` (用于成功的审核结果)。 + 对象类型,在成功的审核结果中始终为 `moderation_result` 。 - `"moderation_result"` @@ -1791,7 +1791,7 @@ - `message: string` - 错误信息。 + 错误消息。 - `type: "error"` @@ -1803,13 +1803,13 @@ 指定用于处理请求的处理类型。 - - 如果设置为 'auto',则请求将按照项目设置中配置的服务层级处理。除非另行配置,项目将使用 'default'。 - - 如果设置为 'default',则请求将以所选模型的标准定价和性能进行处理。 + - 如果设置为 'auto',则请求将使用 Project 设置中配置的服务层级进行处理。除非另行配置,否则该 Project 将使用 'default'。 + - 如果设置为 'default',则请求将使用所选模型的标准定价和性能进行处理。 - 如果设置为 '[flex](/docs/guides/flex-processing)',则请求将使用 Flex Processing 服务层级进行处理。 - - 若要在请求级别启用 [Fast mode](/api/docs/guides/fast-mode) ,请在 Responses 或 Chat Completions 中包含 `service_tier=fast` 或 `service_tier=priority` 参数。响应中将显示 `service_tier=priority` ,无论你是否在请求中指定了 `service_tier=fast` 或 `priority` 。 + - 要在请求级别启用 [Fast mode](/api/docs/guides/fast-mode) ,请在 Responses 或 Chat Completions 中包含 `service_tier=fast` 或 `service_tier=priority` 参数。响应中将显示 `service_tier=priority` ,无论你是否在请求中指定 `service_tier=fast` 或 `priority` 。 - 未设置时,默认行为为 'auto'。 - 当 `service_tier` 参数被设置时,响应体将根据实际用于处理请求的处理模式返回 `service_tier` 值。该响应值可能与参数中设置的值不同。 + 当设置了 `service_tier` 参数时,响应主体将根据实际用于处理该请求的处理模式包含对应的 `service_tier` 值。该响应值可能与参数中设置的值不同。 - `"auto"` @@ -1825,82 +1825,82 @@ - `system_fingerprint: optional string` - 此指纹表示模型运行所用的后端配置。 + 此指纹表示模型运行所使用的后端配置。 - 可与 `seed` 请求参数结合使用,以了解何时发生了可能影响确定性的后端变更。 + 可与 `seed` 请求参数结合使用,以了解何时进行了可能影响确定性的后端变更。 - `usage: optional CompletionUsage` - 该补全请求的使用统计信息。 + 补全请求的使用情况统计信息。 - `completion_tokens: number` - 生成补全中的令牌数量。 + 生成补全中的 token 数。 - `prompt_tokens: number` - 提示中的令牌数量。 + 提示中的 token 数。 - `total_tokens: number` - 请求中使用的令牌总数(提示 + 补全)。 + 请求中使用的总 token 数(提示 + 补全)。 - `completion_tokens_details: optional object { accepted_prediction_tokens, audio_tokens, reasoning_tokens, 2 more }` - 补全中使用的令牌细分。 + 补全中使用的 token 明细。 - `accepted_prediction_tokens: optional number` 使用 Predicted Outputs 时, - 出现在补全中的预测令牌数量。 + 补全中出现的预测 token 数。 - `audio_tokens: optional number` - 由模型生成的音频输入令牌。 + 模型生成的音频输入 token。 - `reasoning_tokens: optional number` - 由模型生成用于推理的令牌。 + 模型为推理生成的 token。 - `rejected_prediction_tokens: optional number` 使用 Predicted Outputs 时, - 未出现在补全中的预测令牌。但是,与 - 推理令牌一样,这些令牌仍会计入用于计费、 - 输出和上下文窗口用途的补全令牌总数 - 限制中。 + 未在补全中出现的预测 token。但是,与 + 推理 token 一样,这些 token 仍会计入 + 用于计费、输出和上下文窗口限制的 + 总补全 token 数中。 - `text_tokens: optional number` - 由模型生成的文本输出令牌。 + 模型生成的文本输出 token。 - `compute_units: optional number or null` - 该请求的计算单元。目前可用时为 null。 + 请求的计算单元。目前可用时为 null。 - `prompt_tokens_details: optional object { audio_tokens, cache_write_tokens, cached_tokens, 2 more }` - 提示中使用的 token 分类明细。 + 提示词中所使用 token 的明细。 - `audio_tokens: optional number` - 提示中存在的音频输入 token。 + 提示词中存在的音频输入 token。 - `cache_write_tokens: optional number` - 写入缓存的未调整提示 token 数量。 + 写入缓存的提示词 token 未调整数量。 - `cached_tokens: optional number` - 提示中存在的已缓存 token。 + 提示词中存在的已缓存 token。 - `image_tokens: optional number` - 提示中存在的图像输入 token。 + 提示词中存在的图像输入 token。 - `text_tokens: optional number` - 提示中存在的文本输入 token。 + 提示词中存在的文本输入 token。 ### 示例 @@ -1915,7 +1915,7 @@ curl https://api.openai.com/v1/chat/completions \ "role": "developer" } ], - "model": "gpt-5.4", + "model": "gpt-5.6-sol", "n": 1, "prompt_cache_key": "prompt-cache-key-1234", "safety_identifier": "safety-identifier-1234", @@ -2094,7 +2094,7 @@ curl https://api.openai.com/v1/chat/completions \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $OPENAI_API_KEY" \ -d '{ - "model": "VAR_chat_model_id", + "model": "gpt-5.6-sol", "messages": [ { "role": "developer", @@ -2115,7 +2115,7 @@ curl https://api.openai.com/v1/chat/completions \ "id": "chatcmpl-B9MBs8CjcvOU2jLn4n570S5qMJKcT", "object": "chat.completion", "created": 1741569952, - "model": "gpt-5.4", + "model": "gpt-5.6-sol", "choices": [ { "index": 0, @@ -2155,7 +2155,7 @@ curl https://api.openai.com/v1/chat/completions \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $OPENAI_API_KEY" \ -d '{ - "model": "gpt-5.4", + "model": "gpt-5.6-sol", "messages": [ { "role": "user", @@ -2196,7 +2196,7 @@ curl https://api.openai.com/v1/chat/completions \ "id": "chatcmpl-abc123", "object": "chat.completion", "created": 1699896916, - "model": "gpt-4o-mini", + "model": "gpt-5.6-sol", "choices": [ { "index": 0, @@ -2238,7 +2238,7 @@ curl https://api.openai.com/v1/chat/completions \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $OPENAI_API_KEY" \ -d '{ - "model": "gpt-5.4", + "model": "gpt-5.6-sol", "messages": [ { "role": "user", @@ -2267,7 +2267,7 @@ curl https://api.openai.com/v1/chat/completions \ "id": "chatcmpl-B9MHDbslfkBeAs8l4bebGdFOJ6PeG", "object": "chat.completion", "created": 1741570283, - "model": "gpt-5.4", + "model": "gpt-5.6-sol", "choices": [ { "index": 0, @@ -2307,13 +2307,14 @@ curl https://api.openai.com/v1/chat/completions \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $OPENAI_API_KEY" \ -d '{ - "model": "VAR_chat_model_id", + "model": "gpt-5.6-sol", "messages": [ { "role": "user", "content": "Hello!" } ], + "reasoning_effort": "none", "logprobs": true, "top_logprobs": 2 }' @@ -2326,7 +2327,7 @@ curl https://api.openai.com/v1/chat/completions \ "id": "chatcmpl-123", "object": "chat.completion", "created": 1702685778, - "model": "gpt-4o-mini", + "model": "gpt-5.6-sol", "choices": [ { "index": 0, @@ -2520,7 +2521,7 @@ curl https://api.openai.com/v1/chat/completions \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $OPENAI_API_KEY" \ -d '{ - "model": "VAR_chat_model_id", + "model": "gpt-5.6-sol", "messages": [ { "role": "developer", @@ -2538,37 +2539,37 @@ curl https://api.openai.com/v1/chat/completions \ #### 响应 ```json -{"id":"chatcmpl-123","object":"chat.completion.chunk","created":1694268190,"model":"gpt-4o-mini", "system_fingerprint": "fp_44709d6fcb", "choices":[{"index":0,"delta":{"role":"assistant","content":""},"logprobs":null,"finish_reason":null}]} +{"id":"chatcmpl-123","object":"chat.completion.chunk","created":1694268190,"model":"gpt-5.6-sol", "system_fingerprint": "fp_44709d6fcb", "choices":[{"index":0,"delta":{"role":"assistant","content":""},"logprobs":null,"finish_reason":null}]} -{"id":"chatcmpl-123","object":"chat.completion.chunk","created":1694268190,"model":"gpt-4o-mini", "system_fingerprint": "fp_44709d6fcb", "choices":[{"index":0,"delta":{"content":"Hello"},"logprobs":null,"finish_reason":null}]} +{"id":"chatcmpl-123","object":"chat.completion.chunk","created":1694268190,"model":"gpt-5.6-sol", "system_fingerprint": "fp_44709d6fcb", "choices":[{"index":0,"delta":{"content":"Hello"},"logprobs":null,"finish_reason":null}]} .... -{"id":"chatcmpl-123","object":"chat.completion.chunk","created":1694268190,"model":"gpt-4o-mini", "system_fingerprint": "fp_44709d6fcb", "choices":[{"index":0,"delta":{},"logprobs":null,"finish_reason":"stop"}]} +{"id":"chatcmpl-123","object":"chat.completion.chunk","created":1694268190,"model":"gpt-5.6-sol", "system_fingerprint": "fp_44709d6fcb", "choices":[{"index":0,"delta":{},"logprobs":null,"finish_reason":"stop"}]} ``` ## 删除聊天补全 **delete** `/chat/completions/{completion_id}` -删除已存储的聊天补全。只能删除通过 -以下参数创建的 `store` 参数设置为 `true` 的聊天补全。 +删除已存储的聊天补全。仅可删除使用 +参数设为 `store` 创建的 Chat Completions `true` 。 ### 路径参数 - `completion_id: string` -### Returns +### 返回值 - `ChatCompletionDeleted object { id, deleted, object }` - `id: string` - 被删除的聊天补全的 ID。 + 已删除的聊天补全的 ID。 - `deleted: boolean` - 聊天补全是否已被删除。 + 聊天补全是否已删除。 - `object: "chat.completion.deleted"` @@ -2612,18 +2613,18 @@ curl -X DELETE https://api.openai.com/v1/chat/completions/chat_abc123 \ } ``` -## Chat Completions 列表 +## 聊天补全列表 **get** `/chat/completions` -列出已存储的 Chat Completions。仅返回通过 -存储的 Chat Completions。 `store` 参数设置为 `true` 将会被返回。 +列出已存储的 Chat Completions。仅返回通过 store 参数设置为存储的 Chat Completions。 +with the `store` 创建的 Chat Completions `true` 将不会被返回。 ### 查询参数 - `after: optional string` - 上一次分页请求中最后一条 Chat Completion 的标识符。 + 上一个分页请求所返回的最后一次 chat completion 的标识符。 - `limit: optional number` @@ -2631,7 +2632,7 @@ curl -X DELETE https://api.openai.com/v1/chat/completions/chat_abc123 \ - `metadata: optional Metadata or null` - 用于按元数据键过滤 Chat Completions 的列表。例如: + 用于筛选 Chat Completions 的元数据键列表。示例: `metadata[key1]=value1&metadata[key2]=value2` @@ -2641,17 +2642,17 @@ curl -X DELETE https://api.openai.com/v1/chat/completions/chat_abc123 \ - `order: optional "asc" or "desc"` - 按时间戳对 Chat Completions 排序的方式。使用 `asc` 表示升序,或 `desc` 表示降序。默认为 `asc`. + 按时间戳排序 Chat Completions 的顺序。使用 `asc` 表示升序,或使用 `desc` 表示降序。默认为 `asc`. - `"asc"` - `"desc"` -### Returns +### 返回值 - `data: array of ChatCompletion` - 一个由 chat completion 对象组成的数组。 + chat completion 对象数组。 - `id: string` @@ -2659,15 +2660,15 @@ curl -X DELETE https://api.openai.com/v1/chat/completions/chat_abc123 \ - `choices: array of object { finish_reason, index, logprobs, message }` - 聊天补全选项的列表。如果 `n` 大于 1,则可以包含多个。 + 聊天补全选项的列表。如果 `n` 大于 1,则可能不止一个。 - `finish_reason: "stop" or "length" or "tool_calls" or 2 more` - 模型停止生成 token 的原因。当出现以下情况时,该值将为 `stop` :模型遇到自然停止点或达到提供的停止序列, - `length` :请求中指定的最大 token 数已达到, - `content_filter` :内容因我们的内容过滤器的标记而被省略, - `tool_calls` :模型调用了工具,或 `function_call` (已弃用):模型调用了函数。 - 请阅读 [Model Spec](https://model-spec.openai.com/2025-12-18.html) 了解更多信息。 + 模型停止生成 token 的原因。如果模型遇到自然停止点或提供的停止序列,则为 `stop` ;如果达到请求中指定的最大 token 数,则为, + `length` ;如果因我们的内容过滤器标记而被省略内容,则为, + `content_filter` ;如果模型调用了工具,则为, + `tool_calls` ;如果模型调用了函数,则为 `function_call` (已弃用)。 + 请参阅 [Model Spec](https://model-spec.openai.com/2025-12-18.html) 了解更多信息。 - `"stop"` @@ -2681,7 +2682,7 @@ curl -X DELETE https://api.openai.com/v1/chat/completions/chat_abc123 \ - `index: number` - 该选项在选项列表中的索引。 + 选项在选项列表中的索引。 - `logprobs: object { content, refusal } or null` @@ -2697,15 +2698,15 @@ curl -X DELETE https://api.openai.com/v1/chat/completions/chat_abc123 \ - `bytes: array of number or null` - 一个整数列表,表示该 token 的 UTF-8 字节表示。在某些字符由多个 token 表示,且必须组合其字节表示才能生成正确文本表示的情况下非常有用。如果 `null` ,则表示该 token 没有字节表示。 + 表示该 token UTF-8 字节表示的整数列表。在字符由多个 token 表示且必须组合其字节表示才能生成正确文本表示时非常有用。如果该 token 没有字节表示,则可以为 `null` 。 - `logprob: number` - 如果该 token 位于概率最高的前 20 个 token 之内,则为其对数概率。否则,值 `-9999.0` 用于表示该 token 出现的可能性极低。 + 该 token 的对数概率(如果它位于概率最高的 20 个 token 之内)。否则,值为 `-9999.0` 表示该 token 极不可能出现。 - `top_logprobs: array of object { token, bytes, logprob }` - 在该 token 位置处最可能出现的 token 列表及其对数概率。条目数量可能少于请求的 `top_logprobs`. + 在该 token 位置上,最可能出现的 token 及其对数概率的列表。条目数量可能少于所请求的 `top_logprobs`. - `token: string` @@ -2713,15 +2714,15 @@ curl -X DELETE https://api.openai.com/v1/chat/completions/chat_abc123 \ - `bytes: array of number or null` - 一个整数列表,表示该 token 的 UTF-8 字节表示。在某些字符由多个 token 表示,且必须组合其字节表示才能生成正确文本表示的情况下非常有用。如果 `null` ,则表示该 token 没有字节表示。 + 表示该 token UTF-8 字节表示的整数列表。在字符由多个 token 表示且必须组合其字节表示才能生成正确文本表示时非常有用。如果该 token 没有字节表示,则可以为 `null` 。 - `logprob: number` - 如果该 token 位于概率最高的前 20 个 token 之内,则为其对数概率。否则,值 `-9999.0` 用于表示该 token 出现的可能性极低。 + 该 token 的对数概率(如果它位于概率最高的 20 个 token 之内)。否则,值为 `-9999.0` 表示该 token 极不可能出现。 - `refusal: array of ChatCompletionTokenLogprob or null` - 包含对数概率信息的消息拒绝 token 列表。 + 包含对数概率信息的拒绝消息 token 列表。 - `token: string` @@ -2729,19 +2730,19 @@ curl -X DELETE https://api.openai.com/v1/chat/completions/chat_abc123 \ - `bytes: array of number or null` - 一个整数列表,表示该 token 的 UTF-8 字节表示。在某些字符由多个 token 表示,且必须组合其字节表示才能生成正确文本表示的情况下非常有用。如果 `null` ,则表示该 token 没有字节表示。 + 表示该 token UTF-8 字节表示的整数列表。在字符由多个 token 表示且必须组合其字节表示才能生成正确文本表示时非常有用。如果该 token 没有字节表示,则可以为 `null` 。 - `logprob: number` - 如果该 token 位于概率最高的前 20 个 token 之内,则为其对数概率。否则,值 `-9999.0` 用于表示该 token 出现的可能性极低。 + 该 token 的对数概率(如果它位于概率最高的 20 个 token 之内)。否则,值为 `-9999.0` 表示该 token 极不可能出现。 - `top_logprobs: array of object { token, bytes, logprob }` - 在该 token 位置处最可能出现的 token 列表及其对数概率。条目数量可能少于请求的 `top_logprobs`. + 在该 token 位置上,最可能出现的 token 及其对数概率的列表。条目数量可能少于所请求的 `top_logprobs`. - `message: ChatCompletionMessage` - 由模型生成的聊天补全消息。 + 由模型生成的聊天完成消息。 - `content: string or null` @@ -2749,18 +2750,18 @@ curl -X DELETE https://api.openai.com/v1/chat/completions/chat_abc123 \ - `refusal: string or null` - 模型生成的拒绝消息。 + 由模型生成的拒绝消息。 - `role: "assistant"` - 此消息作者的角色。 + 该消息作者的角色。 - `"assistant"` - `annotations: optional array of object { type, url_citation }` - 消息的注解(如适用),例如使用 - [网页搜索 工具](/docs/guides/tools-web-search?api-mode=chat). + 消息的注释(如果适用),例如在使用 + [网页搜索工具](/docs/guides/tools-web-search?api-mode=chat). - `type: "url_citation"` @@ -2778,7 +2779,7 @@ curl -X DELETE https://api.openai.com/v1/chat/completions/chat_abc123 \ - `start_index: number` - 消息中 URL 引用第一个字符的索引。 + 消息中 URL 引用的第一个字符的索引。 - `title: string` @@ -2790,8 +2791,8 @@ curl -X DELETE https://api.openai.com/v1/chat/completions/chat_abc123 \ - `audio: optional ChatCompletionAudio or null` - 如果请求了音频输出模态,则此对象包含 - 来自模型的音频响应的相关数据。 [了解更多](/docs/guides/audio). + 如果请求了音频输出模态,该对象包含来自模型的音频 + 响应的相关数据。 [了解更多](/docs/guides/audio). - `id: string` @@ -2799,14 +2800,14 @@ curl -X DELETE https://api.openai.com/v1/chat/completions/chat_abc123 \ - `data: string` - 由模型生成的 Base64 编码音频字节,格式为 + 模型生成的 Base64 编码音频字节,格式为 请求中指定的格式。 - `expires_at: number` - 此音频响应在服务端不再可访问的 Unix 时间戳(秒),用于多轮 - 对话中的后续使用。 - conversations。 + 此音频响应在服务端上无法再被用于多轮 + 访问的 Unix 时间戳(秒)。 + 对话。 - `transcript: string` @@ -2814,11 +2815,11 @@ curl -X DELETE https://api.openai.com/v1/chat/completions/chat_abc123 \ - `function_call: optional object { arguments, name }` - 已弃用,由 `tool_calls`。替代。模型生成的应被调用的函数名称和参数。 + 已弃用,由 `tool_calls`。替代。应调用的函数的名称和参数,由模型生成。 - `arguments: string` - 以 JSON 格式传递给函数的参数,由模型生成。请注意,模型并不总是生成有效的 JSON,并且可能会虚构函数 schema 中未定义的参数。在调用函数之前,请在代码中校验这些参数。 + 调用函数时使用的参数,以 JSON 格式由模型生成。请注意,模型并不总是生成有效的 JSON,并且可能会虚构你的函数 schema 中未定义的参数。在调用函数之前,请在代码中校验这些参数。 - `name: string` @@ -2842,7 +2843,7 @@ curl -X DELETE https://api.openai.com/v1/chat/completions/chat_abc123 \ - `arguments: string` - 以 JSON 格式传递给函数的参数,由模型生成。请注意,模型并不总是生成有效的 JSON,并且可能会虚构函数 schema 中未定义的参数。在调用函数之前,请在代码中校验这些参数。 + 调用函数时使用的参数,以 JSON 格式由模型生成。请注意,模型并不总是生成有效的 JSON,并且可能会虚构你的函数 schema 中未定义的参数。在调用函数之前,请在代码中校验这些参数。 - `name: string` @@ -2850,7 +2851,7 @@ curl -X DELETE https://api.openai.com/v1/chat/completions/chat_abc123 \ - `type: "function"` - 工具的类型。目前,仅 `function` 。 + 工具的类型。目前,仅 `function` 类型。 - `"function"` @@ -2886,7 +2887,7 @@ curl -X DELETE https://api.openai.com/v1/chat/completions/chat_abc123 \ - `model: string` - 用于聊天补全的模型。 + 用于该聊天补全的模型。 - `object: "chat.completion"` @@ -2896,21 +2897,21 @@ curl -X DELETE https://api.openai.com/v1/chat/completions/chat_abc123 \ - `metadata: optional Metadata or null` - 可以附加到对象的 16 组键值对。这可以用于 - 以结构化格式存储有关对象的附加信息,并通过 API 或控制台查询对象。 - 以结构化格式存储有关对象的附加信息,并通过 接口 或控制台查询对象。 + 可附加到对象的 16 组键值对。可用于 + 以结构化格式存储有关对象的其他信息,并通过 API 或控制台查询对象。 + 以结构化格式存储有关对象的其他信息,并通过 接口 或控制台查询对象。 - 键是字符串,最大长度为 64 个字符。值是字符串, + 键为字符串,最大长度为 64 个字符。值为字符串, 最大长度为 512 个字符。 - `moderation: optional object { input, output } or null` - 请求输入和生成输出的审核结果(若请求了审核补全) - completions。 + 请求输入和生成输出的审核结果(如果请求了 + 补全审核)。 - `input: object { model, results, type } or object { code, message, type }` - 请求输入的审核结果。 + 对请求输入的审核。 - `ModerationResults object { model, results, type }` @@ -2926,11 +2927,11 @@ curl -X DELETE https://api.openai.com/v1/chat/completions/chat_abc123 \ - `categories: map[boolean]` - 审核类别到布尔值的字典,若输入在该类别下被标记则为 True。 + 一个从审核类别到布尔值的字典,若输入在该类别下被标记则为 True。 - `category_applied_input_types: map[array of "text" or "image"]` - 每个类别的分数所对应的输入模态。 + 每个类别的分数所反映的输入模态。 - `"text"` @@ -2938,19 +2939,19 @@ curl -X DELETE https://api.openai.com/v1/chat/completions/chat_abc123 \ - `category_scores: map[number]` - 审核类别到分数的字典。 + 一个从审核类别到分数的字典。 - `flagged: boolean` - 指示内容是否被任意类别标记的布尔值。 + 一个布尔值,指示内容是否被任何类别标记。 - `model: string` - 生成该结果的审核模型。 + 生成此结果的审核模型。 - `type: "moderation_result"` - 对象类型,过去始终为 `moderation_result` (用于成功的审核结果)。 + 对象类型,在成功的审核结果中始终为 `moderation_result` 。 - `"moderation_result"` @@ -2970,7 +2971,7 @@ curl -X DELETE https://api.openai.com/v1/chat/completions/chat_abc123 \ - `message: string` - 错误信息。 + 错误消息。 - `type: "error"` @@ -2980,7 +2981,7 @@ curl -X DELETE https://api.openai.com/v1/chat/completions/chat_abc123 \ - `output: object { model, results, type } or object { code, message, type }` - 对生成输出的内容审核。 + 生成输出的审核。 - `ModerationResults object { model, results, type }` @@ -2996,11 +2997,11 @@ curl -X DELETE https://api.openai.com/v1/chat/completions/chat_abc123 \ - `categories: map[boolean]` - 审核类别到布尔值的字典,若输入在该类别下被标记则为 True。 + 一个从审核类别到布尔值的字典,若输入在该类别下被标记则为 True。 - `category_applied_input_types: map[array of "text" or "image"]` - 每个类别的分数所对应的输入模态。 + 每个类别的分数所反映的输入模态。 - `"text"` @@ -3008,19 +3009,19 @@ curl -X DELETE https://api.openai.com/v1/chat/completions/chat_abc123 \ - `category_scores: map[number]` - 审核类别到分数的字典。 + 一个从审核类别到分数的字典。 - `flagged: boolean` - 指示内容是否被任意类别标记的布尔值。 + 一个布尔值,指示内容是否被任何类别标记。 - `model: string` - 生成该结果的审核模型。 + 生成此结果的审核模型。 - `type: "moderation_result"` - 对象类型,过去始终为 `moderation_result` (用于成功的审核结果)。 + 对象类型,在成功的审核结果中始终为 `moderation_result` 。 - `"moderation_result"` @@ -3040,7 +3041,7 @@ curl -X DELETE https://api.openai.com/v1/chat/completions/chat_abc123 \ - `message: string` - 错误信息。 + 错误消息。 - `type: "error"` @@ -3052,13 +3053,13 @@ curl -X DELETE https://api.openai.com/v1/chat/completions/chat_abc123 \ 指定用于处理请求的处理类型。 - - 如果设置为 'auto',则请求将按照项目设置中配置的服务层级处理。除非另行配置,项目将使用 'default'。 - - 如果设置为 'default',则请求将以所选模型的标准定价和性能进行处理。 + - 如果设置为 'auto',则请求将使用 Project 设置中配置的服务层级进行处理。除非另行配置,否则该 Project 将使用 'default'。 + - 如果设置为 'default',则请求将使用所选模型的标准定价和性能进行处理。 - 如果设置为 '[flex](/docs/guides/flex-processing)',则请求将使用 Flex Processing 服务层级进行处理。 - - 若要在请求级别启用 [Fast mode](/api/docs/guides/fast-mode) ,请在 Responses 或 Chat Completions 中包含 `service_tier=fast` 或 `service_tier=priority` 参数。响应中将显示 `service_tier=priority` ,无论你是否在请求中指定了 `service_tier=fast` 或 `priority` 。 + - 要在请求级别启用 [Fast mode](/api/docs/guides/fast-mode) ,请在 Responses 或 Chat Completions 中包含 `service_tier=fast` 或 `service_tier=priority` 参数。响应中将显示 `service_tier=priority` ,无论你是否在请求中指定 `service_tier=fast` 或 `priority` 。 - 未设置时,默认行为为 'auto'。 - 当 `service_tier` 参数被设置时,响应体将根据实际用于处理请求的处理模式返回 `service_tier` 值。该响应值可能与参数中设置的值不同。 + 当设置了 `service_tier` 参数时,响应主体将根据实际用于处理该请求的处理模式包含对应的 `service_tier` 值。该响应值可能与参数中设置的值不同。 - `"auto"` @@ -3074,82 +3075,82 @@ curl -X DELETE https://api.openai.com/v1/chat/completions/chat_abc123 \ - `system_fingerprint: optional string` - 此指纹表示模型运行所用的后端配置。 + 此指纹表示模型运行所使用的后端配置。 - 可与 `seed` 请求参数结合使用,以了解何时发生了可能影响确定性的后端变更。 + 可与 `seed` 请求参数结合使用,以了解何时进行了可能影响确定性的后端变更。 - `usage: optional CompletionUsage` - 该补全请求的使用统计信息。 + 补全请求的使用情况统计信息。 - `completion_tokens: number` - 生成补全中的令牌数量。 + 生成补全中的 token 数。 - `prompt_tokens: number` - 提示中的令牌数量。 + 提示中的 token 数。 - `total_tokens: number` - 请求中使用的令牌总数(提示 + 补全)。 + 请求中使用的总 token 数(提示 + 补全)。 - `completion_tokens_details: optional object { accepted_prediction_tokens, audio_tokens, reasoning_tokens, 2 more }` - 补全中使用的令牌细分。 + 补全中使用的 token 明细。 - `accepted_prediction_tokens: optional number` 使用 Predicted Outputs 时, - 出现在补全中的预测令牌数量。 + 补全中出现的预测 token 数。 - `audio_tokens: optional number` - 由模型生成的音频输入令牌。 + 模型生成的音频输入 token。 - `reasoning_tokens: optional number` - 由模型生成用于推理的令牌。 + 模型为推理生成的 token。 - `rejected_prediction_tokens: optional number` 使用 Predicted Outputs 时, - 未出现在补全中的预测令牌。但是,与 - 推理令牌一样,这些令牌仍会计入用于计费、 - 输出和上下文窗口用途的补全令牌总数 - 限制中。 + 未在补全中出现的预测 token。但是,与 + 推理 token 一样,这些 token 仍会计入 + 用于计费、输出和上下文窗口限制的 + 总补全 token 数中。 - `text_tokens: optional number` - 由模型生成的文本输出令牌。 + 模型生成的文本输出 token。 - `compute_units: optional number or null` - 该请求的计算单元。目前可用时为 null。 + 请求的计算单元。目前可用时为 null。 - `prompt_tokens_details: optional object { audio_tokens, cache_write_tokens, cached_tokens, 2 more }` - 提示中使用的 token 分类明细。 + 提示词中所使用 token 的明细。 - `audio_tokens: optional number` - 提示中存在的音频输入 token。 + 提示词中存在的音频输入 token。 - `cache_write_tokens: optional number` - 写入缓存的未调整提示 token 数量。 + 写入缓存的提示词 token 未调整数量。 - `cached_tokens: optional number` - 提示中存在的已缓存 token。 + 提示词中存在的已缓存 token。 - `image_tokens: optional number` - 提示中存在的图像输入 token。 + 提示词中存在的图像输入 token。 - `text_tokens: optional number` - 提示中存在的文本输入 token。 + 提示词中存在的文本输入 token。 - `first_id: string` @@ -3157,7 +3158,7 @@ curl -X DELETE https://api.openai.com/v1/chat/completions/chat_abc123 \ - `has_more: boolean` - 指示是否还有更多可用的 Chat Completions。 + 指示是否还有更多 Chat Completions 可供检索。 - `last_id: string` @@ -3165,7 +3166,7 @@ curl -X DELETE https://api.openai.com/v1/chat/completions/chat_abc123 \ - `object: "list"` - 该对象的类型,固定为 "list"。 + 此对象的类型。始终设置为 "list"。 - `"list"` @@ -3363,7 +3364,7 @@ curl https://api.openai.com/v1/chat/completions \ { "object": "chat.completion", "id": "chatcmpl-AyPNinnUqUDYo9SAdA52NobMflmj2", - "model": "gpt-5.4", + "model": "gpt-5.6-sol", "created": 1738960610, "request_id": "req_ded8ab984ec4bf840f37566c1011c417", "tool_choice": null, @@ -3408,18 +3409,18 @@ curl https://api.openai.com/v1/chat/completions \ **get** `/chat/completions/{completion_id}` -获取已存储的聊天补全。仅限已创建的 Chat Completions -存储的 Chat Completions。 `store` 参数设置为 `true` 将会被返回。 +获取已存储的对话补全。仅限已创建的 Chat Completions +with the `store` 创建的 Chat Completions `true` 将不会被返回。 ### 路径参数 - `completion_id: string` -### Returns +### 返回值 - `ChatCompletion object { id, choices, created, 7 more }` - 表示模型基于提供的输入返回的聊天补全响应。 + 表示模型根据提供的输入返回的聊天补全响应。 - `id: string` @@ -3427,15 +3428,15 @@ curl https://api.openai.com/v1/chat/completions \ - `choices: array of object { finish_reason, index, logprobs, message }` - 聊天补全选项的列表。如果 `n` 大于 1,则可以包含多个。 + 聊天补全选项的列表。如果 `n` 大于 1,则可能不止一个。 - `finish_reason: "stop" or "length" or "tool_calls" or 2 more` - 模型停止生成 token 的原因。当出现以下情况时,该值将为 `stop` :模型遇到自然停止点或达到提供的停止序列, - `length` :请求中指定的最大 token 数已达到, - `content_filter` :内容因我们的内容过滤器的标记而被省略, - `tool_calls` :模型调用了工具,或 `function_call` (已弃用):模型调用了函数。 - 请阅读 [Model Spec](https://model-spec.openai.com/2025-12-18.html) 了解更多信息。 + 模型停止生成 token 的原因。如果模型遇到自然停止点或提供的停止序列,则为 `stop` ;如果达到请求中指定的最大 token 数,则为, + `length` ;如果因我们的内容过滤器标记而被省略内容,则为, + `content_filter` ;如果模型调用了工具,则为, + `tool_calls` ;如果模型调用了函数,则为 `function_call` (已弃用)。 + 请参阅 [Model Spec](https://model-spec.openai.com/2025-12-18.html) 了解更多信息。 - `"stop"` @@ -3449,7 +3450,7 @@ curl https://api.openai.com/v1/chat/completions \ - `index: number` - 该选项在选项列表中的索引。 + 选项在选项列表中的索引。 - `logprobs: object { content, refusal } or null` @@ -3465,15 +3466,15 @@ curl https://api.openai.com/v1/chat/completions \ - `bytes: array of number or null` - 一个整数列表,表示该 token 的 UTF-8 字节表示。在某些字符由多个 token 表示,且必须组合其字节表示才能生成正确文本表示的情况下非常有用。如果 `null` ,则表示该 token 没有字节表示。 + 表示该 token UTF-8 字节表示的整数列表。在字符由多个 token 表示且必须组合其字节表示才能生成正确文本表示时非常有用。如果该 token 没有字节表示,则可以为 `null` 。 - `logprob: number` - 如果该 token 位于概率最高的前 20 个 token 之内,则为其对数概率。否则,值 `-9999.0` 用于表示该 token 出现的可能性极低。 + 该 token 的对数概率(如果它位于概率最高的 20 个 token 之内)。否则,值为 `-9999.0` 表示该 token 极不可能出现。 - `top_logprobs: array of object { token, bytes, logprob }` - 在该 token 位置处最可能出现的 token 列表及其对数概率。条目数量可能少于请求的 `top_logprobs`. + 在该 token 位置上,最可能出现的 token 及其对数概率的列表。条目数量可能少于所请求的 `top_logprobs`. - `token: string` @@ -3481,15 +3482,15 @@ curl https://api.openai.com/v1/chat/completions \ - `bytes: array of number or null` - 一个整数列表,表示该 token 的 UTF-8 字节表示。在某些字符由多个 token 表示,且必须组合其字节表示才能生成正确文本表示的情况下非常有用。如果 `null` ,则表示该 token 没有字节表示。 + 表示该 token UTF-8 字节表示的整数列表。在字符由多个 token 表示且必须组合其字节表示才能生成正确文本表示时非常有用。如果该 token 没有字节表示,则可以为 `null` 。 - `logprob: number` - 如果该 token 位于概率最高的前 20 个 token 之内,则为其对数概率。否则,值 `-9999.0` 用于表示该 token 出现的可能性极低。 + 该 token 的对数概率(如果它位于概率最高的 20 个 token 之内)。否则,值为 `-9999.0` 表示该 token 极不可能出现。 - `refusal: array of ChatCompletionTokenLogprob or null` - 包含对数概率信息的消息拒绝 token 列表。 + 包含对数概率信息的拒绝消息 token 列表。 - `token: string` @@ -3497,19 +3498,19 @@ curl https://api.openai.com/v1/chat/completions \ - `bytes: array of number or null` - 一个整数列表,表示该 token 的 UTF-8 字节表示。在某些字符由多个 token 表示,且必须组合其字节表示才能生成正确文本表示的情况下非常有用。如果 `null` ,则表示该 token 没有字节表示。 + 表示该 token UTF-8 字节表示的整数列表。在字符由多个 token 表示且必须组合其字节表示才能生成正确文本表示时非常有用。如果该 token 没有字节表示,则可以为 `null` 。 - `logprob: number` - 如果该 token 位于概率最高的前 20 个 token 之内,则为其对数概率。否则,值 `-9999.0` 用于表示该 token 出现的可能性极低。 + 该 token 的对数概率(如果它位于概率最高的 20 个 token 之内)。否则,值为 `-9999.0` 表示该 token 极不可能出现。 - `top_logprobs: array of object { token, bytes, logprob }` - 在该 token 位置处最可能出现的 token 列表及其对数概率。条目数量可能少于请求的 `top_logprobs`. + 在该 token 位置上,最可能出现的 token 及其对数概率的列表。条目数量可能少于所请求的 `top_logprobs`. - `message: ChatCompletionMessage` - 由模型生成的聊天补全消息。 + 由模型生成的聊天完成消息。 - `content: string or null` @@ -3517,18 +3518,18 @@ curl https://api.openai.com/v1/chat/completions \ - `refusal: string or null` - 模型生成的拒绝消息。 + 由模型生成的拒绝消息。 - `role: "assistant"` - 此消息作者的角色。 + 该消息作者的角色。 - `"assistant"` - `annotations: optional array of object { type, url_citation }` - 消息的注解(如适用),例如使用 - [网页搜索 工具](/docs/guides/tools-web-search?api-mode=chat). + 消息的注释(如果适用),例如在使用 + [网页搜索工具](/docs/guides/tools-web-search?api-mode=chat). - `type: "url_citation"` @@ -3546,7 +3547,7 @@ curl https://api.openai.com/v1/chat/completions \ - `start_index: number` - 消息中 URL 引用第一个字符的索引。 + 消息中 URL 引用的第一个字符的索引。 - `title: string` @@ -3558,8 +3559,8 @@ curl https://api.openai.com/v1/chat/completions \ - `audio: optional ChatCompletionAudio or null` - 如果请求了音频输出模态,则此对象包含 - 来自模型的音频响应的相关数据。 [了解更多](/docs/guides/audio). + 如果请求了音频输出模态,该对象包含来自模型的音频 + 响应的相关数据。 [了解更多](/docs/guides/audio). - `id: string` @@ -3567,14 +3568,14 @@ curl https://api.openai.com/v1/chat/completions \ - `data: string` - 由模型生成的 Base64 编码音频字节,格式为 + 模型生成的 Base64 编码音频字节,格式为 请求中指定的格式。 - `expires_at: number` - 此音频响应在服务端不再可访问的 Unix 时间戳(秒),用于多轮 - 对话中的后续使用。 - conversations。 + 此音频响应在服务端上无法再被用于多轮 + 访问的 Unix 时间戳(秒)。 + 对话。 - `transcript: string` @@ -3582,11 +3583,11 @@ curl https://api.openai.com/v1/chat/completions \ - `function_call: optional object { arguments, name }` - 已弃用,由 `tool_calls`。替代。模型生成的应被调用的函数名称和参数。 + 已弃用,由 `tool_calls`。替代。应调用的函数的名称和参数,由模型生成。 - `arguments: string` - 以 JSON 格式传递给函数的参数,由模型生成。请注意,模型并不总是生成有效的 JSON,并且可能会虚构函数 schema 中未定义的参数。在调用函数之前,请在代码中校验这些参数。 + 调用函数时使用的参数,以 JSON 格式由模型生成。请注意,模型并不总是生成有效的 JSON,并且可能会虚构你的函数 schema 中未定义的参数。在调用函数之前,请在代码中校验这些参数。 - `name: string` @@ -3610,7 +3611,7 @@ curl https://api.openai.com/v1/chat/completions \ - `arguments: string` - 以 JSON 格式传递给函数的参数,由模型生成。请注意,模型并不总是生成有效的 JSON,并且可能会虚构函数 schema 中未定义的参数。在调用函数之前,请在代码中校验这些参数。 + 调用函数时使用的参数,以 JSON 格式由模型生成。请注意,模型并不总是生成有效的 JSON,并且可能会虚构你的函数 schema 中未定义的参数。在调用函数之前,请在代码中校验这些参数。 - `name: string` @@ -3618,7 +3619,7 @@ curl https://api.openai.com/v1/chat/completions \ - `type: "function"` - 工具的类型。目前,仅 `function` 。 + 工具的类型。目前,仅 `function` 类型。 - `"function"` @@ -3654,7 +3655,7 @@ curl https://api.openai.com/v1/chat/completions \ - `model: string` - 用于聊天补全的模型。 + 用于该聊天补全的模型。 - `object: "chat.completion"` @@ -3664,21 +3665,21 @@ curl https://api.openai.com/v1/chat/completions \ - `metadata: optional Metadata or null` - 可以附加到对象的 16 组键值对。这可以用于 - 以结构化格式存储有关对象的附加信息,并通过 API 或控制台查询对象。 - 以结构化格式存储有关对象的附加信息,并通过 接口 或控制台查询对象。 + 可附加到对象的 16 组键值对。可用于 + 以结构化格式存储有关对象的其他信息,并通过 API 或控制台查询对象。 + 以结构化格式存储有关对象的其他信息,并通过 接口 或控制台查询对象。 - 键是字符串,最大长度为 64 个字符。值是字符串, + 键为字符串,最大长度为 64 个字符。值为字符串, 最大长度为 512 个字符。 - `moderation: optional object { input, output } or null` - 请求输入和生成输出的审核结果(若请求了审核补全) - completions。 + 请求输入和生成输出的审核结果(如果请求了 + 补全审核)。 - `input: object { model, results, type } or object { code, message, type }` - 请求输入的审核结果。 + 对请求输入的审核。 - `ModerationResults object { model, results, type }` @@ -3694,11 +3695,11 @@ curl https://api.openai.com/v1/chat/completions \ - `categories: map[boolean]` - 审核类别到布尔值的字典,若输入在该类别下被标记则为 True。 + 一个从审核类别到布尔值的字典,若输入在该类别下被标记则为 True。 - `category_applied_input_types: map[array of "text" or "image"]` - 每个类别的分数所对应的输入模态。 + 每个类别的分数所反映的输入模态。 - `"text"` @@ -3706,19 +3707,19 @@ curl https://api.openai.com/v1/chat/completions \ - `category_scores: map[number]` - 审核类别到分数的字典。 + 一个从审核类别到分数的字典。 - `flagged: boolean` - 指示内容是否被任意类别标记的布尔值。 + 一个布尔值,指示内容是否被任何类别标记。 - `model: string` - 生成该结果的审核模型。 + 生成此结果的审核模型。 - `type: "moderation_result"` - 对象类型,过去始终为 `moderation_result` (用于成功的审核结果)。 + 对象类型,在成功的审核结果中始终为 `moderation_result` 。 - `"moderation_result"` @@ -3738,7 +3739,7 @@ curl https://api.openai.com/v1/chat/completions \ - `message: string` - 错误信息。 + 错误消息。 - `type: "error"` @@ -3748,7 +3749,7 @@ curl https://api.openai.com/v1/chat/completions \ - `output: object { model, results, type } or object { code, message, type }` - 对生成输出的内容审核。 + 生成输出的审核。 - `ModerationResults object { model, results, type }` @@ -3764,11 +3765,11 @@ curl https://api.openai.com/v1/chat/completions \ - `categories: map[boolean]` - 审核类别到布尔值的字典,若输入在该类别下被标记则为 True。 + 一个从审核类别到布尔值的字典,若输入在该类别下被标记则为 True。 - `category_applied_input_types: map[array of "text" or "image"]` - 每个类别的分数所对应的输入模态。 + 每个类别的分数所反映的输入模态。 - `"text"` @@ -3776,19 +3777,19 @@ curl https://api.openai.com/v1/chat/completions \ - `category_scores: map[number]` - 审核类别到分数的字典。 + 一个从审核类别到分数的字典。 - `flagged: boolean` - 指示内容是否被任意类别标记的布尔值。 + 一个布尔值,指示内容是否被任何类别标记。 - `model: string` - 生成该结果的审核模型。 + 生成此结果的审核模型。 - `type: "moderation_result"` - 对象类型,过去始终为 `moderation_result` (用于成功的审核结果)。 + 对象类型,在成功的审核结果中始终为 `moderation_result` 。 - `"moderation_result"` @@ -3808,7 +3809,7 @@ curl https://api.openai.com/v1/chat/completions \ - `message: string` - 错误信息。 + 错误消息。 - `type: "error"` @@ -3820,13 +3821,13 @@ curl https://api.openai.com/v1/chat/completions \ 指定用于处理请求的处理类型。 - - 如果设置为 'auto',则请求将按照项目设置中配置的服务层级处理。除非另行配置,项目将使用 'default'。 - - 如果设置为 'default',则请求将以所选模型的标准定价和性能进行处理。 + - 如果设置为 'auto',则请求将使用 Project 设置中配置的服务层级进行处理。除非另行配置,否则该 Project 将使用 'default'。 + - 如果设置为 'default',则请求将使用所选模型的标准定价和性能进行处理。 - 如果设置为 '[flex](/docs/guides/flex-processing)',则请求将使用 Flex Processing 服务层级进行处理。 - - 若要在请求级别启用 [Fast mode](/api/docs/guides/fast-mode) ,请在 Responses 或 Chat Completions 中包含 `service_tier=fast` 或 `service_tier=priority` 参数。响应中将显示 `service_tier=priority` ,无论你是否在请求中指定了 `service_tier=fast` 或 `priority` 。 + - 要在请求级别启用 [Fast mode](/api/docs/guides/fast-mode) ,请在 Responses 或 Chat Completions 中包含 `service_tier=fast` 或 `service_tier=priority` 参数。响应中将显示 `service_tier=priority` ,无论你是否在请求中指定 `service_tier=fast` 或 `priority` 。 - 未设置时,默认行为为 'auto'。 - 当 `service_tier` 参数被设置时,响应体将根据实际用于处理请求的处理模式返回 `service_tier` 值。该响应值可能与参数中设置的值不同。 + 当设置了 `service_tier` 参数时,响应主体将根据实际用于处理该请求的处理模式包含对应的 `service_tier` 值。该响应值可能与参数中设置的值不同。 - `"auto"` @@ -3842,82 +3843,82 @@ curl https://api.openai.com/v1/chat/completions \ - `system_fingerprint: optional string` - 此指纹表示模型运行所用的后端配置。 + 此指纹表示模型运行所使用的后端配置。 - 可与 `seed` 请求参数结合使用,以了解何时发生了可能影响确定性的后端变更。 + 可与 `seed` 请求参数结合使用,以了解何时进行了可能影响确定性的后端变更。 - `usage: optional CompletionUsage` - 该补全请求的使用统计信息。 + 补全请求的使用情况统计信息。 - `completion_tokens: number` - 生成补全中的令牌数量。 + 生成补全中的 token 数。 - `prompt_tokens: number` - 提示中的令牌数量。 + 提示中的 token 数。 - `total_tokens: number` - 请求中使用的令牌总数(提示 + 补全)。 + 请求中使用的总 token 数(提示 + 补全)。 - `completion_tokens_details: optional object { accepted_prediction_tokens, audio_tokens, reasoning_tokens, 2 more }` - 补全中使用的令牌细分。 + 补全中使用的 token 明细。 - `accepted_prediction_tokens: optional number` 使用 Predicted Outputs 时, - 出现在补全中的预测令牌数量。 + 补全中出现的预测 token 数。 - `audio_tokens: optional number` - 由模型生成的音频输入令牌。 + 模型生成的音频输入 token。 - `reasoning_tokens: optional number` - 由模型生成用于推理的令牌。 + 模型为推理生成的 token。 - `rejected_prediction_tokens: optional number` 使用 Predicted Outputs 时, - 未出现在补全中的预测令牌。但是,与 - 推理令牌一样,这些令牌仍会计入用于计费、 - 输出和上下文窗口用途的补全令牌总数 - 限制中。 + 未在补全中出现的预测 token。但是,与 + 推理 token 一样,这些 token 仍会计入 + 用于计费、输出和上下文窗口限制的 + 总补全 token 数中。 - `text_tokens: optional number` - 由模型生成的文本输出令牌。 + 模型生成的文本输出 token。 - `compute_units: optional number or null` - 该请求的计算单元。目前可用时为 null。 + 请求的计算单元。目前可用时为 null。 - `prompt_tokens_details: optional object { audio_tokens, cache_write_tokens, cached_tokens, 2 more }` - 提示中使用的 token 分类明细。 + 提示词中所使用 token 的明细。 - `audio_tokens: optional number` - 提示中存在的音频输入 token。 + 提示词中存在的音频输入 token。 - `cache_write_tokens: optional number` - 写入缓存的未调整提示 token 数量。 + 写入缓存的提示词 token 未调整数量。 - `cached_tokens: optional number` - 提示中存在的已缓存 token。 + 提示词中存在的已缓存 token。 - `image_tokens: optional number` - 提示中存在的图像输入 token。 + 提示词中存在的图像输入 token。 - `text_tokens: optional number` - 提示中存在的文本输入 token。 + 提示词中存在的文本输入 token。 ### 示例 @@ -4102,7 +4103,7 @@ curl https://api.openai.com/v1/chat/completions/chatcmpl-abc123 \ { "object": "chat.completion", "id": "chatcmpl-abc123", - "model": "gpt-4o-2024-08-06", + "model": "gpt-5.6-sol", "created": 1738960610, "request_id": "req_ded8ab984ec4bf840f37566c1011c417", "tool_choice": null, @@ -4138,34 +4139,34 @@ curl https://api.openai.com/v1/chat/completions/chatcmpl-abc123 \ } ``` -## 更新聊天补全 +## Update chat completion **post** `/chat/completions/{completion_id}` -修改已存储的 chat completion。仅可修改已 -以下参数创建的 `store` 参数设置为 `true` 可以修改。目前, +修改已存储的聊天补全。仅限已被修改的 Chat Completions +参数设为 `store` 创建的 Chat Completions `true` 可被修改。目前, 唯一支持的修改是更新 `metadata` 字段。 ### 路径参数 - `completion_id: string` -### 请求体参数 +### Body Parameters - `metadata: Metadata or null` - 可以附加到对象的 16 组键值对。这可以用于 - 以结构化格式存储有关对象的附加信息,并通过 API 或控制台查询对象。 - 以结构化格式存储有关对象的附加信息,并通过 接口 或控制台查询对象。 + 可附加到对象的 16 组键值对。可用于 + 以结构化格式存储有关对象的其他信息,并通过 API 或控制台查询对象。 + 以结构化格式存储有关对象的其他信息,并通过 接口 或控制台查询对象。 - 键是字符串,最大长度为 64 个字符。值是字符串, + 键为字符串,最大长度为 64 个字符。值为字符串, 最大长度为 512 个字符。 -### Returns +### 返回值 - `ChatCompletion object { id, choices, created, 7 more }` - 表示模型基于提供的输入返回的聊天补全响应。 + 表示模型根据提供的输入返回的聊天补全响应。 - `id: string` @@ -4173,15 +4174,15 @@ curl https://api.openai.com/v1/chat/completions/chatcmpl-abc123 \ - `choices: array of object { finish_reason, index, logprobs, message }` - 聊天补全选项的列表。如果 `n` 大于 1,则可以包含多个。 + 聊天补全选项的列表。如果 `n` 大于 1,则可能不止一个。 - `finish_reason: "stop" or "length" or "tool_calls" or 2 more` - 模型停止生成 token 的原因。当出现以下情况时,该值将为 `stop` :模型遇到自然停止点或达到提供的停止序列, - `length` :请求中指定的最大 token 数已达到, - `content_filter` :内容因我们的内容过滤器的标记而被省略, - `tool_calls` :模型调用了工具,或 `function_call` (已弃用):模型调用了函数。 - 请阅读 [Model Spec](https://model-spec.openai.com/2025-12-18.html) 了解更多信息。 + 模型停止生成 token 的原因。如果模型遇到自然停止点或提供的停止序列,则为 `stop` ;如果达到请求中指定的最大 token 数,则为, + `length` ;如果因我们的内容过滤器标记而被省略内容,则为, + `content_filter` ;如果模型调用了工具,则为, + `tool_calls` ;如果模型调用了函数,则为 `function_call` (已弃用)。 + 请参阅 [Model Spec](https://model-spec.openai.com/2025-12-18.html) 了解更多信息。 - `"stop"` @@ -4195,7 +4196,7 @@ curl https://api.openai.com/v1/chat/completions/chatcmpl-abc123 \ - `index: number` - 该选项在选项列表中的索引。 + 选项在选项列表中的索引。 - `logprobs: object { content, refusal } or null` @@ -4211,15 +4212,15 @@ curl https://api.openai.com/v1/chat/completions/chatcmpl-abc123 \ - `bytes: array of number or null` - 一个整数列表,表示该 token 的 UTF-8 字节表示。在某些字符由多个 token 表示,且必须组合其字节表示才能生成正确文本表示的情况下非常有用。如果 `null` ,则表示该 token 没有字节表示。 + 表示该 token UTF-8 字节表示的整数列表。在字符由多个 token 表示且必须组合其字节表示才能生成正确文本表示时非常有用。如果该 token 没有字节表示,则可以为 `null` 。 - `logprob: number` - 如果该 token 位于概率最高的前 20 个 token 之内,则为其对数概率。否则,值 `-9999.0` 用于表示该 token 出现的可能性极低。 + 该 token 的对数概率(如果它位于概率最高的 20 个 token 之内)。否则,值为 `-9999.0` 表示该 token 极不可能出现。 - `top_logprobs: array of object { token, bytes, logprob }` - 在该 token 位置处最可能出现的 token 列表及其对数概率。条目数量可能少于请求的 `top_logprobs`. + 在该 token 位置上,最可能出现的 token 及其对数概率的列表。条目数量可能少于所请求的 `top_logprobs`. - `token: string` @@ -4227,15 +4228,15 @@ curl https://api.openai.com/v1/chat/completions/chatcmpl-abc123 \ - `bytes: array of number or null` - 一个整数列表,表示该 token 的 UTF-8 字节表示。在某些字符由多个 token 表示,且必须组合其字节表示才能生成正确文本表示的情况下非常有用。如果 `null` ,则表示该 token 没有字节表示。 + 表示该 token UTF-8 字节表示的整数列表。在字符由多个 token 表示且必须组合其字节表示才能生成正确文本表示时非常有用。如果该 token 没有字节表示,则可以为 `null` 。 - `logprob: number` - 如果该 token 位于概率最高的前 20 个 token 之内,则为其对数概率。否则,值 `-9999.0` 用于表示该 token 出现的可能性极低。 + 该 token 的对数概率(如果它位于概率最高的 20 个 token 之内)。否则,值为 `-9999.0` 表示该 token 极不可能出现。 - `refusal: array of ChatCompletionTokenLogprob or null` - 包含对数概率信息的消息拒绝 token 列表。 + 包含对数概率信息的拒绝消息 token 列表。 - `token: string` @@ -4243,19 +4244,19 @@ curl https://api.openai.com/v1/chat/completions/chatcmpl-abc123 \ - `bytes: array of number or null` - 一个整数列表,表示该 token 的 UTF-8 字节表示。在某些字符由多个 token 表示,且必须组合其字节表示才能生成正确文本表示的情况下非常有用。如果 `null` ,则表示该 token 没有字节表示。 + 表示该 token UTF-8 字节表示的整数列表。在字符由多个 token 表示且必须组合其字节表示才能生成正确文本表示时非常有用。如果该 token 没有字节表示,则可以为 `null` 。 - `logprob: number` - 如果该 token 位于概率最高的前 20 个 token 之内,则为其对数概率。否则,值 `-9999.0` 用于表示该 token 出现的可能性极低。 + 该 token 的对数概率(如果它位于概率最高的 20 个 token 之内)。否则,值为 `-9999.0` 表示该 token 极不可能出现。 - `top_logprobs: array of object { token, bytes, logprob }` - 在该 token 位置处最可能出现的 token 列表及其对数概率。条目数量可能少于请求的 `top_logprobs`. + 在该 token 位置上,最可能出现的 token 及其对数概率的列表。条目数量可能少于所请求的 `top_logprobs`. - `message: ChatCompletionMessage` - 由模型生成的聊天补全消息。 + 由模型生成的聊天完成消息。 - `content: string or null` @@ -4263,18 +4264,18 @@ curl https://api.openai.com/v1/chat/completions/chatcmpl-abc123 \ - `refusal: string or null` - 模型生成的拒绝消息。 + 由模型生成的拒绝消息。 - `role: "assistant"` - 此消息作者的角色。 + 该消息作者的角色。 - `"assistant"` - `annotations: optional array of object { type, url_citation }` - 消息的注解(如适用),例如使用 - [网页搜索 工具](/docs/guides/tools-web-search?api-mode=chat). + 消息的注释(如果适用),例如在使用 + [网页搜索工具](/docs/guides/tools-web-search?api-mode=chat). - `type: "url_citation"` @@ -4292,7 +4293,7 @@ curl https://api.openai.com/v1/chat/completions/chatcmpl-abc123 \ - `start_index: number` - 消息中 URL 引用第一个字符的索引。 + 消息中 URL 引用的第一个字符的索引。 - `title: string` @@ -4304,8 +4305,8 @@ curl https://api.openai.com/v1/chat/completions/chatcmpl-abc123 \ - `audio: optional ChatCompletionAudio or null` - 如果请求了音频输出模态,则此对象包含 - 来自模型的音频响应的相关数据。 [了解更多](/docs/guides/audio). + 如果请求了音频输出模态,该对象包含来自模型的音频 + 响应的相关数据。 [了解更多](/docs/guides/audio). - `id: string` @@ -4313,14 +4314,14 @@ curl https://api.openai.com/v1/chat/completions/chatcmpl-abc123 \ - `data: string` - 由模型生成的 Base64 编码音频字节,格式为 + 模型生成的 Base64 编码音频字节,格式为 请求中指定的格式。 - `expires_at: number` - 此音频响应在服务端不再可访问的 Unix 时间戳(秒),用于多轮 - 对话中的后续使用。 - conversations。 + 此音频响应在服务端上无法再被用于多轮 + 访问的 Unix 时间戳(秒)。 + 对话。 - `transcript: string` @@ -4328,11 +4329,11 @@ curl https://api.openai.com/v1/chat/completions/chatcmpl-abc123 \ - `function_call: optional object { arguments, name }` - 已弃用,由 `tool_calls`。替代。模型生成的应被调用的函数名称和参数。 + 已弃用,由 `tool_calls`。替代。应调用的函数的名称和参数,由模型生成。 - `arguments: string` - 以 JSON 格式传递给函数的参数,由模型生成。请注意,模型并不总是生成有效的 JSON,并且可能会虚构函数 schema 中未定义的参数。在调用函数之前,请在代码中校验这些参数。 + 调用函数时使用的参数,以 JSON 格式由模型生成。请注意,模型并不总是生成有效的 JSON,并且可能会虚构你的函数 schema 中未定义的参数。在调用函数之前,请在代码中校验这些参数。 - `name: string` @@ -4356,7 +4357,7 @@ curl https://api.openai.com/v1/chat/completions/chatcmpl-abc123 \ - `arguments: string` - 以 JSON 格式传递给函数的参数,由模型生成。请注意,模型并不总是生成有效的 JSON,并且可能会虚构函数 schema 中未定义的参数。在调用函数之前,请在代码中校验这些参数。 + 调用函数时使用的参数,以 JSON 格式由模型生成。请注意,模型并不总是生成有效的 JSON,并且可能会虚构你的函数 schema 中未定义的参数。在调用函数之前,请在代码中校验这些参数。 - `name: string` @@ -4364,7 +4365,7 @@ curl https://api.openai.com/v1/chat/completions/chatcmpl-abc123 \ - `type: "function"` - 工具的类型。目前,仅 `function` 。 + 工具的类型。目前,仅 `function` 类型。 - `"function"` @@ -4400,7 +4401,7 @@ curl https://api.openai.com/v1/chat/completions/chatcmpl-abc123 \ - `model: string` - 用于聊天补全的模型。 + 用于该聊天补全的模型。 - `object: "chat.completion"` @@ -4410,21 +4411,21 @@ curl https://api.openai.com/v1/chat/completions/chatcmpl-abc123 \ - `metadata: optional Metadata or null` - 可以附加到对象的 16 组键值对。这可以用于 - 以结构化格式存储有关对象的附加信息,并通过 API 或控制台查询对象。 - 以结构化格式存储有关对象的附加信息,并通过 接口 或控制台查询对象。 + 可附加到对象的 16 组键值对。可用于 + 以结构化格式存储有关对象的其他信息,并通过 API 或控制台查询对象。 + 以结构化格式存储有关对象的其他信息,并通过 接口 或控制台查询对象。 - 键是字符串,最大长度为 64 个字符。值是字符串, + 键为字符串,最大长度为 64 个字符。值为字符串, 最大长度为 512 个字符。 - `moderation: optional object { input, output } or null` - 请求输入和生成输出的审核结果(若请求了审核补全) - completions。 + 请求输入和生成输出的审核结果(如果请求了 + 补全审核)。 - `input: object { model, results, type } or object { code, message, type }` - 请求输入的审核结果。 + 对请求输入的审核。 - `ModerationResults object { model, results, type }` @@ -4440,11 +4441,11 @@ curl https://api.openai.com/v1/chat/completions/chatcmpl-abc123 \ - `categories: map[boolean]` - 审核类别到布尔值的字典,若输入在该类别下被标记则为 True。 + 一个从审核类别到布尔值的字典,若输入在该类别下被标记则为 True。 - `category_applied_input_types: map[array of "text" or "image"]` - 每个类别的分数所对应的输入模态。 + 每个类别的分数所反映的输入模态。 - `"text"` @@ -4452,19 +4453,19 @@ curl https://api.openai.com/v1/chat/completions/chatcmpl-abc123 \ - `category_scores: map[number]` - 审核类别到分数的字典。 + 一个从审核类别到分数的字典。 - `flagged: boolean` - 指示内容是否被任意类别标记的布尔值。 + 一个布尔值,指示内容是否被任何类别标记。 - `model: string` - 生成该结果的审核模型。 + 生成此结果的审核模型。 - `type: "moderation_result"` - 对象类型,过去始终为 `moderation_result` (用于成功的审核结果)。 + 对象类型,在成功的审核结果中始终为 `moderation_result` 。 - `"moderation_result"` @@ -4484,7 +4485,7 @@ curl https://api.openai.com/v1/chat/completions/chatcmpl-abc123 \ - `message: string` - 错误信息。 + 错误消息。 - `type: "error"` @@ -4494,7 +4495,7 @@ curl https://api.openai.com/v1/chat/completions/chatcmpl-abc123 \ - `output: object { model, results, type } or object { code, message, type }` - 对生成输出的内容审核。 + 生成输出的审核。 - `ModerationResults object { model, results, type }` @@ -4510,11 +4511,11 @@ curl https://api.openai.com/v1/chat/completions/chatcmpl-abc123 \ - `categories: map[boolean]` - 审核类别到布尔值的字典,若输入在该类别下被标记则为 True。 + 一个从审核类别到布尔值的字典,若输入在该类别下被标记则为 True。 - `category_applied_input_types: map[array of "text" or "image"]` - 每个类别的分数所对应的输入模态。 + 每个类别的分数所反映的输入模态。 - `"text"` @@ -4522,19 +4523,19 @@ curl https://api.openai.com/v1/chat/completions/chatcmpl-abc123 \ - `category_scores: map[number]` - 审核类别到分数的字典。 + 一个从审核类别到分数的字典。 - `flagged: boolean` - 指示内容是否被任意类别标记的布尔值。 + 一个布尔值,指示内容是否被任何类别标记。 - `model: string` - 生成该结果的审核模型。 + 生成此结果的审核模型。 - `type: "moderation_result"` - 对象类型,过去始终为 `moderation_result` (用于成功的审核结果)。 + 对象类型,在成功的审核结果中始终为 `moderation_result` 。 - `"moderation_result"` @@ -4554,7 +4555,7 @@ curl https://api.openai.com/v1/chat/completions/chatcmpl-abc123 \ - `message: string` - 错误信息。 + 错误消息。 - `type: "error"` @@ -4566,13 +4567,13 @@ curl https://api.openai.com/v1/chat/completions/chatcmpl-abc123 \ 指定用于处理请求的处理类型。 - - 如果设置为 'auto',则请求将按照项目设置中配置的服务层级处理。除非另行配置,项目将使用 'default'。 - - 如果设置为 'default',则请求将以所选模型的标准定价和性能进行处理。 + - 如果设置为 'auto',则请求将使用 Project 设置中配置的服务层级进行处理。除非另行配置,否则该 Project 将使用 'default'。 + - 如果设置为 'default',则请求将使用所选模型的标准定价和性能进行处理。 - 如果设置为 '[flex](/docs/guides/flex-processing)',则请求将使用 Flex Processing 服务层级进行处理。 - - 若要在请求级别启用 [Fast mode](/api/docs/guides/fast-mode) ,请在 Responses 或 Chat Completions 中包含 `service_tier=fast` 或 `service_tier=priority` 参数。响应中将显示 `service_tier=priority` ,无论你是否在请求中指定了 `service_tier=fast` 或 `priority` 。 + - 要在请求级别启用 [Fast mode](/api/docs/guides/fast-mode) ,请在 Responses 或 Chat Completions 中包含 `service_tier=fast` 或 `service_tier=priority` 参数。响应中将显示 `service_tier=priority` ,无论你是否在请求中指定 `service_tier=fast` 或 `priority` 。 - 未设置时,默认行为为 'auto'。 - 当 `service_tier` 参数被设置时,响应体将根据实际用于处理请求的处理模式返回 `service_tier` 值。该响应值可能与参数中设置的值不同。 + 当设置了 `service_tier` 参数时,响应主体将根据实际用于处理该请求的处理模式包含对应的 `service_tier` 值。该响应值可能与参数中设置的值不同。 - `"auto"` @@ -4588,82 +4589,82 @@ curl https://api.openai.com/v1/chat/completions/chatcmpl-abc123 \ - `system_fingerprint: optional string` - 此指纹表示模型运行所用的后端配置。 + 此指纹表示模型运行所使用的后端配置。 - 可与 `seed` 请求参数结合使用,以了解何时发生了可能影响确定性的后端变更。 + 可与 `seed` 请求参数结合使用,以了解何时进行了可能影响确定性的后端变更。 - `usage: optional CompletionUsage` - 该补全请求的使用统计信息。 + 补全请求的使用情况统计信息。 - `completion_tokens: number` - 生成补全中的令牌数量。 + 生成补全中的 token 数。 - `prompt_tokens: number` - 提示中的令牌数量。 + 提示中的 token 数。 - `total_tokens: number` - 请求中使用的令牌总数(提示 + 补全)。 + 请求中使用的总 token 数(提示 + 补全)。 - `completion_tokens_details: optional object { accepted_prediction_tokens, audio_tokens, reasoning_tokens, 2 more }` - 补全中使用的令牌细分。 + 补全中使用的 token 明细。 - `accepted_prediction_tokens: optional number` 使用 Predicted Outputs 时, - 出现在补全中的预测令牌数量。 + 补全中出现的预测 token 数。 - `audio_tokens: optional number` - 由模型生成的音频输入令牌。 + 模型生成的音频输入 token。 - `reasoning_tokens: optional number` - 由模型生成用于推理的令牌。 + 模型为推理生成的 token。 - `rejected_prediction_tokens: optional number` 使用 Predicted Outputs 时, - 未出现在补全中的预测令牌。但是,与 - 推理令牌一样,这些令牌仍会计入用于计费、 - 输出和上下文窗口用途的补全令牌总数 - 限制中。 + 未在补全中出现的预测 token。但是,与 + 推理 token 一样,这些 token 仍会计入 + 用于计费、输出和上下文窗口限制的 + 总补全 token 数中。 - `text_tokens: optional number` - 由模型生成的文本输出令牌。 + 模型生成的文本输出 token。 - `compute_units: optional number or null` - 该请求的计算单元。目前可用时为 null。 + 请求的计算单元。目前可用时为 null。 - `prompt_tokens_details: optional object { audio_tokens, cache_write_tokens, cached_tokens, 2 more }` - 提示中使用的 token 分类明细。 + 提示词中所使用 token 的明细。 - `audio_tokens: optional number` - 提示中存在的音频输入 token。 + 提示词中存在的音频输入 token。 - `cache_write_tokens: optional number` - 写入缓存的未调整提示 token 数量。 + 写入缓存的提示词 token 未调整数量。 - `cached_tokens: optional number` - 提示中存在的已缓存 token。 + 提示词中存在的已缓存 token。 - `image_tokens: optional number` - 提示中存在的图像输入 token。 + 提示词中存在的图像输入 token。 - `text_tokens: optional number` - 提示中存在的文本输入 token。 + 提示词中存在的文本输入 token。 ### 示例 @@ -4855,7 +4856,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ { "object": "chat.completion", "id": "chatcmpl-AyPNinnUqUDYo9SAdA52NobMflmj2", - "model": "gpt-4o-2024-08-06", + "model": "gpt-5.6-sol", "created": 1738960610, "request_id": "req_ded8ab984ec4bf840f37566c1011c417", "tool_choice": null, @@ -4899,13 +4900,13 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `ChatCompletionAllowedTools object { mode, tools }` - 将模型可用的工具限制为预定义的集合。 + 将模型可使用的工具限制为预定义的集合。 - `mode: "auto" or "required"` - 将模型可用的工具限制为预定义的集合。 + 将模型可使用的工具限制为预定义的集合。 - `auto` 允许模型从允许的工具中选取并生成 + `auto` 允许模型从允许的工具中选择并生成 消息。 `required` 要求模型调用一个或多个允许的工具。 @@ -4916,9 +4917,9 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `tools: array of map[unknown]` - 允许模型调用的工具定义列表。 + 模型可调用的工具定义列表。 - 对于 Chat Completions API,工具定义列表可能如下所示: + 对于 Chat Completions API,工具定义列表可能如下: ```json [ @@ -4931,7 +4932,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `ChatCompletion object { id, choices, created, 7 more }` - 表示模型基于提供的输入返回的聊天补全响应。 + 表示模型根据提供的输入返回的聊天补全响应。 - `id: string` @@ -4939,15 +4940,15 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `choices: array of object { finish_reason, index, logprobs, message }` - 聊天补全选项的列表。如果 `n` 大于 1,则可以包含多个。 + 聊天补全选项的列表。如果 `n` 大于 1,则可能不止一个。 - `finish_reason: "stop" or "length" or "tool_calls" or 2 more` - 模型停止生成 token 的原因。当出现以下情况时,该值将为 `stop` :模型遇到自然停止点或达到提供的停止序列, - `length` :请求中指定的最大 token 数已达到, - `content_filter` :内容因我们的内容过滤器的标记而被省略, - `tool_calls` :模型调用了工具,或 `function_call` (已弃用):模型调用了函数。 - 请阅读 [Model Spec](https://model-spec.openai.com/2025-12-18.html) 了解更多信息。 + 模型停止生成 token 的原因。如果模型遇到自然停止点或提供的停止序列,则为 `stop` ;如果达到请求中指定的最大 token 数,则为, + `length` ;如果因我们的内容过滤器标记而被省略内容,则为, + `content_filter` ;如果模型调用了工具,则为, + `tool_calls` ;如果模型调用了函数,则为 `function_call` (已弃用)。 + 请参阅 [Model Spec](https://model-spec.openai.com/2025-12-18.html) 了解更多信息。 - `"stop"` @@ -4961,7 +4962,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `index: number` - 该选项在选项列表中的索引。 + 选项在选项列表中的索引。 - `logprobs: object { content, refusal } or null` @@ -4977,15 +4978,15 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `bytes: array of number or null` - 一个整数列表,表示该 token 的 UTF-8 字节表示。在某些字符由多个 token 表示,且必须组合其字节表示才能生成正确文本表示的情况下非常有用。如果 `null` ,则表示该 token 没有字节表示。 + 表示该 token UTF-8 字节表示的整数列表。在字符由多个 token 表示且必须组合其字节表示才能生成正确文本表示时非常有用。如果该 token 没有字节表示,则可以为 `null` 。 - `logprob: number` - 如果该 token 位于概率最高的前 20 个 token 之内,则为其对数概率。否则,值 `-9999.0` 用于表示该 token 出现的可能性极低。 + 该 token 的对数概率(如果它位于概率最高的 20 个 token 之内)。否则,值为 `-9999.0` 表示该 token 极不可能出现。 - `top_logprobs: array of object { token, bytes, logprob }` - 在该 token 位置处最可能出现的 token 列表及其对数概率。条目数量可能少于请求的 `top_logprobs`. + 在该 token 位置上,最可能出现的 token 及其对数概率的列表。条目数量可能少于所请求的 `top_logprobs`. - `token: string` @@ -4993,15 +4994,15 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `bytes: array of number or null` - 一个整数列表,表示该 token 的 UTF-8 字节表示。在某些字符由多个 token 表示,且必须组合其字节表示才能生成正确文本表示的情况下非常有用。如果 `null` ,则表示该 token 没有字节表示。 + 表示该 token UTF-8 字节表示的整数列表。在字符由多个 token 表示且必须组合其字节表示才能生成正确文本表示时非常有用。如果该 token 没有字节表示,则可以为 `null` 。 - `logprob: number` - 如果该 token 位于概率最高的前 20 个 token 之内,则为其对数概率。否则,值 `-9999.0` 用于表示该 token 出现的可能性极低。 + 该 token 的对数概率(如果它位于概率最高的 20 个 token 之内)。否则,值为 `-9999.0` 表示该 token 极不可能出现。 - `refusal: array of ChatCompletionTokenLogprob or null` - 包含对数概率信息的消息拒绝 token 列表。 + 包含对数概率信息的拒绝消息 token 列表。 - `token: string` @@ -5009,19 +5010,19 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `bytes: array of number or null` - 一个整数列表,表示该 token 的 UTF-8 字节表示。在某些字符由多个 token 表示,且必须组合其字节表示才能生成正确文本表示的情况下非常有用。如果 `null` ,则表示该 token 没有字节表示。 + 表示该 token UTF-8 字节表示的整数列表。在字符由多个 token 表示且必须组合其字节表示才能生成正确文本表示时非常有用。如果该 token 没有字节表示,则可以为 `null` 。 - `logprob: number` - 如果该 token 位于概率最高的前 20 个 token 之内,则为其对数概率。否则,值 `-9999.0` 用于表示该 token 出现的可能性极低。 + 该 token 的对数概率(如果它位于概率最高的 20 个 token 之内)。否则,值为 `-9999.0` 表示该 token 极不可能出现。 - `top_logprobs: array of object { token, bytes, logprob }` - 在该 token 位置处最可能出现的 token 列表及其对数概率。条目数量可能少于请求的 `top_logprobs`. + 在该 token 位置上,最可能出现的 token 及其对数概率的列表。条目数量可能少于所请求的 `top_logprobs`. - `message: ChatCompletionMessage` - 由模型生成的聊天补全消息。 + 由模型生成的聊天完成消息。 - `content: string or null` @@ -5029,18 +5030,18 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `refusal: string or null` - 模型生成的拒绝消息。 + 由模型生成的拒绝消息。 - `role: "assistant"` - 此消息作者的角色。 + 该消息作者的角色。 - `"assistant"` - `annotations: optional array of object { type, url_citation }` - 消息的注解(如适用),例如使用 - [网页搜索 工具](/docs/guides/tools-web-search?api-mode=chat). + 消息的注释(如果适用),例如在使用 + [网页搜索工具](/docs/guides/tools-web-search?api-mode=chat). - `type: "url_citation"` @@ -5058,7 +5059,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `start_index: number` - 消息中 URL 引用第一个字符的索引。 + 消息中 URL 引用的第一个字符的索引。 - `title: string` @@ -5070,8 +5071,8 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `audio: optional ChatCompletionAudio or null` - 如果请求了音频输出模态,则此对象包含 - 来自模型的音频响应的相关数据。 [了解更多](/docs/guides/audio). + 如果请求了音频输出模态,该对象包含来自模型的音频 + 响应的相关数据。 [了解更多](/docs/guides/audio). - `id: string` @@ -5079,14 +5080,14 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `data: string` - 由模型生成的 Base64 编码音频字节,格式为 + 模型生成的 Base64 编码音频字节,格式为 请求中指定的格式。 - `expires_at: number` - 此音频响应在服务端不再可访问的 Unix 时间戳(秒),用于多轮 - 对话中的后续使用。 - conversations。 + 此音频响应在服务端上无法再被用于多轮 + 访问的 Unix 时间戳(秒)。 + 对话。 - `transcript: string` @@ -5094,11 +5095,11 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `function_call: optional object { arguments, name }` - 已弃用,由 `tool_calls`。替代。模型生成的应被调用的函数名称和参数。 + 已弃用,由 `tool_calls`。替代。应调用的函数的名称和参数,由模型生成。 - `arguments: string` - 以 JSON 格式传递给函数的参数,由模型生成。请注意,模型并不总是生成有效的 JSON,并且可能会虚构函数 schema 中未定义的参数。在调用函数之前,请在代码中校验这些参数。 + 调用函数时使用的参数,以 JSON 格式由模型生成。请注意,模型并不总是生成有效的 JSON,并且可能会虚构你的函数 schema 中未定义的参数。在调用函数之前,请在代码中校验这些参数。 - `name: string` @@ -5122,7 +5123,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `arguments: string` - 以 JSON 格式传递给函数的参数,由模型生成。请注意,模型并不总是生成有效的 JSON,并且可能会虚构函数 schema 中未定义的参数。在调用函数之前,请在代码中校验这些参数。 + 调用函数时使用的参数,以 JSON 格式由模型生成。请注意,模型并不总是生成有效的 JSON,并且可能会虚构你的函数 schema 中未定义的参数。在调用函数之前,请在代码中校验这些参数。 - `name: string` @@ -5130,7 +5131,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `type: "function"` - 工具的类型。目前,仅 `function` 。 + 工具的类型。目前,仅 `function` 类型。 - `"function"` @@ -5166,7 +5167,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `model: string` - 用于聊天补全的模型。 + 用于该聊天补全的模型。 - `object: "chat.completion"` @@ -5176,21 +5177,21 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `metadata: optional Metadata or null` - 可以附加到对象的 16 组键值对。这可以用于 - 以结构化格式存储有关对象的附加信息,并通过 API 或控制台查询对象。 - 以结构化格式存储有关对象的附加信息,并通过 接口 或控制台查询对象。 + 可附加到对象的 16 组键值对。可用于 + 以结构化格式存储有关对象的其他信息,并通过 API 或控制台查询对象。 + 以结构化格式存储有关对象的其他信息,并通过 接口 或控制台查询对象。 - 键是字符串,最大长度为 64 个字符。值是字符串, + 键为字符串,最大长度为 64 个字符。值为字符串, 最大长度为 512 个字符。 - `moderation: optional object { input, output } or null` - 请求输入和生成输出的审核结果(若请求了审核补全) - completions。 + 请求输入和生成输出的审核结果(如果请求了 + 补全审核)。 - `input: object { model, results, type } or object { code, message, type }` - 请求输入的审核结果。 + 对请求输入的审核。 - `ModerationResults object { model, results, type }` @@ -5206,11 +5207,11 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `categories: map[boolean]` - 审核类别到布尔值的字典,若输入在该类别下被标记则为 True。 + 一个从审核类别到布尔值的字典,若输入在该类别下被标记则为 True。 - `category_applied_input_types: map[array of "text" or "image"]` - 每个类别的分数所对应的输入模态。 + 每个类别的分数所反映的输入模态。 - `"text"` @@ -5218,19 +5219,19 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `category_scores: map[number]` - 审核类别到分数的字典。 + 一个从审核类别到分数的字典。 - `flagged: boolean` - 指示内容是否被任意类别标记的布尔值。 + 一个布尔值,指示内容是否被任何类别标记。 - `model: string` - 生成该结果的审核模型。 + 生成此结果的审核模型。 - `type: "moderation_result"` - 对象类型,过去始终为 `moderation_result` (用于成功的审核结果)。 + 对象类型,在成功的审核结果中始终为 `moderation_result` 。 - `"moderation_result"` @@ -5250,7 +5251,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `message: string` - 错误信息。 + 错误消息。 - `type: "error"` @@ -5260,7 +5261,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `output: object { model, results, type } or object { code, message, type }` - 对生成输出的内容审核。 + 生成输出的审核。 - `ModerationResults object { model, results, type }` @@ -5276,11 +5277,11 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `categories: map[boolean]` - 审核类别到布尔值的字典,若输入在该类别下被标记则为 True。 + 一个从审核类别到布尔值的字典,若输入在该类别下被标记则为 True。 - `category_applied_input_types: map[array of "text" or "image"]` - 每个类别的分数所对应的输入模态。 + 每个类别的分数所反映的输入模态。 - `"text"` @@ -5288,19 +5289,19 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `category_scores: map[number]` - 审核类别到分数的字典。 + 一个从审核类别到分数的字典。 - `flagged: boolean` - 指示内容是否被任意类别标记的布尔值。 + 一个布尔值,指示内容是否被任何类别标记。 - `model: string` - 生成该结果的审核模型。 + 生成此结果的审核模型。 - `type: "moderation_result"` - 对象类型,过去始终为 `moderation_result` (用于成功的审核结果)。 + 对象类型,在成功的审核结果中始终为 `moderation_result` 。 - `"moderation_result"` @@ -5320,7 +5321,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `message: string` - 错误信息。 + 错误消息。 - `type: "error"` @@ -5332,13 +5333,13 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ 指定用于处理请求的处理类型。 - - 如果设置为 'auto',则请求将按照项目设置中配置的服务层级处理。除非另行配置,项目将使用 'default'。 - - 如果设置为 'default',则请求将以所选模型的标准定价和性能进行处理。 + - 如果设置为 'auto',则请求将使用 Project 设置中配置的服务层级进行处理。除非另行配置,否则该 Project 将使用 'default'。 + - 如果设置为 'default',则请求将使用所选模型的标准定价和性能进行处理。 - 如果设置为 '[flex](/docs/guides/flex-processing)',则请求将使用 Flex Processing 服务层级进行处理。 - - 若要在请求级别启用 [Fast mode](/api/docs/guides/fast-mode) ,请在 Responses 或 Chat Completions 中包含 `service_tier=fast` 或 `service_tier=priority` 参数。响应中将显示 `service_tier=priority` ,无论你是否在请求中指定了 `service_tier=fast` 或 `priority` 。 + - 要在请求级别启用 [Fast mode](/api/docs/guides/fast-mode) ,请在 Responses 或 Chat Completions 中包含 `service_tier=fast` 或 `service_tier=priority` 参数。响应中将显示 `service_tier=priority` ,无论你是否在请求中指定 `service_tier=fast` 或 `priority` 。 - 未设置时,默认行为为 'auto'。 - 当 `service_tier` 参数被设置时,响应体将根据实际用于处理请求的处理模式返回 `service_tier` 值。该响应值可能与参数中设置的值不同。 + 当设置了 `service_tier` 参数时,响应主体将根据实际用于处理该请求的处理模式包含对应的 `service_tier` 值。该响应值可能与参数中设置的值不同。 - `"auto"` @@ -5354,98 +5355,98 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `system_fingerprint: optional string` - 此指纹表示模型运行所用的后端配置。 + 此指纹表示模型运行所使用的后端配置。 - 可与 `seed` 请求参数结合使用,以了解何时发生了可能影响确定性的后端变更。 + 可与 `seed` 请求参数结合使用,以了解何时进行了可能影响确定性的后端变更。 - `usage: optional CompletionUsage` - 该补全请求的使用统计信息。 + 补全请求的使用情况统计信息。 - `completion_tokens: number` - 生成补全中的令牌数量。 + 生成补全中的 token 数。 - `prompt_tokens: number` - 提示中的令牌数量。 + 提示中的 token 数。 - `total_tokens: number` - 请求中使用的令牌总数(提示 + 补全)。 + 请求中使用的总 token 数(提示 + 补全)。 - `completion_tokens_details: optional object { accepted_prediction_tokens, audio_tokens, reasoning_tokens, 2 more }` - 补全中使用的令牌细分。 + 补全中使用的 token 明细。 - `accepted_prediction_tokens: optional number` 使用 Predicted Outputs 时, - 出现在补全中的预测令牌数量。 + 补全中出现的预测 token 数。 - `audio_tokens: optional number` - 由模型生成的音频输入令牌。 + 模型生成的音频输入 token。 - `reasoning_tokens: optional number` - 由模型生成用于推理的令牌。 + 模型为推理生成的 token。 - `rejected_prediction_tokens: optional number` 使用 Predicted Outputs 时, - 未出现在补全中的预测令牌。但是,与 - 推理令牌一样,这些令牌仍会计入用于计费、 - 输出和上下文窗口用途的补全令牌总数 - 限制中。 + 未在补全中出现的预测 token。但是,与 + 推理 token 一样,这些 token 仍会计入 + 用于计费、输出和上下文窗口限制的 + 总补全 token 数中。 - `text_tokens: optional number` - 由模型生成的文本输出令牌。 + 模型生成的文本输出 token。 - `compute_units: optional number or null` - 该请求的计算单元。目前可用时为 null。 + 请求的计算单元。目前可用时为 null。 - `prompt_tokens_details: optional object { audio_tokens, cache_write_tokens, cached_tokens, 2 more }` - 提示中使用的 token 分类明细。 + 提示词中所使用 token 的明细。 - `audio_tokens: optional number` - 提示中存在的音频输入 token。 + 提示词中存在的音频输入 token。 - `cache_write_tokens: optional number` - 写入缓存的未调整提示 token 数量。 + 写入缓存的提示词 token 未调整数量。 - `cached_tokens: optional number` - 提示中存在的已缓存 token。 + 提示词中存在的已缓存 token。 - `image_tokens: optional number` - 提示中存在的图像输入 token。 + 提示词中存在的图像输入 token。 - `text_tokens: optional number` - 提示中存在的文本输入 token。 + 提示词中存在的文本输入 token。 ### Chat Completion Allowed Tool Choice - `ChatCompletionAllowedToolChoice object { allowed_tools, type }` - 将模型可用的工具限制为预定义的集合。 + 将模型可使用的工具限制为预定义的集合。 - `allowed_tools: ChatCompletionAllowedTools` - 将模型可用的工具限制为预定义的集合。 + 将模型可使用的工具限制为预定义的集合。 - `mode: "auto" or "required"` - 将模型可用的工具限制为预定义的集合。 + 将模型可使用的工具限制为预定义的集合。 - `auto` 允许模型从允许的工具中选取并生成 + `auto` 允许模型从允许的工具中选择并生成 消息。 `required` 要求模型调用一个或多个允许的工具。 @@ -5456,9 +5457,9 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `tools: array of map[unknown]` - 允许模型调用的工具定义列表。 + 模型可调用的工具定义列表。 - 对于 Chat Completions API,工具定义列表可能如下所示: + 对于 Chat Completions API,工具定义列表可能如下: ```json [ @@ -5487,7 +5488,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `audio: optional object { id } or null` - 关于模型先前音频响应的数据。 + 模型先前音频响应的相关数据。 [了解更多](/docs/guides/audio). - `id: string` @@ -5496,7 +5497,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `content: optional string or array of ChatCompletionContentPartText or ChatCompletionContentPartRefusal or null` - 助手消息的内容。除非指定了 `tool_calls` 或 `function_call` ,否则必填。 + 助手消息的内容。除非指定了 `tool_calls` 或 `function_call` ,否则此字段为必填。 - `TextContent = string` @@ -5504,7 +5505,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `ArrayOfContentParts = array of ChatCompletionContentPartText or ChatCompletionContentPartRefusal` - 由已定义类型组成的内容部分数组。可以包含一个或多个类型为 `text`,或恰好一个类型为 `refusal`. + 具有已定义类型的内容片段数组。可以是以下类型的一个或多个 `text`,或以下类型的恰好一个 `refusal`. - `ChatCompletionContentPartText object { text, type, prompt_cache_breakpoint }` @@ -5522,7 +5523,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `prompt_cache_breakpoint: optional object { mode }` - 标记可复用提示前缀的精确结束位置。该断点会沿用请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。 + 标记可复用提示前缀的确切结束位置。该断点继承自请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。 - `mode: "explicit"` @@ -5534,7 +5535,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `refusal: string` - 模型生成的拒绝消息。 + 由模型生成的拒绝消息。 - `type: "refusal"` @@ -5544,11 +5545,11 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `function_call: optional object { arguments, name } or null` - 已弃用,由 `tool_calls`。替代。模型生成的应被调用的函数名称和参数。 + 已弃用,由 `tool_calls`。替代。应调用的函数的名称和参数,由模型生成。 - `arguments: string` - 以 JSON 格式传递给函数的参数,由模型生成。请注意,模型并不总是生成有效的 JSON,并且可能会虚构函数 schema 中未定义的参数。在调用函数之前,请在代码中校验这些参数。 + 调用函数时使用的参数,以 JSON 格式由模型生成。请注意,模型并不总是生成有效的 JSON,并且可能会虚构你的函数 schema 中未定义的参数。在调用函数之前,请在代码中校验这些参数。 - `name: string` @@ -5556,11 +5557,11 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `name: optional string` - 该参与者的可选名称。为模型提供信息,以便区分相同角色的不同参与者。 + 参与者的可选名称。为模型提供信息,以便区分同一角色的不同参与者。 - `refusal: optional string or null` - 助手给出的拒绝消息。 + 助手生成的拒绝消息。 - `tool_calls: optional array of ChatCompletionMessageToolCall` @@ -5580,7 +5581,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `arguments: string` - 以 JSON 格式传递给函数的参数,由模型生成。请注意,模型并不总是生成有效的 JSON,并且可能会虚构函数 schema 中未定义的参数。在调用函数之前,请在代码中校验这些参数。 + 调用函数时使用的参数,以 JSON 格式由模型生成。请注意,模型并不总是生成有效的 JSON,并且可能会虚构你的函数 schema 中未定义的参数。在调用函数之前,请在代码中校验这些参数。 - `name: string` @@ -5588,7 +5589,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `type: "function"` - 工具的类型。目前,仅 `function` 。 + 工具的类型。目前,仅 `function` 类型。 - `"function"` @@ -5622,8 +5623,8 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `ChatCompletionAudio object { id, data, expires_at, transcript }` - 如果请求了音频输出模态,则此对象包含 - 来自模型的音频响应的相关数据。 [了解更多](/docs/guides/audio). + 如果请求了音频输出模态,该对象包含来自模型的音频 + 响应的相关数据。 [了解更多](/docs/guides/audio). - `id: string` @@ -5631,14 +5632,14 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `data: string` - 由模型生成的 Base64 编码音频字节,格式为 + 模型生成的 Base64 编码音频字节,格式为 请求中指定的格式。 - `expires_at: number` - 此音频响应在服务端不再可访问的 Unix 时间戳(秒),用于多轮 - 对话中的后续使用。 - conversations。 + 此音频响应在服务端上无法再被用于多轮 + 访问的 Unix 时间戳(秒)。 + 对话。 - `transcript: string` @@ -5648,12 +5649,12 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `ChatCompletionAudioParam object { format, voice }` - 音频输出的参数。在请求音频输出时必填,需配合 + 音频输出的参数。当使用以下方式请求音频输出时为必填项 `modalities: ["audio"]`. [了解更多](/docs/guides/audio). - `format: "wav" or "aac" or "mp3" or 3 more` - 指定输出音频格式。必须是以下值之一 `wav`, `mp3`, `flac`, + 指定输出音频格式。必须是以下之一 `wav`, `mp3`, `flac`, `opus`,或 `pcm16`. - `"wav"` @@ -5670,10 +5671,10 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `voice: string or "alloy" or "ash" or "ballad" or 7 more or object { id }` - 模型用于回复所使用的语音。支持的内置语音包括 + 模型用于回复的声音。支持的内置声音包括 `alloy`, `ash`, `ballad`, `coral`, `echo`, `fable`, `nova`, `onyx`, - `sage`, `shimmer`, `marin`,和 `cedar`。你也可以提供一个 - custom voice 对象,其中包含 `id`,例如 `{ "id": "voice_1234" }`. + `sage`, `shimmer`, `marin`,以及 `cedar`。你也可以提供带有 + 的自定义声音对象,使用 `id`,例如 `{ "id": "voice_1234" }`. - `string` @@ -5701,32 +5702,32 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `ID object { id }` - 自定义语音引用。 + 自定义声音引用。 - `id: string` - 自定义语音 ID,例如 `voice_1234`. + 自定义声音 ID,例如 `voice_1234`. ### Chat Completion Chunk - `ChatCompletionChunk object { id, choices, created, 7 more }` - 表示模型基于所提供的输入返回的聊天补全响应的流式分块 - 。 + 表示模型基于提供的输入返回的聊天完成响应的流式分块。 + 由模型根据提供的输入返回。 [了解更多](/docs/guides/streaming-responses). - `id: string` - 聊天补全的唯一标识符。每个分块具有相同的 ID。 + 聊天完成的唯一标识符。每个分块具有相同的 ID。 - `choices: array of object { delta, finish_reason, index, logprobs }` - 聊天补全选项的列表。当 `n` 大于 1 时,可以包含多个元素。如果你在 - 最后一个分块中设置了 `stream_options: {"include_usage": true}`. + 聊天完成选项的列表。如果大于 1,可以包含多个元素。如果设置了 `n` ,则可以包含多个元素。对于 + 最后一个分块也可以为空,当你设置了 `stream_options: {"include_usage": true}`. - `delta: object { content, function_call, refusal, 2 more }` - 由流式模型响应生成的聊天补全增量。 + 由流式模型响应生成的聊天完成增量。 - `content: optional string or null` @@ -5734,11 +5735,11 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `function_call: optional object { arguments, name }` - 已弃用,由 `tool_calls`。替代。模型生成的应被调用的函数名称和参数。 + 已弃用,由 `tool_calls`。替代。应调用的函数的名称和参数,由模型生成。 - `arguments: optional string` - 以 JSON 格式传递给函数的参数,由模型生成。请注意,模型并不总是生成有效的 JSON,并且可能会虚构函数 schema 中未定义的参数。在调用函数之前,请在代码中校验这些参数。 + 调用函数时使用的参数,以 JSON 格式由模型生成。请注意,模型并不总是生成有效的 JSON,并且可能会虚构你的函数 schema 中未定义的参数。在调用函数之前,请在代码中校验这些参数。 - `name: optional string` @@ -5746,11 +5747,11 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `refusal: optional string or null` - 模型生成的拒绝消息。 + 由模型生成的拒绝消息。 - `role: optional "developer" or "system" or "user" or 2 more` - 此消息作者的角色。 + 该消息作者的角色。 - `"developer"` @@ -5774,7 +5775,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `arguments: optional string` - 以 JSON 格式传递给函数的参数,由模型生成。请注意,模型并不总是生成有效的 JSON,并且可能会虚构函数 schema 中未定义的参数。在调用函数之前,请在代码中校验这些参数。 + 调用函数时使用的参数,以 JSON 格式由模型生成。请注意,模型并不总是生成有效的 JSON,并且可能会虚构你的函数 schema 中未定义的参数。在调用函数之前,请在代码中校验这些参数。 - `name: optional string` @@ -5782,16 +5783,16 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `type: optional "function"` - 工具的类型。目前,仅 `function` 。 + 工具的类型。目前,仅 `function` 类型。 - `"function"` - `finish_reason: "stop" or "length" or "tool_calls" or 2 more or null` - 模型停止生成 token 的原因。当出现以下情况时,该值将为 `stop` :模型遇到自然停止点或达到提供的停止序列, - `length` :请求中指定的最大 token 数已达到, - `content_filter` :内容因我们的内容过滤器的标记而被省略, - `tool_calls` :模型调用了工具,或 `function_call` (已弃用):模型调用了函数。 + 模型停止生成 token 的原因。如果模型遇到自然停止点或提供的停止序列,则为 `stop` ;如果达到请求中指定的最大 token 数,则为, + `length` ;如果因我们的内容过滤器标记而被省略内容,则为, + `content_filter` ;如果模型调用了工具,则为, + `tool_calls` ;如果模型调用了函数,则为 `function_call` (已弃用)。 - `"stop"` @@ -5805,7 +5806,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `index: number` - 该选项在选项列表中的索引。 + 选项在选项列表中的索引。 - `logprobs: optional object { content, refusal } or null` @@ -5821,15 +5822,15 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `bytes: array of number or null` - 一个整数列表,表示该 token 的 UTF-8 字节表示。在某些字符由多个 token 表示,且必须组合其字节表示才能生成正确文本表示的情况下非常有用。如果 `null` ,则表示该 token 没有字节表示。 + 表示该 token UTF-8 字节表示的整数列表。在字符由多个 token 表示且必须组合其字节表示才能生成正确文本表示时非常有用。如果该 token 没有字节表示,则可以为 `null` 。 - `logprob: number` - 如果该 token 位于概率最高的前 20 个 token 之内,则为其对数概率。否则,值 `-9999.0` 用于表示该 token 出现的可能性极低。 + 该 token 的对数概率(如果它位于概率最高的 20 个 token 之内)。否则,值为 `-9999.0` 表示该 token 极不可能出现。 - `top_logprobs: array of object { token, bytes, logprob }` - 在该 token 位置处最可能出现的 token 列表及其对数概率。条目数量可能少于请求的 `top_logprobs`. + 在该 token 位置上,最可能出现的 token 及其对数概率的列表。条目数量可能少于所请求的 `top_logprobs`. - `token: string` @@ -5837,15 +5838,15 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `bytes: array of number or null` - 一个整数列表,表示该 token 的 UTF-8 字节表示。在某些字符由多个 token 表示,且必须组合其字节表示才能生成正确文本表示的情况下非常有用。如果 `null` ,则表示该 token 没有字节表示。 + 表示该 token UTF-8 字节表示的整数列表。在字符由多个 token 表示且必须组合其字节表示才能生成正确文本表示时非常有用。如果该 token 没有字节表示,则可以为 `null` 。 - `logprob: number` - 如果该 token 位于概率最高的前 20 个 token 之内,则为其对数概率。否则,值 `-9999.0` 用于表示该 token 出现的可能性极低。 + 该 token 的对数概率(如果它位于概率最高的 20 个 token 之内)。否则,值为 `-9999.0` 表示该 token 极不可能出现。 - `refusal: array of ChatCompletionTokenLogprob or null` - 包含对数概率信息的消息拒绝 token 列表。 + 包含对数概率信息的拒绝消息 token 列表。 - `token: string` @@ -5853,23 +5854,23 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `bytes: array of number or null` - 一个整数列表,表示该 token 的 UTF-8 字节表示。在某些字符由多个 token 表示,且必须组合其字节表示才能生成正确文本表示的情况下非常有用。如果 `null` ,则表示该 token 没有字节表示。 + 表示该 token UTF-8 字节表示的整数列表。在字符由多个 token 表示且必须组合其字节表示才能生成正确文本表示时非常有用。如果该 token 没有字节表示,则可以为 `null` 。 - `logprob: number` - 如果该 token 位于概率最高的前 20 个 token 之内,则为其对数概率。否则,值 `-9999.0` 用于表示该 token 出现的可能性极低。 + 该 token 的对数概率(如果它位于概率最高的 20 个 token 之内)。否则,值为 `-9999.0` 表示该 token 极不可能出现。 - `top_logprobs: array of object { token, bytes, logprob }` - 在该 token 位置处最可能出现的 token 列表及其对数概率。条目数量可能少于请求的 `top_logprobs`. + 在该 token 位置上,最可能出现的 token 及其对数概率的列表。条目数量可能少于所请求的 `top_logprobs`. - `created: number` - 聊天补全创建时的 Unix 时间戳(以秒为单位)。每个分块具有相同的时间戳。 + 聊天完成创建时的 Unix 时间戳(以秒为单位)。每个分块具有相同的时间戳。 - `model: string` - 用于生成补全的模型。 + 用于生成完成的模型。 - `object: "chat.completion.chunk"` @@ -5879,12 +5880,12 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `moderation: optional object { input, output } or null` - 针对请求输入和生成输出的审核结果。当请求经过审核的补全时, + 请求输入和生成输出的审核结果。当请求经过审核的完成时, 该字段会出现在审核分块上。 - `input: object { model, results, type } or object { code, message, type }` - 请求输入的审核结果。 + 对请求输入的审核。 - `ModerationResults object { model, results, type }` @@ -5900,11 +5901,11 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `categories: map[boolean]` - 审核类别到布尔值的字典,若输入在该类别下被标记则为 True。 + 一个从审核类别到布尔值的字典,若输入在该类别下被标记则为 True。 - `category_applied_input_types: map[array of "text" or "image"]` - 每个类别的分数所对应的输入模态。 + 每个类别的分数所反映的输入模态。 - `"text"` @@ -5912,19 +5913,19 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `category_scores: map[number]` - 审核类别到分数的字典。 + 一个从审核类别到分数的字典。 - `flagged: boolean` - 指示内容是否被任意类别标记的布尔值。 + 一个布尔值,指示内容是否被任何类别标记。 - `model: string` - 生成该结果的审核模型。 + 生成此结果的审核模型。 - `type: "moderation_result"` - 对象类型,过去始终为 `moderation_result` (用于成功的审核结果)。 + 对象类型,在成功的审核结果中始终为 `moderation_result` 。 - `"moderation_result"` @@ -5944,7 +5945,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `message: string` - 错误信息。 + 错误消息。 - `type: "error"` @@ -5954,7 +5955,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `output: object { model, results, type } or object { code, message, type }` - 对生成输出的内容审核。 + 生成输出的审核。 - `ModerationResults object { model, results, type }` @@ -5970,11 +5971,11 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `categories: map[boolean]` - 审核类别到布尔值的字典,若输入在该类别下被标记则为 True。 + 一个从审核类别到布尔值的字典,若输入在该类别下被标记则为 True。 - `category_applied_input_types: map[array of "text" or "image"]` - 每个类别的分数所对应的输入模态。 + 每个类别的分数所反映的输入模态。 - `"text"` @@ -5982,19 +5983,19 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `category_scores: map[number]` - 审核类别到分数的字典。 + 一个从审核类别到分数的字典。 - `flagged: boolean` - 指示内容是否被任意类别标记的布尔值。 + 一个布尔值,指示内容是否被任何类别标记。 - `model: string` - 生成该结果的审核模型。 + 生成此结果的审核模型。 - `type: "moderation_result"` - 对象类型,过去始终为 `moderation_result` (用于成功的审核结果)。 + 对象类型,在成功的审核结果中始终为 `moderation_result` 。 - `"moderation_result"` @@ -6014,7 +6015,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `message: string` - 错误信息。 + 错误消息。 - `type: "error"` @@ -6024,21 +6025,21 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `obfuscation: optional string` - 添加的混淆字符串,用于将流式分块的大小标准化,作为 - 针对某些侧信道攻击的一种缓解措施。默认情况下包含该字段,并在 - 时省略 `stream_options.include_obfuscation` 为 `false`. + 添加的混淆字符串,用于将流式分块的大小标准化, + 作为对某些侧信道攻击的缓解措施。该字段默认包含, + 当 `stream_options.include_obfuscation` 为 `false`. - `service_tier: optional "auto" or "default" or "flex" or 3 more or null` 指定用于处理请求的处理类型。 - - 如果设置为 'auto',则请求将按照项目设置中配置的服务层级处理。除非另行配置,项目将使用 'default'。 - - 如果设置为 'default',则请求将以所选模型的标准定价和性能进行处理。 + - 如果设置为 'auto',则请求将使用 Project 设置中配置的服务层级进行处理。除非另行配置,否则该 Project 将使用 'default'。 + - 如果设置为 'default',则请求将使用所选模型的标准定价和性能进行处理。 - 如果设置为 '[flex](/docs/guides/flex-processing)',则请求将使用 Flex Processing 服务层级进行处理。 - - 若要在请求级别启用 [Fast mode](/api/docs/guides/fast-mode) ,请在 Responses 或 Chat Completions 中包含 `service_tier=fast` 或 `service_tier=priority` 参数。响应中将显示 `service_tier=priority` ,无论你是否在请求中指定了 `service_tier=fast` 或 `priority` 。 + - 要在请求级别启用 [Fast mode](/api/docs/guides/fast-mode) ,请在 Responses 或 Chat Completions 中包含 `service_tier=fast` 或 `service_tier=priority` 参数。响应中将显示 `service_tier=priority` ,无论你是否在请求中指定 `service_tier=fast` 或 `priority` 。 - 未设置时,默认行为为 'auto'。 - 当 `service_tier` 参数被设置时,响应体将根据实际用于处理请求的处理模式返回 `service_tier` 值。该响应值可能与参数中设置的值不同。 + 当设置了 `service_tier` 参数时,响应主体将根据实际用于处理该请求的处理模式包含对应的 `service_tier` 值。该响应值可能与参数中设置的值不同。 - `"auto"` @@ -6054,90 +6055,90 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `system_fingerprint: optional string` - 此指纹表示模型运行所使用后端配置。 - 可与 `seed` 请求参数结合使用,以了解何时发生了可能影响确定性的后端变更。 + 此指纹表示模型运行所使用的后端配置。 + 可与 `seed` 请求参数结合使用,以了解何时进行了可能影响确定性的后端变更。 - `usage: optional CompletionUsage or null` - 仅当你在请求中设置 - `stream_options: {"include_usage": true}` 时才会出现的可选字段。出现时,它 - 包含 null 值, **最后一个分块除外** 其中包含 - 整个请求的 token 使用统计信息。 + 一个可选字段,仅当你在请求中设置了 + `stream_options: {"include_usage": true}` 时才会出现。当出现时,它 + 包含一个 null 值 **,最后一个分块除外** 其中包含整个请求的 + token 使用统计信息。 - **注意:** 如果流被中断或取消,你可能无法 - 收到包含该请求总 token 用量的最终 usage 数据块,其中包含 - 该请求。 + **注意:** 如果流被中断或取消,你可能不会 + 收到包含整个请求总 token 使用量的最终 usage 分块, + 即请求的 usage 信息。 - `completion_tokens: number` - 生成补全中的令牌数量。 + 生成补全中的 token 数。 - `prompt_tokens: number` - 提示中的令牌数量。 + 提示中的 token 数。 - `total_tokens: number` - 请求中使用的令牌总数(提示 + 补全)。 + 请求中使用的总 token 数(提示 + 补全)。 - `completion_tokens_details: optional object { accepted_prediction_tokens, audio_tokens, reasoning_tokens, 2 more }` - 补全中使用的令牌细分。 + 补全中使用的 token 明细。 - `accepted_prediction_tokens: optional number` 使用 Predicted Outputs 时, - 出现在补全中的预测令牌数量。 + 补全中出现的预测 token 数。 - `audio_tokens: optional number` - 由模型生成的音频输入令牌。 + 模型生成的音频输入 token。 - `reasoning_tokens: optional number` - 由模型生成用于推理的令牌。 + 模型为推理生成的 token。 - `rejected_prediction_tokens: optional number` 使用 Predicted Outputs 时, - 未出现在补全中的预测令牌。但是,与 - 推理令牌一样,这些令牌仍会计入用于计费、 - 输出和上下文窗口用途的补全令牌总数 - 限制中。 + 未在补全中出现的预测 token。但是,与 + 推理 token 一样,这些 token 仍会计入 + 用于计费、输出和上下文窗口限制的 + 总补全 token 数中。 - `text_tokens: optional number` - 由模型生成的文本输出令牌。 + 模型生成的文本输出 token。 - `compute_units: optional number or null` - 该请求的计算单元。目前可用时为 null。 + 请求的计算单元。目前可用时为 null。 - `prompt_tokens_details: optional object { audio_tokens, cache_write_tokens, cached_tokens, 2 more }` - 提示中使用的 token 分类明细。 + 提示词中所使用 token 的明细。 - `audio_tokens: optional number` - 提示中存在的音频输入 token。 + 提示词中存在的音频输入 token。 - `cache_write_tokens: optional number` - 写入缓存的未调整提示 token 数量。 + 写入缓存的提示词 token 未调整数量。 - `cached_tokens: optional number` - 提示中存在的已缓存 token。 + 提示词中存在的已缓存 token。 - `image_tokens: optional number` - 提示中存在的图像输入 token。 + 提示词中存在的图像输入 token。 - `text_tokens: optional number` - 提示中存在的文本输入 token。 + 提示词中存在的文本输入 token。 -### Chat Completion Content Part +### Chat Completion 内容分块 - `ChatCompletionContentPart = ChatCompletionContentPartText or ChatCompletionContentPartImage or ChatCompletionContentPartInputAudio or object { file, type, prompt_cache_breakpoint }` @@ -6159,7 +6160,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `prompt_cache_breakpoint: optional object { mode }` - 标记可复用提示前缀的精确结束位置。该断点会沿用请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。 + 标记可复用提示前缀的确切结束位置。该断点继承自请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。 - `mode: "explicit"` @@ -6179,7 +6180,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `detail: optional "auto" or "low" or "high"` - 指定图像的细节级别。在 [视觉指南](/docs/guides/vision#low-or-high-fidelity-image-understanding). + 指定图像的细节级别。更多信息请参阅 [视觉指南](/docs/guides/vision#low-or-high-fidelity-image-understanding). - `"auto"` @@ -6195,7 +6196,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `prompt_cache_breakpoint: optional object { mode }` - 标记可复用提示前缀的精确结束位置。该断点会沿用请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。 + 标记可复用提示前缀的确切结束位置。该断点继承自请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。 - `mode: "explicit"` @@ -6229,7 +6230,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `prompt_cache_breakpoint: optional object { mode }` - 标记可复用提示前缀的精确结束位置。该断点会沿用请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。 + 标记可复用提示前缀的确切结束位置。该断点继承自请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。 - `mode: "explicit"` @@ -6245,8 +6246,8 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `file_data: optional string` - Base64 编码的文件数据,在将文件作为字符串传递给模型时使用 - 。 + base64 编码的文件数据,在将文件传递给模型时使用 + 字符串。 - `file_id: optional string` @@ -6254,8 +6255,8 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `filename: optional string` - 文件的名称,在将文件作为字符串传递给模型时使用 - 。 + 文件的名称,在将文件以 + 字符串形式传递给模型时使用。 - `type: "file"` @@ -6265,7 +6266,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `prompt_cache_breakpoint: optional object { mode }` - 标记可复用提示前缀的精确结束位置。该断点会沿用请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。 + 标记可复用提示前缀的确切结束位置。该断点继承自请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。 - `mode: "explicit"` @@ -6273,7 +6274,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `"explicit"` -### Chat Completion Content Part Image +### Chat Completion 内容分块图像 - `ChatCompletionContentPartImage object { image_url, type, prompt_cache_breakpoint }` @@ -6287,7 +6288,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `detail: optional "auto" or "low" or "high"` - 指定图像的细节级别。在 [视觉指南](/docs/guides/vision#low-or-high-fidelity-image-understanding). + 指定图像的细节级别。更多信息请参阅 [视觉指南](/docs/guides/vision#low-or-high-fidelity-image-understanding). - `"auto"` @@ -6303,7 +6304,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `prompt_cache_breakpoint: optional object { mode }` - 标记可复用提示前缀的精确结束位置。该断点会沿用请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。 + 标记可复用提示前缀的确切结束位置。该断点继承自请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。 - `mode: "explicit"` @@ -6311,7 +6312,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `"explicit"` -### Chat Completion Content Part Input Audio +### Chat Completion 内容分块输入音频 - `ChatCompletionContentPartInputAudio object { input_audio, type, prompt_cache_breakpoint }` @@ -6339,7 +6340,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `prompt_cache_breakpoint: optional object { mode }` - 标记可复用提示前缀的精确结束位置。该断点会沿用请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。 + 标记可复用提示前缀的确切结束位置。该断点继承自请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。 - `mode: "explicit"` @@ -6347,13 +6348,13 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `"explicit"` -### Chat Completion Content Part Refusal +### Chat Completion 内容分块拒绝 - `ChatCompletionContentPartRefusal object { refusal, type }` - `refusal: string` - 模型生成的拒绝消息。 + 由模型生成的拒绝消息。 - `type: "refusal"` @@ -6361,7 +6362,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `"refusal"` -### Chat Completion Content Part Text +### Chat Completion 内容分块文本 - `ChatCompletionContentPartText object { text, type, prompt_cache_breakpoint }` @@ -6379,7 +6380,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `prompt_cache_breakpoint: optional object { mode }` - 标记可复用提示前缀的精确结束位置。该断点会沿用请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。 + 标记可复用提示前缀的确切结束位置。该断点继承自请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。 - `mode: "explicit"` @@ -6387,7 +6388,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `"explicit"` -### Chat Completion Custom Tool +### Chat Completion 自定义工具 - `ChatCompletionCustomTool object { custom, type }` @@ -6433,7 +6434,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `syntax: "lark" or "regex"` - 语法定义的语法格式。可选值为 `lark` 或 `regex`. + 语法定义的语法格式,取值之一为 `lark` 或 `regex`. - `"lark"` @@ -6451,17 +6452,17 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `"custom"` -### Chat Completion Deleted +### Chat Completion 已删除 - `ChatCompletionDeleted object { id, deleted, object }` - `id: string` - 被删除的聊天补全的 ID。 + 已删除的聊天补全的 ID。 - `deleted: boolean` - 聊天补全是否已被删除。 + 聊天补全是否已删除。 - `object: "chat.completion.deleted"` @@ -6469,13 +6470,13 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `"chat.completion.deleted"` -### Chat Completion Developer Message Param +### Chat Completion 开发者消息参数 - `ChatCompletionDeveloperMessageParam object { content, role, name }` - 由开发者提供的指令,模型应遵循这些指令,无论用户发送了什么消息。对于 o1 及更新的模型, - 不支持这些参数。 `developer` messages - 替换之前的 `system` messages。 + 开发者提供的指令,无论用户发送什么 + 消息,模型都应遵循。对于 o1 及更新的模型, `developer` messages + 将取代先前的 `system` messages。 - `content: string or array of ChatCompletionContentPartText` @@ -6487,7 +6488,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `ArrayOfContentParts = array of ChatCompletionContentPartText` - 由已定义类型组成的内容部分数组。对于开发者消息,仅支持类型 `text` 。 + 具有已定义类型的 content parts 数组。对于开发者消息,仅支持 type `text` 类型。 - `text: string` @@ -6501,7 +6502,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `prompt_cache_breakpoint: optional object { mode }` - 标记可复用提示前缀的精确结束位置。该断点会沿用请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。 + 标记可复用提示前缀的确切结束位置。该断点继承自请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。 - `mode: "explicit"` @@ -6517,19 +6518,19 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `name: optional string` - 该参与者的可选名称。为模型提供信息,以便区分相同角色的不同参与者。 + 参与者的可选名称。为模型提供信息,以便区分同一角色的不同参与者。 -### Chat Completion Function Call Option +### Chat Completion 函数调用选项 - `ChatCompletionFunctionCallOption object { name }` - 通过以下方式指定某个具体函数 `{"name": "my_function"}` 强制模型调用该函数。 + 通过 `{"name": "my_function"}` 强制模型调用该函数。 - `name: string` 要调用的函数名称。 -### Chat Completion Function Message Param +### Chat Completion 函数消息参数 - `ChatCompletionFunctionMessageParam object { content, name, role }` @@ -6547,7 +6548,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `"function"` -### Chat Completion Function Tool +### Chat Completion 函数工具 - `ChatCompletionFunctionTool object { function, type }` @@ -6557,33 +6558,33 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `name: string` - 要调用的函数名称。必须由 a-z、A-Z、0-9 组成,或包含下划线和连字符,最大长度为 64。 + 要调用的函数名称。必须为 a-z、A-Z、0-9,或包含下划线和短横线,最大长度为 64。 - `description: optional string` - 对函数功能的描述,模型据此选择何时以及如何调用该函数。 + 对函数作用的描述,模型据此选择何时以及如何调用该函数。 - `parameters: optional FunctionParameters` - 函数接受的参数,使用 JSON Schema 对象描述。请参阅 [指南](/docs/guides/function-calling) 中的示例,以及 [JSON Schema 参考](https://json-schema.org/understanding-json-schema/) ,了解相关格式的文档。 + 函数接受的参数,以 JSON Schema 对象描述。参阅 [指南](/docs/guides/function-calling) 中的示例,以及 [JSON Schema 参考](https://json-schema.org/understanding-json-schema/) 获取有关该格式的文档。 - 省略 `parameters` 定义了一个参数列表为空的函数。 + 省略 `parameters` 用于定义一个参数列表为空的函数。 - `strict: optional boolean or null` - 在生成函数调用时是否启用严格的模式遵循。如果设置为 true,模型将遵循 `parameters` 字段中。当 `strict` 为 `true`。中定义的确切模式。在函数调用指南中了解更多关于结构化输出的信息。 [function calling 指南](/docs/guides/function-calling). + 在生成函数调用时是否启用严格模式遵循。如果设置为 true,模型将遵循 `parameters` 字段时。如需了解更多信息,请参阅 `strict` 为 `true`。中定义的确切模式。详细了解结构化输出,请参阅 [function calling guide](/docs/guides/function-calling). - `type: "function"` - 工具的类型。目前,仅 `function` 。 + 工具的类型。目前,仅 `function` 类型。 - `"function"` -### Chat Completion Message +### Chat Completion 消息 - `ChatCompletionMessage object { content, refusal, role, 4 more }` - 由模型生成的聊天补全消息。 + 由模型生成的聊天完成消息。 - `content: string or null` @@ -6591,18 +6592,18 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `refusal: string or null` - 模型生成的拒绝消息。 + 由模型生成的拒绝消息。 - `role: "assistant"` - 此消息作者的角色。 + 该消息作者的角色。 - `"assistant"` - `annotations: optional array of object { type, url_citation }` - 消息的注解(如适用),例如使用 - [网页搜索 工具](/docs/guides/tools-web-search?api-mode=chat). + 消息的注释(如果适用),例如在使用 + [网页搜索工具](/docs/guides/tools-web-search?api-mode=chat). - `type: "url_citation"` @@ -6620,7 +6621,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `start_index: number` - 消息中 URL 引用第一个字符的索引。 + 消息中 URL 引用的第一个字符的索引。 - `title: string` @@ -6632,8 +6633,8 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `audio: optional ChatCompletionAudio or null` - 如果请求了音频输出模态,则此对象包含 - 来自模型的音频响应的相关数据。 [了解更多](/docs/guides/audio). + 如果请求了音频输出模态,该对象包含来自模型的音频 + 响应的相关数据。 [了解更多](/docs/guides/audio). - `id: string` @@ -6641,14 +6642,14 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `data: string` - 由模型生成的 Base64 编码音频字节,格式为 + 模型生成的 Base64 编码音频字节,格式为 请求中指定的格式。 - `expires_at: number` - 此音频响应在服务端不再可访问的 Unix 时间戳(秒),用于多轮 - 对话中的后续使用。 - conversations。 + 此音频响应在服务端上无法再被用于多轮 + 访问的 Unix 时间戳(秒)。 + 对话。 - `transcript: string` @@ -6656,11 +6657,11 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `function_call: optional object { arguments, name }` - 已弃用,由 `tool_calls`。替代。模型生成的应被调用的函数名称和参数。 + 已弃用,由 `tool_calls`。替代。应调用的函数的名称和参数,由模型生成。 - `arguments: string` - 以 JSON 格式传递给函数的参数,由模型生成。请注意,模型并不总是生成有效的 JSON,并且可能会虚构函数 schema 中未定义的参数。在调用函数之前,请在代码中校验这些参数。 + 调用函数时使用的参数,以 JSON 格式由模型生成。请注意,模型并不总是生成有效的 JSON,并且可能会虚构你的函数 schema 中未定义的参数。在调用函数之前,请在代码中校验这些参数。 - `name: string` @@ -6684,7 +6685,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `arguments: string` - 以 JSON 格式传递给函数的参数,由模型生成。请注意,模型并不总是生成有效的 JSON,并且可能会虚构函数 schema 中未定义的参数。在调用函数之前,请在代码中校验这些参数。 + 调用函数时使用的参数,以 JSON 格式由模型生成。请注意,模型并不总是生成有效的 JSON,并且可能会虚构你的函数 schema 中未定义的参数。在调用函数之前,请在代码中校验这些参数。 - `name: string` @@ -6692,7 +6693,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `type: "function"` - 工具的类型。目前,仅 `function` 。 + 工具的类型。目前,仅 `function` 类型。 - `"function"` @@ -6722,7 +6723,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `"custom"` -### Chat Completion Message Custom Tool Call +### Chat Completion 消息自定义工具调用 - `ChatCompletionMessageCustomToolCall object { id, custom, type }` @@ -6750,7 +6751,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `"custom"` -### Chat Completion Message Function Tool Call +### Chat Completion 消息函数工具调用 - `ChatCompletionMessageFunctionToolCall object { id, function, type }` @@ -6766,7 +6767,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `arguments: string` - 以 JSON 格式传递给函数的参数,由模型生成。请注意,模型并不总是生成有效的 JSON,并且可能会虚构函数 schema 中未定义的参数。在调用函数之前,请在代码中校验这些参数。 + 调用函数时使用的参数,以 JSON 格式由模型生成。请注意,模型并不总是生成有效的 JSON,并且可能会虚构你的函数 schema 中未定义的参数。在调用函数之前,请在代码中校验这些参数。 - `name: string` @@ -6774,23 +6775,23 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `type: "function"` - 工具的类型。目前,仅 `function` 。 + 工具的类型。目前,仅 `function` 类型。 - `"function"` -### Chat Completion Message Param +### Chat Completion 消息参数 - `ChatCompletionMessageParam = ChatCompletionDeveloperMessageParam or ChatCompletionSystemMessageParam or ChatCompletionUserMessageParam or 3 more` - 由开发者提供的指令,模型应遵循这些指令,无论用户发送了什么消息。对于 o1 及更新的模型, - 不支持这些参数。 `developer` messages - 替换之前的 `system` messages。 + 开发者提供的指令,无论用户发送什么 + 消息,模型都应遵循。对于 o1 及更新的模型, `developer` messages + 将取代先前的 `system` messages。 - `ChatCompletionDeveloperMessageParam object { content, role, name }` - 由开发者提供的指令,模型应遵循这些指令,无论用户发送了什么消息。对于 o1 及更新的模型, - 不支持这些参数。 `developer` messages - 替换之前的 `system` messages。 + 开发者提供的指令,无论用户发送什么 + 消息,模型都应遵循。对于 o1 及更新的模型, `developer` messages + 将取代先前的 `system` messages。 - `content: string or array of ChatCompletionContentPartText` @@ -6802,7 +6803,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `ArrayOfContentParts = array of ChatCompletionContentPartText` - 由已定义类型组成的内容部分数组。对于开发者消息,仅支持类型 `text` 。 + 具有已定义类型的 content parts 数组。对于开发者消息,仅支持 type `text` 类型。 - `text: string` @@ -6816,7 +6817,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `prompt_cache_breakpoint: optional object { mode }` - 标记可复用提示前缀的精确结束位置。该断点会沿用请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。 + 标记可复用提示前缀的确切结束位置。该断点继承自请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。 - `mode: "explicit"` @@ -6832,13 +6833,13 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `name: optional string` - 该参与者的可选名称。为模型提供信息,以便区分相同角色的不同参与者。 + 参与者的可选名称。为模型提供信息,以便区分同一角色的不同参与者。 - `ChatCompletionSystemMessageParam object { content, role, name }` - 由开发者提供的指令,模型应遵循这些指令,无论用户发送了什么消息。对于 o1 及更新的模型, - 由用户发送的消息。对于 o1 及更新的模型,请使用 `developer` messages - 来代替实现此目的。 + 开发者提供的指令,无论用户发送什么 + 用户发送的消息。对于 o1 及更高版本的模型,请改用 `developer` messages + 来实现此目的。 - `content: string or array of ChatCompletionContentPartText` @@ -6850,7 +6851,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `ArrayOfContentParts = array of ChatCompletionContentPartText` - 具有指定类型的内容部分数组。对于系统消息,仅支持 type `text` 。 + 具有已定义类型的内容部分数组。对于系统消息,仅支持类型 `text` 类型。 - `text: string` @@ -6862,7 +6863,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `prompt_cache_breakpoint: optional object { mode }` - 标记可复用提示前缀的精确结束位置。该断点会沿用请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。 + 标记可复用提示前缀的确切结束位置。该断点继承自请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。 - `role: "system"` @@ -6872,7 +6873,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `name: optional string` - 该参与者的可选名称。为模型提供信息,以便区分相同角色的不同参与者。 + 参与者的可选名称。为模型提供信息,以便区分同一角色的不同参与者。 - `ChatCompletionUserMessageParam object { content, role, name }` @@ -6889,7 +6890,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `ArrayOfContentParts = array of ChatCompletionContentPart` - 具有指定类型的内容部分数组。支持选项因用于生成响应的 [model](/docs/models) 而有所不同。可以包含文本、图像或音频输入。 + 具有已定义类型的内容部分数组。支持的具体选项因用于生成响应的 [model](/docs/models) 而异。可以包含文本、图像或音频输入。 - `ChatCompletionContentPartText object { text, type, prompt_cache_breakpoint }` @@ -6905,7 +6906,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `prompt_cache_breakpoint: optional object { mode }` - 标记可复用提示前缀的精确结束位置。该断点会沿用请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。 + 标记可复用提示前缀的确切结束位置。该断点继承自请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。 - `ChatCompletionContentPartImage object { image_url, type, prompt_cache_breakpoint }` @@ -6919,7 +6920,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `detail: optional "auto" or "low" or "high"` - 指定图像的细节级别。在 [视觉指南](/docs/guides/vision#low-or-high-fidelity-image-understanding). + 指定图像的细节级别。更多信息请参阅 [视觉指南](/docs/guides/vision#low-or-high-fidelity-image-understanding). - `"auto"` @@ -6935,7 +6936,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `prompt_cache_breakpoint: optional object { mode }` - 标记可复用提示前缀的精确结束位置。该断点会沿用请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。 + 标记可复用提示前缀的确切结束位置。该断点继承自请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。 - `mode: "explicit"` @@ -6969,7 +6970,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `prompt_cache_breakpoint: optional object { mode }` - 标记可复用提示前缀的精确结束位置。该断点会沿用请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。 + 标记可复用提示前缀的确切结束位置。该断点继承自请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。 - `mode: "explicit"` @@ -6985,8 +6986,8 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `file_data: optional string` - Base64 编码的文件数据,在将文件作为字符串传递给模型时使用 - 。 + base64 编码的文件数据,在将文件传递给模型时使用 + 字符串。 - `file_id: optional string` @@ -6994,8 +6995,8 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `filename: optional string` - 文件的名称,在将文件作为字符串传递给模型时使用 - 。 + 文件的名称,在将文件以 + 字符串形式传递给模型时使用。 - `type: "file"` @@ -7005,7 +7006,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `prompt_cache_breakpoint: optional object { mode }` - 标记可复用提示前缀的精确结束位置。该断点会沿用请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。 + 标记可复用提示前缀的确切结束位置。该断点继承自请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。 - `mode: "explicit"` @@ -7021,7 +7022,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `name: optional string` - 该参与者的可选名称。为模型提供信息,以便区分相同角色的不同参与者。 + 参与者的可选名称。为模型提供信息,以便区分同一角色的不同参与者。 - `ChatCompletionAssistantMessageParam object { role, audio, content, 4 more }` @@ -7035,7 +7036,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `audio: optional object { id } or null` - 关于模型先前音频响应的数据。 + 模型先前音频响应的相关数据。 [了解更多](/docs/guides/audio). - `id: string` @@ -7044,7 +7045,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `content: optional string or array of ChatCompletionContentPartText or ChatCompletionContentPartRefusal or null` - 助手消息的内容。除非指定了 `tool_calls` 或 `function_call` ,否则必填。 + 助手消息的内容。除非指定了 `tool_calls` 或 `function_call` ,否则此字段为必填。 - `TextContent = string` @@ -7052,7 +7053,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `ArrayOfContentParts = array of ChatCompletionContentPartText or ChatCompletionContentPartRefusal` - 由已定义类型组成的内容部分数组。可以包含一个或多个类型为 `text`,或恰好一个类型为 `refusal`. + 具有已定义类型的内容片段数组。可以是以下类型的一个或多个 `text`,或以下类型的恰好一个 `refusal`. - `ChatCompletionContentPartText object { text, type, prompt_cache_breakpoint }` @@ -7062,7 +7063,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `refusal: string` - 模型生成的拒绝消息。 + 由模型生成的拒绝消息。 - `type: "refusal"` @@ -7072,11 +7073,11 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `function_call: optional object { arguments, name } or null` - 已弃用,由 `tool_calls`。替代。模型生成的应被调用的函数名称和参数。 + 已弃用,由 `tool_calls`。替代。应调用的函数的名称和参数,由模型生成。 - `arguments: string` - 以 JSON 格式传递给函数的参数,由模型生成。请注意,模型并不总是生成有效的 JSON,并且可能会虚构函数 schema 中未定义的参数。在调用函数之前,请在代码中校验这些参数。 + 调用函数时使用的参数,以 JSON 格式由模型生成。请注意,模型并不总是生成有效的 JSON,并且可能会虚构你的函数 schema 中未定义的参数。在调用函数之前,请在代码中校验这些参数。 - `name: string` @@ -7084,11 +7085,11 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `name: optional string` - 该参与者的可选名称。为模型提供信息,以便区分相同角色的不同参与者。 + 参与者的可选名称。为模型提供信息,以便区分同一角色的不同参与者。 - `refusal: optional string or null` - 助手给出的拒绝消息。 + 助手生成的拒绝消息。 - `tool_calls: optional array of ChatCompletionMessageToolCall` @@ -7108,7 +7109,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `arguments: string` - 以 JSON 格式传递给函数的参数,由模型生成。请注意,模型并不总是生成有效的 JSON,并且可能会虚构函数 schema 中未定义的参数。在调用函数之前,请在代码中校验这些参数。 + 调用函数时使用的参数,以 JSON 格式由模型生成。请注意,模型并不总是生成有效的 JSON,并且可能会虚构你的函数 schema 中未定义的参数。在调用函数之前,请在代码中校验这些参数。 - `name: string` @@ -7116,7 +7117,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `type: "function"` - 工具的类型。目前,仅 `function` 。 + 工具的类型。目前,仅 `function` 类型。 - `"function"` @@ -7158,7 +7159,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `ArrayOfContentParts = array of ChatCompletionContentPartText` - 由指定类型组成的内容片段数组。对于工具消息,仅支持 type `text` 。 + 由已定义类型组成的内容分块数组。对于工具消息,仅支持类型 `text` 类型。 - `text: string` @@ -7170,7 +7171,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `prompt_cache_breakpoint: optional object { mode }` - 标记可复用提示前缀的精确结束位置。该断点会沿用请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。 + 标记可复用提示前缀的确切结束位置。该断点继承自请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。 - `role: "tool"` @@ -7198,7 +7199,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `"function"` -### Chat Completion Message Tool Call +### Chat Completion 消息工具调用 - `ChatCompletionMessageToolCall = ChatCompletionMessageFunctionToolCall or ChatCompletionMessageCustomToolCall` @@ -7218,7 +7219,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `arguments: string` - 以 JSON 格式传递给函数的参数,由模型生成。请注意,模型并不总是生成有效的 JSON,并且可能会虚构函数 schema 中未定义的参数。在调用函数之前,请在代码中校验这些参数。 + 调用函数时使用的参数,以 JSON 格式由模型生成。请注意,模型并不总是生成有效的 JSON,并且可能会虚构你的函数 schema 中未定义的参数。在调用函数之前,请在代码中校验这些参数。 - `name: string` @@ -7226,7 +7227,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `type: "function"` - 工具的类型。目前,仅 `function` 。 + 工具的类型。目前,仅 `function` 类型。 - `"function"` @@ -7256,7 +7257,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `"custom"` -### Chat Completion Modality +### Chat Completion 模态 - `ChatCompletionModality = "text" or "audio"` @@ -7264,7 +7265,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `"audio"` -### Chat Completion Named Tool Choice +### Chat Completion 命名工具选择 - `ChatCompletionNamedToolChoice object { function, type }` @@ -7282,7 +7283,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `"function"` -### Chat Completion Named Tool Choice Custom +### Chat Completion 命名工具选择自定义 - `ChatCompletionNamedToolChoiceCustom object { custom, type }` @@ -7300,27 +7301,27 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `"custom"` -### Chat Completion Prediction Content +### Chat Completion 预测内容 - `ChatCompletionPredictionContent object { content, type }` 静态预测输出内容,例如正在重新生成的文本文件的内容。 - being regenerated. + 正在重新生成。 - `content: string or array of ChatCompletionContentPartText` 生成模型响应时应匹配的内容。 - 如果生成的 token 与该内容匹配,则可以更快地返回完整的模型响应。 - can be returned much more quickly. + 如果生成的 token 与该内容匹配,则可以更快地返回整个模型响应。 + 可以更快地返回。 - `TextContent = string` - 用于 Predicted Output 的内容。这通常是 + 用于预测输出的内容。这通常是 你正在重新生成且仅有少量改动的文件文本。 - `ArrayOfContentParts = array of ChatCompletionContentPartText` - 具有指定类型的内容部分数组。支持选项因用于生成响应的 [model](/docs/models) 用于生成响应。可以包含文本输入。 + 具有已定义类型的内容部分数组。支持的具体选项因用于生成响应的 [model](/docs/models) 正在用于生成响应。可以包含文本输入。 - `text: string` @@ -7334,7 +7335,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `prompt_cache_breakpoint: optional object { mode }` - 标记可复用提示前缀的精确结束位置。该断点会沿用请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。 + 标记可复用提示前缀的确切结束位置。该断点继承自请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。 - `mode: "explicit"` @@ -7344,8 +7345,8 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `type: "content"` - 你希望提供的预测内容的类型。该类型目前始终为 - currently always `content`. + 你希望提供的预测内容的类型。该类型 + 目前始终为 `content`. - `"content"` @@ -7371,7 +7372,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `ChatCompletionStoreMessage = ChatCompletionMessage` - 由模型生成的聊天补全消息。 + 由模型生成的聊天完成消息。 - `id: string` @@ -7379,7 +7380,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `content_parts: optional array of ChatCompletionContentPartText or ChatCompletionContentPartImage or null` - 如果提供了内容 parts 数组,则这是一个 `text` 和 `image_url` parts 数组。 + 如果提供了内容部分数组,则这是一个由 `text` 和 `image_url` 部分组成的数组。 否则为 null。 - `ChatCompletionContentPartText object { text, type, prompt_cache_breakpoint }` @@ -7398,7 +7399,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `prompt_cache_breakpoint: optional object { mode }` - 标记可复用提示前缀的精确结束位置。该断点会沿用请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。 + 标记可复用提示前缀的确切结束位置。该断点继承自请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。 - `mode: "explicit"` @@ -7418,7 +7419,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `detail: optional "auto" or "low" or "high"` - 指定图像的细节级别。在 [视觉指南](/docs/guides/vision#low-or-high-fidelity-image-understanding). + 指定图像的细节级别。更多信息请参阅 [视觉指南](/docs/guides/vision#low-or-high-fidelity-image-understanding). - `"auto"` @@ -7434,7 +7435,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `prompt_cache_breakpoint: optional object { mode }` - 标记可复用提示前缀的精确结束位置。该断点会沿用请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。 + 标记可复用提示前缀的确切结束位置。该断点继承自请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。 - `mode: "explicit"` @@ -7446,36 +7447,36 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `ChatCompletionStreamOptions object { include_obfuscation, include_usage }` - 流式响应的选项。仅在设置 `stream: true`. + 流式响应的选项。仅在设置了 stream: true 时设置此参数。 `stream: true`. - `include_obfuscation: optional boolean` - 当为 true 时,将启用流混淆。流混淆会向 - 字段添加随机字符,用于 `obfuscation` 流式增量事件中的字段,以 - 规范化负载大小,作为对某些侧信道攻击的缓解措施。 - 默认情况下会包含这些混淆字段,但会为数据流增加少量 - 开销。如果信任客户端与 接口 之间的 `include_obfuscation` 设置为 - false 以优化带宽网络链路 + 如果为 true,将启用流混淆。流混淆会向流式增量事件上的 obfuscation 字段添加 + 随机字符,以规范化负载大小,作为对某些侧信道攻击的缓解措施。这些混淆字段默认包含,但会增加少量数据流的开销。如果你信任客户端与 接口 之间的网络链路,可以将 include_obfuscation 设置为 `obfuscation` field on streaming delta events to + normalize payload sizes as a mitigation to certain side-channel attacks. + These obfuscation fields are included by default, but add a small amount + of overhead to the data stream. You can set `include_obfuscation` 为 + false to optimize for bandwidth if you trust the network links between 你的应用与 OpenAI API 之间。 - `include_usage: optional boolean` - 如果设置了该参数,在 [choices] 字段之前会额外流式传输一个 [chunk]。 `data: [DONE]` - 消息。该数据块上的 `usage` 字段展示了整个请求的令牌使用统计信息, - 对于整个请求而言, `choices` 字段始终为一个空的 + 如果设置了该参数,则会在 `data: [DONE]` + 消息之前额外流式返回一个分块。该 `usage` 字段显示整个请求的 token 用量统计信息, + 而该请求的 `choices` 字段将始终为空 数组。 - 所有其他数据块也会包含一个 `usage` 字段,但值为 - null。 **注意:** 如果流被中断,你可能无法收到包含该请求总令牌使用量的 - 最后一个 usage 数据块。 + 所有其他分块也会包含一个 `usage` 字段,但其值为 + null。 **注意:** 如果流被中断,你可能不会收到包含该请求 + 总 token 用量的最后一个 usage 分块。 ### Chat Completion 系统消息参数 - `ChatCompletionSystemMessageParam object { content, role, name }` - 由开发者提供的指令,模型应遵循这些指令,无论用户发送了什么消息。对于 o1 及更新的模型, - 由用户发送的消息。对于 o1 及更新的模型,请使用 `developer` messages - 来代替实现此目的。 + 开发者提供的指令,无论用户发送什么 + 用户发送的消息。对于 o1 及更高版本的模型,请改用 `developer` messages + 来实现此目的。 - `content: string or array of ChatCompletionContentPartText` @@ -7487,7 +7488,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `ArrayOfContentParts = array of ChatCompletionContentPartText` - 具有指定类型的内容部分数组。对于系统消息,仅支持 type `text` 。 + 具有已定义类型的内容部分数组。对于系统消息,仅支持类型 `text` 类型。 - `text: string` @@ -7501,7 +7502,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `prompt_cache_breakpoint: optional object { mode }` - 标记可复用提示前缀的精确结束位置。该断点会沿用请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。 + 标记可复用提示前缀的确切结束位置。该断点继承自请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。 - `mode: "explicit"` @@ -7517,7 +7518,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `name: optional string` - 该参与者的可选名称。为模型提供信息,以便区分相同角色的不同参与者。 + 参与者的可选名称。为模型提供信息,以便区分同一角色的不同参与者。 ### Chat Completion Token Logprob @@ -7529,15 +7530,15 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `bytes: array of number or null` - 一个整数列表,表示该 token 的 UTF-8 字节表示。在某些字符由多个 token 表示,且必须组合其字节表示才能生成正确文本表示的情况下非常有用。如果 `null` ,则表示该 token 没有字节表示。 + 表示该 token UTF-8 字节表示的整数列表。在字符由多个 token 表示且必须组合其字节表示才能生成正确文本表示时非常有用。如果该 token 没有字节表示,则可以为 `null` 。 - `logprob: number` - 如果该 token 位于概率最高的前 20 个 token 之内,则为其对数概率。否则,值 `-9999.0` 用于表示该 token 出现的可能性极低。 + 该 token 的对数概率(如果它位于概率最高的 20 个 token 之内)。否则,值为 `-9999.0` 表示该 token 极不可能出现。 - `top_logprobs: array of object { token, bytes, logprob }` - 在该 token 位置处最可能出现的 token 列表及其对数概率。条目数量可能少于请求的 `top_logprobs`. + 在该 token 位置上,最可能出现的 token 及其对数概率的列表。条目数量可能少于所请求的 `top_logprobs`. - `token: string` @@ -7545,11 +7546,11 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `bytes: array of number or null` - 一个整数列表,表示该 token 的 UTF-8 字节表示。在某些字符由多个 token 表示,且必须组合其字节表示才能生成正确文本表示的情况下非常有用。如果 `null` ,则表示该 token 没有字节表示。 + 表示该 token UTF-8 字节表示的整数列表。在字符由多个 token 表示且必须组合其字节表示才能生成正确文本表示时非常有用。如果该 token 没有字节表示,则可以为 `null` 。 - `logprob: number` - 如果该 token 位于概率最高的前 20 个 token 之内,则为其对数概率。否则,值 `-9999.0` 用于表示该 token 出现的可能性极低。 + 该 token 的对数概率(如果它位于概率最高的 20 个 token 之内)。否则,值为 `-9999.0` 表示该 token 极不可能出现。 ### Chat Completion 工具 @@ -7565,25 +7566,25 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `name: string` - 要调用的函数名称。必须由 a-z、A-Z、0-9 组成,或包含下划线和连字符,最大长度为 64。 + 要调用的函数名称。必须为 a-z、A-Z、0-9,或包含下划线和短横线,最大长度为 64。 - `description: optional string` - 对函数功能的描述,模型据此选择何时以及如何调用该函数。 + 对函数作用的描述,模型据此选择何时以及如何调用该函数。 - `parameters: optional FunctionParameters` - 函数接受的参数,使用 JSON Schema 对象描述。请参阅 [指南](/docs/guides/function-calling) 中的示例,以及 [JSON Schema 参考](https://json-schema.org/understanding-json-schema/) ,了解相关格式的文档。 + 函数接受的参数,以 JSON Schema 对象描述。参阅 [指南](/docs/guides/function-calling) 中的示例,以及 [JSON Schema 参考](https://json-schema.org/understanding-json-schema/) 获取有关该格式的文档。 - 省略 `parameters` 定义了一个参数列表为空的函数。 + 省略 `parameters` 用于定义一个参数列表为空的函数。 - `strict: optional boolean or null` - 在生成函数调用时是否启用严格的模式遵循。如果设置为 true,模型将遵循 `parameters` 字段中。当 `strict` 为 `true`。中定义的确切模式。在函数调用指南中了解更多关于结构化输出的信息。 [function calling 指南](/docs/guides/function-calling). + 在生成函数调用时是否启用严格模式遵循。如果设置为 true,模型将遵循 `parameters` 字段时。如需了解更多信息,请参阅 `strict` 为 `true`。中定义的确切模式。详细了解结构化输出,请参阅 [function calling guide](/docs/guides/function-calling). - `type: "function"` - 工具的类型。目前,仅 `function` 。 + 工具的类型。目前,仅 `function` 类型。 - `"function"` @@ -7631,7 +7632,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `syntax: "lark" or "regex"` - 语法定义的语法格式。可选值为 `lark` 或 `regex`. + 语法定义的语法格式,取值之一为 `lark` 或 `regex`. - `"lark"` @@ -7653,17 +7654,17 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `ChatCompletionToolChoiceOption = "none" or "auto" or "required" or ChatCompletionAllowedToolChoice or ChatCompletionNamedToolChoice or ChatCompletionNamedToolChoiceCustom` - 控制模型调用哪个工具(如果有)。 + 控制模型调用哪些工具(如果有的话)。 `none` 表示模型不会调用任何工具,而是生成一条消息。 - `auto` 表示模型可以在生成消息或调用一个或多个工具之间选择。 + `auto` 表示模型可以在生成消息或调用一个或多个工具之间进行选择。 `required` 表示模型必须调用一个或多个工具。 - 通过指定特定工具 `{"type": "function", "function": {"name": "my_function"}}` 强制模型调用该工具。 + 通过指定特定工具来 `{"type": "function", "function": {"name": "my_function"}}` 强制模型调用该工具。 - `none` 是未提供任何工具时的默认值。 `auto` 是提供了工具时的默认值。 + `none` 是未提供任何工具时的默认行为。 `auto` 是提供了工具时的默认行为。 - `ToolChoiceMode = "none" or "auto" or "required"` - `none` 表示模型不会调用任何工具,而是生成一条消息。 `auto` 表示模型可以在生成消息或调用一个或多个工具之间选择。 `required` 表示模型必须调用一个或多个工具。 + `none` 表示模型不会调用任何工具,而是生成一条消息。 `auto` 表示模型可以在生成消息或调用一个或多个工具之间进行选择。 `required` 表示模型必须调用一个或多个工具。 - `"none"` @@ -7673,17 +7674,17 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `ChatCompletionAllowedToolChoice object { allowed_tools, type }` - 将模型可用的工具限制为预定义的集合。 + 将模型可使用的工具限制为预定义的集合。 - `allowed_tools: ChatCompletionAllowedTools` - 将模型可用的工具限制为预定义的集合。 + 将模型可使用的工具限制为预定义的集合。 - `mode: "auto" or "required"` - 将模型可用的工具限制为预定义的集合。 + 将模型可使用的工具限制为预定义的集合。 - `auto` 允许模型从允许的工具中选取并生成 + `auto` 允许模型从允许的工具中选择并生成 消息。 `required` 要求模型调用一个或多个允许的工具。 @@ -7694,9 +7695,9 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `tools: array of map[unknown]` - 允许模型调用的工具定义列表。 + 模型可调用的工具定义列表。 - 对于 Chat Completions API,工具定义列表可能如下所示: + 对于 Chat Completions API,工具定义列表可能如下: ```json [ @@ -7757,7 +7758,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `ArrayOfContentParts = array of ChatCompletionContentPartText` - 由指定类型组成的内容片段数组。对于工具消息,仅支持 type `text` 。 + 由已定义类型组成的内容分块数组。对于工具消息,仅支持类型 `text` 类型。 - `text: string` @@ -7771,7 +7772,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `prompt_cache_breakpoint: optional object { mode }` - 标记可复用提示前缀的精确结束位置。该断点会沿用请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。 + 标记可复用提示前缀的确切结束位置。该断点继承自请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。 - `mode: "explicit"` @@ -7806,7 +7807,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `ArrayOfContentParts = array of ChatCompletionContentPart` - 具有指定类型的内容部分数组。支持选项因用于生成响应的 [model](/docs/models) 而有所不同。可以包含文本、图像或音频输入。 + 具有已定义类型的内容部分数组。支持的具体选项因用于生成响应的 [model](/docs/models) 而异。可以包含文本、图像或音频输入。 - `ChatCompletionContentPartText object { text, type, prompt_cache_breakpoint }` @@ -7824,7 +7825,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `prompt_cache_breakpoint: optional object { mode }` - 标记可复用提示前缀的精确结束位置。该断点会沿用请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。 + 标记可复用提示前缀的确切结束位置。该断点继承自请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。 - `mode: "explicit"` @@ -7844,7 +7845,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `detail: optional "auto" or "low" or "high"` - 指定图像的细节级别。在 [视觉指南](/docs/guides/vision#low-or-high-fidelity-image-understanding). + 指定图像的细节级别。更多信息请参阅 [视觉指南](/docs/guides/vision#low-or-high-fidelity-image-understanding). - `"auto"` @@ -7860,7 +7861,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `prompt_cache_breakpoint: optional object { mode }` - 标记可复用提示前缀的精确结束位置。该断点会沿用请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。 + 标记可复用提示前缀的确切结束位置。该断点继承自请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。 - `mode: "explicit"` @@ -7894,7 +7895,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `prompt_cache_breakpoint: optional object { mode }` - 标记可复用提示前缀的精确结束位置。该断点会沿用请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。 + 标记可复用提示前缀的确切结束位置。该断点继承自请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。 - `mode: "explicit"` @@ -7910,8 +7911,8 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `file_data: optional string` - Base64 编码的文件数据,在将文件作为字符串传递给模型时使用 - 。 + base64 编码的文件数据,在将文件传递给模型时使用 + 字符串。 - `file_id: optional string` @@ -7919,8 +7920,8 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `filename: optional string` - 文件的名称,在将文件作为字符串传递给模型时使用 - 。 + 文件的名称,在将文件以 + 字符串形式传递给模型时使用。 - `type: "file"` @@ -7930,7 +7931,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `prompt_cache_breakpoint: optional object { mode }` - 标记可复用提示前缀的精确结束位置。该断点会沿用请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。 + 标记可复用提示前缀的确切结束位置。该断点继承自请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。 - `mode: "explicit"` @@ -7946,16 +7947,16 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `name: optional string` - 该参与者的可选名称。为模型提供信息,以便区分相同角色的不同参与者。 + 参与者的可选名称。为模型提供信息,以便区分同一角色的不同参与者。 -# Messages +# 消息 ## 获取聊天消息 **get** `/chat/completions/{completion_id}/messages` -获取已存储聊天补全中的消息。仅返回通过 -参数创建的 Chat Completions 所对应的 `store` 参数设置为 `true` 消息将被 +获取存储的聊天补全中的消息。仅返回使用 +创建的 Chat Completions `store` 创建的 Chat Completions `true` 将被 返回。 ### 路径参数 @@ -7966,7 +7967,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `after: optional string` - 上一次分页请求中最后一条消息的标识符。 + 上一页分页请求中最后一条消息的标识符。 - `limit: optional number` @@ -7974,17 +7975,17 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `order: optional "asc" or "desc"` - 按时间戳排序消息的顺序。使用 `asc` 表示升序,或 `desc` 表示降序。默认为 `asc`. + 按时间戳排序消息的顺序。使用 `asc` 表示升序,或使用 `desc` 表示降序。默认为 `asc`. - `"asc"` - `"desc"` -### Returns +### 返回值 - `data: array of ChatCompletionStoreMessage` - 一个由聊天补全消息对象组成的数组。 + 聊天补全消息对象组成的数组。 - `id: string` @@ -7992,7 +7993,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `content_parts: optional array of ChatCompletionContentPartText or ChatCompletionContentPartImage or null` - 如果提供了内容 parts 数组,则这是一个 `text` 和 `image_url` parts 数组。 + 如果提供了内容部分数组,则这是一个由 `text` 和 `image_url` 部分组成的数组。 否则为 null。 - `ChatCompletionContentPartText object { text, type, prompt_cache_breakpoint }` @@ -8011,7 +8012,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `prompt_cache_breakpoint: optional object { mode }` - 标记可复用提示前缀的精确结束位置。该断点会沿用请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。 + 标记可复用提示前缀的确切结束位置。该断点继承自请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。 - `mode: "explicit"` @@ -8031,7 +8032,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `detail: optional "auto" or "low" or "high"` - 指定图像的细节级别。在 [视觉指南](/docs/guides/vision#low-or-high-fidelity-image-understanding). + 指定图像的细节级别。更多信息请参阅 [视觉指南](/docs/guides/vision#low-or-high-fidelity-image-understanding). - `"auto"` @@ -8047,7 +8048,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `prompt_cache_breakpoint: optional object { mode }` - 标记可复用提示前缀的精确结束位置。该断点会沿用请求的 `prompt_cache_options.ttl`;边界不会对齐到 token 块。 + 标记可复用提示前缀的确切结束位置。该断点继承自请求的 `prompt_cache_options.ttl`;的 TTL;边界不会对齐到 token 块。 - `mode: "explicit"` @@ -8069,7 +8070,7 @@ curl -X POST https://api.openai.com/v1/chat/completions/chat_abc123 \ - `object: "list"` - 该对象的类型,固定为 "list"。 + 此对象的类型。始终设置为 "list"。 - `"list"` diff --git a/docs/zh/api/reference/resources/chat/subresources/completions/methods/retrieve.md b/docs/zh/api/reference/resources/chat/subresources/completions/methods/retrieve.md index 99948a7..3362324 100644 --- a/docs/zh/api/reference/resources/chat/subresources/completions/methods/retrieve.md +++ b/docs/zh/api/reference/resources/chat/subresources/completions/methods/retrieve.md @@ -1,11 +1,11 @@ -> 完整文档索引请参阅 [llms.txt](/llms.txt)。可通过在页面 URL 末尾追加 `.md` 来获取文档页面的 Markdown 版本。 +> 如需完整文档索引,请参阅 [llms.txt](/llms.txt)。在页面 URL 后面追加 `.md` 即可获取该页面的 Markdown 版本。 ## 获取聊天补全 **get** `/chat/completions/{completion_id}` -获取已存储的聊天补全。仅返回使用 -参数创建的 `store` 参数设置为 `true` 的聊天补全。 +获取已存储的 Chat Completions。仅返回已使用 +参数创建的 `store` 参数设置为 `true` 的 Chat Completions。 ### 路径参数 @@ -15,7 +15,7 @@ - `ChatCompletion object { id, choices, created, 7 more }` - 表示模型根据提供的输入返回的聊天补全响应。 + 表示由模型根据所提供的输入返回的聊天补全响应。 - `id: string` @@ -23,15 +23,15 @@ - `choices: array of object { finish_reason, index, logprobs, message }` - 聊天补全选项列表。如果以下参数大于 1,则可以包含多个: `n` 大于 1。 + 聊天补全选项的列表。如果 `n` 大于 1,则可能包含多个。 - `finish_reason: "stop" or "length" or "tool_calls" or 2 more` - 模型停止生成 token 的原因。当出现以下情况时,该字段的值为: `stop` 如果模型遇到自然停止点或提供了停止序列, - `length` 如果达到了请求中指定的最大 token 数, - `content_filter` 如果由于我们的内容过滤器标记而被省略了内容, - `tool_calls` 如果模型调用了工具,或 `function_call` (已弃用)如果模型调用了函数。 - 请阅读 [模型规范](https://model-spec.openai.com/2025-12-18.html) 了解更多信息。 + 模型停止生成 token 的原因。该值将为 `stop` (如果模型遇到自然停止点或提供了停止序列), + `length` (如果达到了请求中指定的最大 token 数), + `content_filter` (如果由于内容过滤器的标记而省略了内容), + `tool_calls` (如果模型调用了工具),或 `function_call` (已废弃,如果模型调用了函数)。 + 请参阅 [模型规范](https://model-spec.openai.com/2025-12-18.html) 以了解更多信息。 - `"stop"` @@ -53,7 +53,7 @@ - `content: array of ChatCompletionTokenLogprob or null` - 包含对数概率信息的消息内容 token 列表。 + 带有对数概率信息的消息内容 token 列表。 - `token: string` @@ -61,15 +61,15 @@ - `bytes: array of number or null` - 一个整数列表,表示该 token 的 UTF-8 字节表示。在某些字符由多个 token 表示、且必须组合其字节表示才能生成正确文本表示的情况下非常有用。如果没有该 token 的字节表示,则可以为 `null` 如果该 token 没有字节表示。 + 一个整数列表,表示该 token 的 UTF-8 字节表示。在字符由多个 token 表示且必须组合其字节表示以生成正确文本表示的场景中很有用。如果该 token 没有字节表示,则可以为 `null` 。 - `logprob: number` - 此 token 的对数概率(如果它位于前 20 个最可能的 token 之内)。否则,值为 `-9999.0` 用于表示该 token 出现的可能性极低。 + 此 token 的对数概率(如果它位于最可能的 20 个 token 之内)。否则,值 `-9999.0` 用于表示该令牌极不可能出现。 - `top_logprobs: array of object { token, bytes, logprob }` - 在该 token 位置处最可能的 token 及其对数概率列表。条目数量可能少于请求的 `top_logprobs`. + 该令牌位置最可能的令牌及其对数概率列表。条目的数量可能少于请求的 `top_logprobs`. - `token: string` @@ -77,15 +77,15 @@ - `bytes: array of number or null` - 一个整数列表,表示该 token 的 UTF-8 字节表示。在某些字符由多个 token 表示、且必须组合其字节表示才能生成正确文本表示的情况下非常有用。如果没有该 token 的字节表示,则可以为 `null` 如果该 token 没有字节表示。 + 一个整数列表,表示该 token 的 UTF-8 字节表示。在字符由多个 token 表示且必须组合其字节表示以生成正确文本表示的场景中很有用。如果该 token 没有字节表示,则可以为 `null` 。 - `logprob: number` - 此 token 的对数概率(如果它位于前 20 个最可能的 token 之内)。否则,值为 `-9999.0` 用于表示该 token 出现的可能性极低。 + 此 token 的对数概率(如果它位于最可能的 20 个 token 之内)。否则,值 `-9999.0` 用于表示该令牌极不可能出现。 - `refusal: array of ChatCompletionTokenLogprob or null` - 包含对数概率信息的拒绝消息 token 列表。 + 包含对数概率信息的消息拒绝令牌列表。 - `token: string` @@ -93,19 +93,19 @@ - `bytes: array of number or null` - 一个整数列表,表示该 token 的 UTF-8 字节表示。在某些字符由多个 token 表示、且必须组合其字节表示才能生成正确文本表示的情况下非常有用。如果没有该 token 的字节表示,则可以为 `null` 如果该 token 没有字节表示。 + 一个整数列表,表示该 token 的 UTF-8 字节表示。在字符由多个 token 表示且必须组合其字节表示以生成正确文本表示的场景中很有用。如果该 token 没有字节表示,则可以为 `null` 。 - `logprob: number` - 此 token 的对数概率(如果它位于前 20 个最可能的 token 之内)。否则,值为 `-9999.0` 用于表示该 token 出现的可能性极低。 + 此 token 的对数概率(如果它位于最可能的 20 个 token 之内)。否则,值 `-9999.0` 用于表示该令牌极不可能出现。 - `top_logprobs: array of object { token, bytes, logprob }` - 在该 token 位置处最可能的 token 及其对数概率列表。条目数量可能少于请求的 `top_logprobs`. + 该令牌位置最可能的令牌及其对数概率列表。条目的数量可能少于请求的 `top_logprobs`. - `message: ChatCompletionMessage` - 由模型生成的聊天补全消息。 + 模型生成的一次聊天补全消息。 - `content: string or null` @@ -117,14 +117,14 @@ - `role: "assistant"` - 该消息作者的角色。 + 此消息作者的角色。 - `"assistant"` - `annotations: optional array of object { type, url_citation }` - 在适用时(例如使用 - [网页搜索工具时)附加到消息的注释](/docs/guides/tools-web-search?api-mode=chat). + 适用于消息的注释,例如使用 + [网页搜索工具](/docs/guides/tools-web-search?api-mode=chat). - `type: "url_citation"` @@ -134,7 +134,7 @@ - `url_citation: object { end_index, start_index, title, url }` - 使用 网页搜索时的 URL 引用。 + 使用网页搜索时的 URL 引用。 - `end_index: number` @@ -154,35 +154,35 @@ - `audio: optional ChatCompletionAudio or null` - 如果请求了音频输出模态,此对象包含来自模型的 - 音频响应相关数据。 [了解详情](/docs/guides/audio). + 如果请求音频输出模态,则此对象包含 + 模型音频响应的相关数据。 [了解详情](/docs/guides/audio). - `id: string` - 该音频响应的唯一标识符。 + 此音频响应的唯一标识符。 - `data: string` - 由模型生成的 Base64 编码音频字节,格式为 - 在请求中指定的。 + 模型生成的 Base64 编码音频字节,格式为 + 请求中指定。 - `expires_at: number` - 该音频响应的 Unix 时间戳(以秒为单位),表示何时该响应在服务端 - 将不再可用于多轮对话。 - 对话。 + Unix 时间戳(以秒为单位),表示该音频响应在多轮对话中将 + 无法再从服务端访问的时间点。 + 不再可访问的时间。 - `transcript: string` - 由模型生成的音频转录文本。 + 模型生成的音频转录文本。 - `function_call: optional object { arguments, name }` - 已弃用,已由 `tool_calls`。取代。应调用的函数名称和参数,由模型生成。 + 已弃用,并被替换为 `tool_calls`。模型生成的应被调用的函数的名称和参数。 - `arguments: string` - 用于调用函数的参数,由模型以 JSON 格式生成。请注意,模型并不总是生成有效的 JSON,并且可能会虚构你函数 schema 中未定义的参数。在调用函数之前,请在代码中验证这些参数。 + 调用函数所使用的参数,由模型以 JSON 格式生成。请注意,模型并不总是生成有效的 JSON,也可能会编造你函数 schema 中未定义的参数。在调用函数之前,请务必在代码中校验这些参数。 - `name: string` @@ -194,7 +194,7 @@ - `ChatCompletionMessageFunctionToolCall object { id, function, type }` - 对模型创建的函数工具的调用。 + 模型创建的函数工具调用。 - `id: string` @@ -206,7 +206,7 @@ - `arguments: string` - 用于调用函数的参数,由模型以 JSON 格式生成。请注意,模型并不总是生成有效的 JSON,并且可能会虚构你函数 schema 中未定义的参数。在调用函数之前,请在代码中验证这些参数。 + 调用函数所使用的参数,由模型以 JSON 格式生成。请注意,模型并不总是生成有效的 JSON,也可能会编造你函数 schema 中未定义的参数。在调用函数之前,请务必在代码中校验这些参数。 - `name: string` @@ -220,7 +220,7 @@ - `ChatCompletionMessageCustomToolCall object { id, custom, type }` - 对模型创建的自定义工具的调用。 + 模型创建的自定义工具调用。 - `id: string` @@ -236,7 +236,7 @@ - `name: string` - 要调用的自定义工具名称。 + 要调用的自定义工具的名称。 - `type: "custom"` @@ -261,24 +261,24 @@ - `metadata: optional Metadata or null` 可附加到对象的 16 个键值对。可用于 - 以结构化格式存储对象的附加信息,并通过 API 或仪表板查询对象。 - 以结构化格式存储对象的附加信息,并通过 接口 或仪表板查询对象。 + 以结构化格式存储有关对象的附加信息,并通过 + API 或仪表板查询对象。 - 键为字符串,最大长度为 64 个字符。值为字符串, - 最大长度为 512 个字符。 + 键为字符串,最长 64 个字符。值为字符串, + 最长 512 个字符。 - `moderation: optional object { input, output } or null` 请求输入和生成输出的审核结果(如果请求了 - 经过审核的补全)。 + 审核补全)。 - `input: object { model, results, type } or object { code, message, type }` - 请求输入的审核结果。 + 针对请求输入的审核。 - `ModerationResults object { model, results, type }` - 请求输入或生成内容的成功审核结果。 + 请求输入或生成输出的成功审核结果。 - `model: string` @@ -290,11 +290,11 @@ - `categories: map[boolean]` - 从审核类别到布尔值的字典,如果输入在该类别下被标记则为 True。 + 审核类别到布尔值的字典,如果输入在该类别下被标记则为 True。 - `category_applied_input_types: map[array of "text" or "image"]` - 每个类别的分数反映的是哪种输入模态。 + 每个类别的分数所对应的输入模态。 - `"text"` @@ -302,11 +302,11 @@ - `category_scores: map[number]` - 从审核类别到分数的字典。 + 审核类别到分数的字典。 - `flagged: boolean` - 指示内容是否被任何类别标记的布尔值。 + 一个布尔值,指示内容是否被任何类别标记。 - `model: string` @@ -314,7 +314,7 @@ - `type: "moderation_result"` - 对象类型,始终为 `moderation_result` 用于成功的审核结果。 + 对象类型,始终为 `moderation_result` 表示成功的内容审核结果。 - `"moderation_result"` @@ -326,7 +326,7 @@ - `Error object { code, message, type }` - 尝试审核时产生的错误。 + 尝试内容审核时产生的错误。 - `code: string` @@ -344,11 +344,11 @@ - `output: object { model, results, type } or object { code, message, type }` - 对生成输出内容的审核。 + 对生成输出的内容审核。 - `ModerationResults object { model, results, type }` - 请求输入或生成内容的成功审核结果。 + 请求输入或生成输出的成功审核结果。 - `model: string` @@ -360,11 +360,11 @@ - `categories: map[boolean]` - 从审核类别到布尔值的字典,如果输入在该类别下被标记则为 True。 + 审核类别到布尔值的字典,如果输入在该类别下被标记则为 True。 - `category_applied_input_types: map[array of "text" or "image"]` - 每个类别的分数反映的是哪种输入模态。 + 每个类别的分数所对应的输入模态。 - `"text"` @@ -372,11 +372,11 @@ - `category_scores: map[number]` - 从审核类别到分数的字典。 + 审核类别到分数的字典。 - `flagged: boolean` - 指示内容是否被任何类别标记的布尔值。 + 一个布尔值,指示内容是否被任何类别标记。 - `model: string` @@ -384,7 +384,7 @@ - `type: "moderation_result"` - 对象类型,始终为 `moderation_result` 用于成功的审核结果。 + 对象类型,始终为 `moderation_result` 表示成功的内容审核结果。 - `"moderation_result"` @@ -396,7 +396,7 @@ - `Error object { code, message, type }` - 尝试审核时产生的错误。 + 尝试内容审核时产生的错误。 - `code: string` @@ -416,13 +416,13 @@ 指定用于处理该请求的处理类型。 - - 如果设置为 'auto',则请求将使用在项目设置中配置的服务层级进行处理。除非另行配置,否则项目将使用 'default'。 - - 如果设置为 'default',则请求将以所选模型的标准定价和性能进行处理。 - - 如果设置为 '[flex](/docs/guides/flex-processing)',则请求将使用 Flex Processing 服务层级进行处理。 - - 若要在请求级别启用 [Fast mode](/api/docs/guides/fast-mode) ,请在 Responses 或 Chat Completions 请求中包含 `service_tier=fast` 或 `service_tier=priority` 参数。响应中将显示 `service_tier=priority` ,无论你在请求中是否指定 `service_tier=fast` 或 `priority` 。 + - 如果设置为 'auto',则将使用项目设置中配置的服务层级来处理请求。除非另行配置,项目将使用 'default'。 + - 如果设置为 'default',则将使用所选模型的标准定价和性能来处理请求。 + - 如果设置为 '[flex](/docs/guides/flex-processing)',则将使用 Flex Processing 服务层级来处理请求。 + - 若要在请求级别启用 [Fast mode](/api/docs/guides/fast-mode) ,请在 Responses 或 Chat Completions 中传入 `service_tier=fast` 参数。响应中将显示 `service_tier=priority` ,无论你是否在请求中指定 `service_tier=priority` 。 `service_tier=fast` 参数。响应中将显示 `priority` 。 - 当未设置时,默认行为为 'auto'。 - 当 `service_tier` parameter is set, the response body will include the `service_tier` value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter. + 当 `service_tier` 参数已设置时,响应体将包含根据实际用于处理该请求的处理模式得出的 `service_tier` 值。此响应值可能与参数中设置的值不同。 - `"auto"` @@ -438,82 +438,82 @@ - `system_fingerprint: optional string` - This fingerprint represents the backend configuration that the model runs with. + 此指纹表示模型运行所使用后端配置。 - Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism. + 可与 `seed` 请求参数结合使用,以了解何时发生了可能影响确定性的后端变更。 - `usage: optional CompletionUsage` - Usage statistics for the completion request. + 补全请求的使用情况统计。 - `completion_tokens: number` - Number of tokens in the generated completion. + 生成的补全内容中的 token 数。 - `prompt_tokens: number` - Number of tokens in the prompt. + 提示中的 token 数。 - `total_tokens: number` - Total number of tokens used in the request (prompt + completion). + 该请求使用的总 token 数(提示 + 补全)。 - `completion_tokens_details: optional object { accepted_prediction_tokens, audio_tokens, reasoning_tokens, 2 more }` - Breakdown of tokens used in a completion. + 补全中使用的 token 明细。 - `accepted_prediction_tokens: optional number` - When using Predicted Outputs, the number of tokens in the - prediction that appeared in the completion. + 使用 Predicted Outputs 时, + 预测中出现在补全内容中的 token 数。 - `audio_tokens: optional number` - Audio input tokens generated by the model. + 模型生成的音频输入 token。 - `reasoning_tokens: optional number` - Tokens generated by the model for reasoning. + 模型生成的用于推理的 token。 - `rejected_prediction_tokens: optional number` - When using Predicted Outputs, the number of tokens in the - prediction that did not appear in the completion. However, like - reasoning tokens, these tokens are still counted in the total - completion tokens for purposes of billing, output, and context window - limits. + 使用 Predicted Outputs 时, + 预测中未出现在补全内容中的 token 数。但是,与 + 推理 token 一样,这些 token 仍计入计费、输出和上下文窗口的 + 总补全 token 数中,用于 + 限制。 - `text_tokens: optional number` - Text output tokens generated by the model. + 模型生成的文本输出 token。 - `compute_units: optional number or null` - Compute units for the request. Currently null when available. + 该请求的计算单元。目前可用时为 null。 - `prompt_tokens_details: optional object { audio_tokens, cache_write_tokens, cached_tokens, 2 more }` - 提示中使用的 token 明细。 + 提示词中使用的 token 明细。 - `audio_tokens: optional number` - 提示中存在的音频输入 token。 + 提示词中存在的音频输入 token。 - `cache_write_tokens: optional number` - 写入缓存的未调整 prompt token 数。 + 写入缓存的未调整提示词 token 数。 - `cached_tokens: optional number` - 提示中存在的已缓存 token。 + 提示词中存在的缓存 token。 - `image_tokens: optional number` - 提示中存在的图片输入 token。 + 提示词中存在的图像输入 token。 - `text_tokens: optional number` - 提示中存在的文本输入 token。 + 提示词中存在的文本输入 token。 ### 示例 @@ -698,7 +698,7 @@ curl https://api.openai.com/v1/chat/completions/chatcmpl-abc123 \ { "object": "chat.completion", "id": "chatcmpl-abc123", - "model": "gpt-4o-2024-08-06", + "model": "gpt-5.6-sol", "created": 1738960610, "request_id": "req_ded8ab984ec4bf840f37566c1011c417", "tool_choice": null, diff --git a/docs/zh/api/reference/resources/chat/subresources/completions/streaming-events.md b/docs/zh/api/reference/resources/chat/subresources/completions/streaming-events.md index f4b80e9..8f38733 100644 --- a/docs/zh/api/reference/resources/chat/subresources/completions/streaming-events.md +++ b/docs/zh/api/reference/resources/chat/subresources/completions/streaming-events.md @@ -1,16 +1,16 @@ # Chat Completions 流式事件 -> 完整文档索引请参阅 [llms.txt](/llms.txt)。在页面 URL 末尾追加 `.md` 即可获得文档页面的 Markdown 版本。 +> 完整文档索引请参阅 [llms.txt](/llms.txt).可通过在页面 URL 末尾追加 `.md` 获取文档页面的 Markdown 版本。 -实时流式 Chat Completions。使用服务端发送事件接收模型返回的补全分块。 -返回的分块通过服务端发送事件从模型获取。 -[了解更多](https://developers.openai.com/docs/guides/streaming-responses?api-mode=chat). +实时流式传输 Chat Completions。使用服务端发送事件接收模型返回的补全分块 +。 +[了解详情](https://developers.openai.com/docs/guides/streaming-responses?api-mode=chat). ## chat.completion.chunk -表示基于所提供输入由模型返回的聊天补全响应的分块流。 -由模型根据所提供的输入返回。 -[了解更多](https://developers.openai.com/docs/guides/streaming-responses). +表示模型基于所提供的输入返回的聊天补全响应的流式分块 +。 +[了解详情](https://developers.openai.com/docs/guides/streaming-responses). ### Schema @@ -2192,11 +2192,11 @@ Schema name: `CreateChatCompletionStreamResponse` ### 示例 ```json -{"id":"chatcmpl-123","object":"chat.completion.chunk","created":1694268190,"model":"gpt-4o-mini", "system_fingerprint": "fp_44709d6fcb", "choices":[{"index":0,"delta":{"role":"assistant","content":""},"logprobs":null,"finish_reason":null}],"obfuscation":"r4N7vQ2m"} +{"id":"chatcmpl-123","object":"chat.completion.chunk","created":1694268190,"model":"gpt-5.6-sol", "system_fingerprint": "fp_44709d6fcb", "choices":[{"index":0,"delta":{"role":"assistant","content":""},"logprobs":null,"finish_reason":null}],"obfuscation":"r4N7vQ2m"} -{"id":"chatcmpl-123","object":"chat.completion.chunk","created":1694268190,"model":"gpt-4o-mini", "system_fingerprint": "fp_44709d6fcb", "choices":[{"index":0,"delta":{"content":"Hello"},"logprobs":null,"finish_reason":null}],"obfuscation":"p9K3xT6w"} +{"id":"chatcmpl-123","object":"chat.completion.chunk","created":1694268190,"model":"gpt-5.6-sol", "system_fingerprint": "fp_44709d6fcb", "choices":[{"index":0,"delta":{"content":"Hello"},"logprobs":null,"finish_reason":null}],"obfuscation":"p9K3xT6w"} .... -{"id":"chatcmpl-123","object":"chat.completion.chunk","created":1694268190,"model":"gpt-4o-mini", "system_fingerprint": "fp_44709d6fcb", "choices":[{"index":0,"delta":{},"logprobs":null,"finish_reason":"stop"}],"obfuscation":""} +{"id":"chatcmpl-123","object":"chat.completion.chunk","created":1694268190,"model":"gpt-5.6-sol", "system_fingerprint": "fp_44709d6fcb", "choices":[{"index":0,"delta":{},"logprobs":null,"finish_reason":"stop"}],"obfuscation":""} ``` diff --git a/docs/zh/api/reference/resources/completions.md b/docs/zh/api/reference/resources/completions.md index c3a835e..91f4b2d 100644 --- a/docs/zh/api/reference/resources/completions.md +++ b/docs/zh/api/reference/resources/completions.md @@ -1,26 +1,26 @@ # Completions -> 如需完整的文档索引,请参阅 [llms.txt](/llms.txt)。在页面 URL 末尾追加 `.md` 即可获取文档页面的 Markdown 版本。 +> 如需查看完整文档索引,请参阅 [llms.txt](/llms.txt)。在页面 URL 末尾追加 `.md` 即可获取文档页面的 Markdown 版本。 ## 创建补全 **post** `/completions` -根据提供的提示词和参数创建一个补全。 +根据提供的提示和参数创建补全。 -返回一个补全对象;如果请求以流式传输,则返回一系列补全对象。 +返回一个补全对象,如果请求是流式的,则返回一系列补全对象。 -### 正文参数 +### 请求体参数 - `model: string or "gpt-3.5-turbo-instruct" or "davinci-002" or "babbage-002"` - 要使用的模型 ID。你可以使用 [列出模型](/docs/api-reference/models/list) API 来查看所有可用模型,或参阅我们的 [模型概述](/docs/models) 了解相关说明。 + 要使用的模型 ID。你可以使用 [列出模型](/docs/api-reference/models/list) API 查看所有可用模型,或参阅我们的 [模型概述](/docs/models) 了解相关描述。 - `string` - `"gpt-3.5-turbo-instruct" or "davinci-002" or "babbage-002"` - 要使用的模型 ID。你可以使用 [列出模型](/docs/api-reference/models/list) API 来查看所有可用模型,或参阅我们的 [模型概述](/docs/models) 了解相关说明。 + 要使用的模型 ID。你可以使用 [列出模型](/docs/api-reference/models/list) API 查看所有可用模型,或参阅我们的 [模型概述](/docs/models) 了解相关描述。 - `"gpt-3.5-turbo-instruct"` @@ -30,9 +30,9 @@ - `prompt: string or array of string or array of number or array of array of number or null` - 用于生成补全的提示,可以编码为字符串、字符串数组、token 数组或 token 数组的数组。 + 用于生成补全的提示(prompt),可以编码为字符串、字符串数组、token 数组或 token 数组的数组。 - 请注意, 是模型在训练期间看到的文档分隔符,因此如果未指定提示,模型将像从新文档的开头开始一样生成内容。 + 注意,是模型在训练期间看到的文档分隔符,因此如果未指定提示,模型将如同从一篇新文档的开头开始生成。 - `string` @@ -44,66 +44,66 @@ - `best_of: optional number or null` - 生成 `best_of` 补全 服务端,并返回“最佳”的结果(即每个 token 对数概率最高的那一个)。结果无法以流式方式返回。 + 服务端 `best_of` 生成补全并返回“最佳”结果(即每个 token 具有最高对数概率的那一个)。结果无法以流式方式返回。服务端。 - 与 `n`, `best_of` 一起使用时,用于控制候选补全的数量,而 `n` 用于指定要返回的数量—— `best_of` 必须大于 `n`. + 与 `n`, `best_of` 配合使用时,它控制候选补全的数量,而 `n` 指定要返回多少个 – `best_of` 必须大于 `n`. - **注意:** 由于此参数会生成大量补全,可能会快速消耗你的 token 配额。请谨慎使用,并确保为 `max_tokens` 和 `stop`. + **注意:** 由于此参数会生成大量补全,可能会迅速消耗你的 token 配额。请谨慎使用,并确保你对 `max_tokens` 和 `stop`. - `echo: optional boolean or null` - 除了补全内容外,还回显提示 + 除了补全内容外,将提示一同回显 - `frequency_penalty: optional number or null` - 介于 -2.0 和 2.0 之间的数值。正值会根据新 token 在已有文本中的出现频率对其进行惩罚,从而降低模型逐字重复相同内容的可能性。 + 介于 -2.0 到 2.0 之间的数值。正值会根据新 token 在已有文本中出现的频率对其进行惩罚,从而降低模型逐字重复相同内容的可能性。 - [查看有关频率和存在惩罚的更多信息。](/docs/guides/text-generation) + [查看关于频率和存在惩罚的更多信息。](/docs/guides/text-generation) - `logit_bias: optional map[number] or null` - 修改指定 token 出现在补全中的可能性。 + 修改指定 token 在补全中出现的可能性。 - 接受一个 JSON 对象,该对象将 token(由 GPT tokenizer 中的 token ID 指定)映射到 -100 到 100 之间的关联偏差值。你可以使用此 [tokenizer 工具](/tokenizer?view=bpe) 将文本转换为 token ID。从数学上讲,该偏差会在采样前添加到模型生成的 logits 上。具体效果因模型而异,但 -1 到 1 之间的值应会降低或提高被选中的可能性;-100 或 100 这样的值应会导致禁用或唯一选择相关 token。 + 接受一个 JSON 对象,将 token(通过 GPT 分词器中的 token ID 指定)映射到 -100 到 100 之间的关联偏差值。可以使用此 [分词器工具](/tokenizer?view=bpe) 将文本转换为 token ID。数学上,偏差会在采样之前被加到模型生成的 logits 上。具体影响会因模型而异,但介于 -1 到 1 之间的值会降低或增加被选中的可能性;像 -100 或 100 这样的值会导致禁用或独占选择相应的 token。 - 例如,你可以传入 `{"50256": -100}` 以阻止生成 token。 + 例如,可以传入 `{"50256": -100}` 来阻止生成 token。 - `logprobs: optional number or null` - 在 `logprobs` 最可能的输出 token 上以及所选 token 上包含对数概率。例如,如果 `logprobs` 为 5,API 将返回 5 个最可能 token 的列表。API 将始终返回 `logprob` 所采样 token 的 `logprobs+1` ,因此响应中最多可以有。 + 在以下输出中包含对数概率: `logprobs` 最可能的输出 token,以及所选 token。例如,如果 `logprobs` 为 5,API 将返回 5 个最可能 token 的列表。API 将始终返回所采样 token 的 `logprob` ,因此响应中最多可以有 `logprobs+1` 个元素。 - 个元素。 `logprobs` 的最大值为 5。 + 的最大值为 `logprobs` 5。 - `max_tokens: optional number or null` - 可在 completion 中生成的最大 [token 数](/tokenizer) 。 + 可在补全中生成的最大 [token 数](/tokenizer) 。 - 你的 prompt 的 token 数加上 `max_tokens` 不能超过模型的上下文长度。 [用于计算 token 的](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken) Python 代码示例。 + 你的 prompt 的 token 数加上 `max_tokens` 不能超过模型的上下文长度。 [用于计算 token 的示例 Python 代码](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken) 。 - `n: optional number or null` - 为每个 prompt 生成的 completion 数量。 + 每个 prompt 要生成的补全数。 - **注意:** 由于此参数会生成大量补全,可能会快速消耗你的 token 配额。请谨慎使用,并确保为 `max_tokens` 和 `stop`. + **注意:** 由于此参数会生成大量补全,可能会迅速消耗你的 token 配额。请谨慎使用,并确保你对 `max_tokens` 和 `stop`. - `presence_penalty: optional number or null` - 介于 -2.0 和 2.0 之间的数字。正值会根据新 token 是否已出现在文本中对其进行惩罚,从而增加模型谈论新主题的可能性。 + 介于 -2.0 到 2.0 之间的数值。正值会根据新 token 是否已在文本中出现对其进行惩罚,从而提高模型谈论新主题的可能性。 - [查看有关频率和存在惩罚的更多信息。](/docs/guides/text-generation) + [查看关于频率和存在惩罚的更多信息。](/docs/guides/text-generation) - `seed: optional number or null` - 如果指定,系统将尽最大努力进行确定性采样,使得在相同 `seed` 和参数下重复请求应返回相同的结果。 + 如果指定,我们的系统将尽最大努力进行确定性采样,使得在相同 `seed` 和参数下重复请求应返回相同的结果。 - 不保证确定性,你可以参考 `system_fingerprint` response 参数来监控后端的变化。 + 无法保证完全确定性,你可以查阅 `system_fingerprint` 响应参数以监控后端的变化。 - `stop: optional string or array of string or null` - 最新的推理模型不支持此参数 `o3` 和 `o4-mini`. + 最新的推理模型不支持该参数 `o3` 和 `o4-mini`. - 最多 4 个序列,当出现这些序列时,API 将停止生成更多 token。 - 返回的文本将不包含停止序列。 + 最多 4 个序列,当遇到这些序列时 API 将停止生成更多 token。返回的 + 文本将不包含停止序列。 - `string` @@ -111,56 +111,56 @@ - `stream: optional boolean or null` - 是否流式返回部分进度。如果设置,token 将以纯数据形式发送, [服务端发送事件](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) 在可用时即时发出,流以一条 `data: [DONE]` 消息终止。 [用于计算 token 的](https://cookbook.openai.com/examples/how_to_stream_completions). + 是否流式返回部分进度。如果启用,token 将以纯数据的形式作为 [服务端发送事件](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) 随着数据变得可用而发送,流以一个 `data: [DONE]` 消息结束。 [用于计算 token 的示例 Python 代码](https://cookbook.openai.com/examples/how_to_stream_completions). - `stream_options: optional ChatCompletionStreamOptions or null` - 流式响应的选项。仅在设置 `stream: true`. + 流式响应的选项。仅当你设置 `stream: true`. - `include_obfuscation: optional boolean` - 为 true 时,将启用流混淆。流混淆会向流式 delta 事件上的 + 如果为 true,将启用流混淆。流混淆会向流式 delta 事件的 字段添加随机字符, `obfuscation` 以规范化负载大小,作为针对某些侧信道攻击的缓解措施。 - 这些混淆字段默认包含在内,但会为数据流增加少量。 - 开销。你可以将 + 这些混淆字段默认包含,但会增加少量。 + 到数据流的开销。你可以将 设置为 `include_obfuscation` 为 - 如果信任你的应用与 OpenAI API 之间的网络链路,则设为 false 以优化带宽, - 你的应用与 该公司 接口。 + false 时可在信任你的应用与 + OpenAI API 之间网络链路的情况下优化带宽。 - `include_usage: optional boolean` - 如果设置,则会在该消息之前流式传输一个额外的块。 `data: [DONE]` - 消息。该块上的 `usage` 字段会显示整个请求的令牌使用统计信息, - 对于整个请求,以及该 `choices` 字段将始终是一个空数组。 + 若设置,则在 `data: [DONE]` + 消息之前还会流式传出一个额外的数据块。该 `usage` 字段显示整个请求的 token 使用统计信息, + 字段对应整个请求, `choices` 字段始终为空 数组。 - 所有其他块也将包含一个 `usage` 字段,但值为 null。 - 值。 **注意:** 如果流被中断,你可能无法收到包含该请求总令牌使用量的 - 最终 usage 数据块。 + 所有其他数据块也会包含一个 `usage` 字段,但其值为 + null。 **注意:** 如果流被中断,你可能无法收到 + 包含整个请求总 token 使用量的最终使用情况数据块。 - `suffix: optional string or null` - 插入文本完成后出现的后缀。 + 插入文本补全之后的后缀。 - 该参数仅在以下模型中受支持: `gpt-3.5-turbo-instruct`. + 该参数仅支持 `gpt-3.5-turbo-instruct`. - `temperature: optional number or null` - 使用的采样温度,介于 0 到 2 之间。较高的值(如 0.8)会使输出更加随机,而较低的值(如 0.2)会使输出更加集中和确定。 + 使用的采样温度,介于 0 和 2 之间。较高的值(如 0.8)会使输出更加随机,而较低的值(如 0.2)会使输出更加聚焦和确定。 - 我们通常建议修改此项或 `top_p` ,但不要同时修改两者。 + 我们通常建议修改此参数或 `top_p` ,但不要同时修改两者。 - `top_p: optional number or null` - 一种温度采样的替代方案,称为核采样(nucleus sampling),其中模型会考虑具有 top_p 概率质量的令牌结果。因此 0.1 表示仅考虑构成前 10% 概率质量的令牌。 + 一种采用温度采样的替代方案,称为核采样(nucleus sampling),即模型考虑具有 top_p 概率质量的 token 结果。所以 0.1 表示仅考虑构成前 10% 概率质量的 token。 - 我们通常建议修改此项或 `temperature` ,但不要同时修改两者。 + 我们通常建议修改此参数或 `temperature` ,但不要同时修改两者。 - `user: optional string` - 用于标识你的最终用户的唯一 ID,可帮助 OpenAI 监控和检测滥用行为。 [了解更多](/docs/guides/safety-best-practices#end-user-ids). + 用于标识你最终用户的唯一 ID,可以帮助 OpenAI 监控和检测滥用行为。 [了解更多](/docs/guides/safety-best-practices#end-user-ids). -### 返回值 +### Returns - `Completion object { id, choices, created, 4 more }` @@ -176,9 +176,9 @@ - `finish_reason: "stop" or "length" or "content_filter"` - 模型停止生成 token 的原因。结果将是 `stop` 表示模型遇到了自然停止点或提供了停止序列, - `length` 表示达到了请求中指定的最大 token 数, - 或者 `content_filter` 表示因我们的内容过滤器标记而被省略了内容。 + 模型停止生成 token 的原因。该值为 `stop` ,如果模型遇到了自然停止点或提供的停止序列; + `length` ,如果达到了请求中指定的最大 token 数; + 或 `content_filter` ,如果由于我们的内容过滤器标记而省略了内容。 - `"stop"` @@ -216,9 +216,9 @@ - `system_fingerprint: optional string` - 此指纹表示模型运行所用的后端配置。 + 此指纹表示模型运行时的后端配置。 - 可以与 `seed` 请求参数结合使用,以了解可能影响确定性的后端变更何时发生。 + 可与 `seed` 请求参数结合使用,以了解可能影响确定性的后端更改。 - `usage: optional CompletionUsage` @@ -234,64 +234,64 @@ - `total_tokens: number` - 请求中使用的 token 总数(提示 + 补全)。 + 请求中使用的总 token 数(提示 + 补全)。 - `completion_tokens_details: optional object { accepted_prediction_tokens, audio_tokens, reasoning_tokens, 2 more }` - 补全中使用的 token 明细。 + 补全中使用的 token 细分。 - `accepted_prediction_tokens: optional number` 使用 Predicted Outputs 时, - prediction that appeared in the completion. + 出现在补全结果中的预测 token。 - `audio_tokens: optional number` - Audio input tokens generated by the model. + 由模型生成的音频输入 token。 - `reasoning_tokens: optional number` - Tokens generated by the model for reasoning. + 由模型生成的用于推理的 token。 - `rejected_prediction_tokens: optional number` 使用 Predicted Outputs 时, - prediction that did not appear in the completion. However, like - reasoning tokens, these tokens are still counted in the total - completion tokens for purposes of billing, output, and context window - limits. + 未出现在补全结果中的预测 token。但是,与推理 token 类似, + 这些 token 仍会计入用于计费、输出和上下文窗口的总 + 补全 token 中,用于计费、输出和上下文窗口 + 限制。 - `text_tokens: optional number` - Text output tokens generated by the model. + 由模型生成的文本输出 token。 - `compute_units: optional number or null` - Compute units for the request. Currently null when available. + 请求所用的计算单元。目前可用时为 null。 - `prompt_tokens_details: optional object { audio_tokens, cache_write_tokens, cached_tokens, 2 more }` - Breakdown of tokens used in the prompt. + 提示中使用的 token 明细。 - `audio_tokens: optional number` - Audio input tokens present in the prompt. + 提示中存在的音频输入 token。 - `cache_write_tokens: optional number` - The unadjusted number of prompt tokens written to cache. + 写入缓存的未经调整的提示 token 数量。 - `cached_tokens: optional number` - Cached tokens present in the prompt. + 提示中存在的已缓存 token。 - `image_tokens: optional number` - Image input tokens present in the prompt. + 提示中存在的图像输入 token。 - `text_tokens: optional number` - Text input tokens present in the prompt. + 提示中存在的文本输入 token。 ### 示例 @@ -311,7 +311,7 @@ curl https://api.openai.com/v1/completions \ }' ``` -#### 响应 +#### Response ```json { @@ -366,28 +366,28 @@ curl https://api.openai.com/v1/completions \ } ``` -### 无流式 +### 无流式输出 ```http curl https://api.openai.com/v1/completions \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $OPENAI_API_KEY" \ -d '{ - "model": "VAR_completion_model_id", + "model": "gpt-3.5-turbo-instruct", "prompt": "Say this is a test", "max_tokens": 7, "temperature": 0 }' ``` -#### 响应 +#### Response ```json { "id": "cmpl-uqkvlQyYK7bGYrRHQ0eXlWi7", "object": "text_completion", "created": 1589478378, - "model": "VAR_completion_model_id", + "model": "gpt-3.5-turbo-instruct", "system_fingerprint": "fp_44709d6fcb", "choices": [ { @@ -405,14 +405,14 @@ curl https://api.openai.com/v1/completions \ } ``` -### 流式 +### 流式输出 ```http curl https://api.openai.com/v1/completions \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $OPENAI_API_KEY" \ -d '{ - "model": "VAR_completion_model_id", + "model": "gpt-3.5-turbo-instruct", "prompt": "Say this is a test", "max_tokens": 7, "temperature": 0, @@ -420,7 +420,7 @@ curl https://api.openai.com/v1/completions \ }' ``` -#### 响应 +#### Response ```json { @@ -440,9 +440,9 @@ curl https://api.openai.com/v1/completions \ } ``` -## 域类型 +## Domain Types -### 补全 +### Completion - `Completion object { id, choices, created, 4 more }` @@ -458,9 +458,9 @@ curl https://api.openai.com/v1/completions \ - `finish_reason: "stop" or "length" or "content_filter"` - 模型停止生成 token 的原因。结果将是 `stop` 表示模型遇到了自然停止点或提供了停止序列, - `length` 表示达到了请求中指定的最大 token 数, - 或者 `content_filter` 表示因我们的内容过滤器标记而被省略了内容。 + 模型停止生成 token 的原因。该值为 `stop` ,如果模型遇到了自然停止点或提供的停止序列; + `length` ,如果达到了请求中指定的最大 token 数; + 或 `content_filter` ,如果由于我们的内容过滤器标记而省略了内容。 - `"stop"` @@ -498,9 +498,9 @@ curl https://api.openai.com/v1/completions \ - `system_fingerprint: optional string` - 此指纹表示模型运行所用的后端配置。 + 此指纹表示模型运行时的后端配置。 - 可以与 `seed` 请求参数结合使用,以了解可能影响确定性的后端变更何时发生。 + 可与 `seed` 请求参数结合使用,以了解可能影响确定性的后端更改。 - `usage: optional CompletionUsage` @@ -516,74 +516,74 @@ curl https://api.openai.com/v1/completions \ - `total_tokens: number` - 请求中使用的 token 总数(提示 + 补全)。 + 请求中使用的总 token 数(提示 + 补全)。 - `completion_tokens_details: optional object { accepted_prediction_tokens, audio_tokens, reasoning_tokens, 2 more }` - 补全中使用的 token 明细。 + 补全中使用的 token 细分。 - `accepted_prediction_tokens: optional number` 使用 Predicted Outputs 时, - prediction that appeared in the completion. + 出现在补全结果中的预测 token。 - `audio_tokens: optional number` - Audio input tokens generated by the model. + 由模型生成的音频输入 token。 - `reasoning_tokens: optional number` - Tokens generated by the model for reasoning. + 由模型生成的用于推理的 token。 - `rejected_prediction_tokens: optional number` 使用 Predicted Outputs 时, - prediction that did not appear in the completion. However, like - reasoning tokens, these tokens are still counted in the total - completion tokens for purposes of billing, output, and context window - limits. + 未出现在补全结果中的预测 token。但是,与推理 token 类似, + 这些 token 仍会计入用于计费、输出和上下文窗口的总 + 补全 token 中,用于计费、输出和上下文窗口 + 限制。 - `text_tokens: optional number` - Text output tokens generated by the model. + 由模型生成的文本输出 token。 - `compute_units: optional number or null` - Compute units for the request. Currently null when available. + 请求所用的计算单元。目前可用时为 null。 - `prompt_tokens_details: optional object { audio_tokens, cache_write_tokens, cached_tokens, 2 more }` - Breakdown of tokens used in the prompt. + 提示中使用的 token 明细。 - `audio_tokens: optional number` - Audio input tokens present in the prompt. + 提示中存在的音频输入 token。 - `cache_write_tokens: optional number` - The unadjusted number of prompt tokens written to cache. + 写入缓存的未经调整的提示 token 数量。 - `cached_tokens: optional number` - Cached tokens present in the prompt. + 提示中存在的已缓存 token。 - `image_tokens: optional number` - Image input tokens present in the prompt. + 提示中存在的图像输入 token。 - `text_tokens: optional number` - Text input tokens present in the prompt. + 提示中存在的文本输入 token。 -### 补全选项 +### Completion Choice - `CompletionChoice object { finish_reason, index, logprobs, text }` - `finish_reason: "stop" or "length" or "content_filter"` - 模型停止生成 token 的原因。结果将是 `stop` 表示模型遇到了自然停止点或提供了停止序列, - `length` 表示达到了请求中指定的最大 token 数, - 或者 `content_filter` 表示因我们的内容过滤器标记而被省略了内容。 + 模型停止生成 token 的原因。该值为 `stop` ,如果模型遇到了自然停止点或提供的停止序列; + `length` ,如果达到了请求中指定的最大 token 数; + 或 `content_filter` ,如果由于我们的内容过滤器标记而省略了内容。 - `"stop"` @@ -605,7 +605,7 @@ curl https://api.openai.com/v1/completions \ - `text: string` -### 补使用情况用量 +### Completion Usage - `CompletionUsage object { completion_tokens, prompt_tokens, total_tokens, 3 more }` @@ -621,61 +621,61 @@ curl https://api.openai.com/v1/completions \ - `total_tokens: number` - 请求中使用的 token 总数(提示 + 补全)。 + 请求中使用的总 token 数(提示 + 补全)。 - `completion_tokens_details: optional object { accepted_prediction_tokens, audio_tokens, reasoning_tokens, 2 more }` - 补全中使用的 token 明细。 + 补全中使用的 token 细分。 - `accepted_prediction_tokens: optional number` 使用 Predicted Outputs 时, - prediction that appeared in the completion. + 出现在补全结果中的预测 token。 - `audio_tokens: optional number` - Audio input tokens generated by the model. + 由模型生成的音频输入 token。 - `reasoning_tokens: optional number` - Tokens generated by the model for reasoning. + 由模型生成的用于推理的 token。 - `rejected_prediction_tokens: optional number` 使用 Predicted Outputs 时, - prediction that did not appear in the completion. However, like - reasoning tokens, these tokens are still counted in the total - completion tokens for purposes of billing, output, and context window - limits. + 未出现在补全结果中的预测 token。但是,与推理 token 类似, + 这些 token 仍会计入用于计费、输出和上下文窗口的总 + 补全 token 中,用于计费、输出和上下文窗口 + 限制。 - `text_tokens: optional number` - Text output tokens generated by the model. + 由模型生成的文本输出 token。 - `compute_units: optional number or null` - Compute units for the request. Currently null when available. + 请求所用的计算单元。目前可用时为 null。 - `prompt_tokens_details: optional object { audio_tokens, cache_write_tokens, cached_tokens, 2 more }` - Breakdown of tokens used in the prompt. + 提示中使用的 token 明细。 - `audio_tokens: optional number` - Audio input tokens present in the prompt. + 提示中存在的音频输入 token。 - `cache_write_tokens: optional number` - The unadjusted number of prompt tokens written to cache. + 写入缓存的未经调整的提示 token 数量。 - `cached_tokens: optional number` - Cached tokens present in the prompt. + 提示中存在的已缓存 token。 - `image_tokens: optional number` - Image input tokens present in the prompt. + 提示中存在的图像输入 token。 - `text_tokens: optional number` - Text input tokens present in the prompt. + 提示中存在的文本输入 token。 diff --git a/docs/zh/api/reference/resources/completions/methods/create.md b/docs/zh/api/reference/resources/completions/methods/create.md index 26c8d4b..ef2f36d 100644 --- a/docs/zh/api/reference/resources/completions/methods/create.md +++ b/docs/zh/api/reference/resources/completions/methods/create.md @@ -1,24 +1,24 @@ -> 如需完整的文档索引,请参阅 [llms.txt](/llms.txt)。可通过在页面 URL 后追加 `.md` 来获取该页面的 Markdown 版本。 +> 如需查看完整文档索引,请参阅 [llms.txt](/llms.txt)。可通过在页面 URL 末尾添加 `.md` 来获取文档页面的 Markdown 版本。 -## Create completion +## 创建补全 **post** `/completions` -根据提供的提示和参数创建补全。 +根据提供的提示和参数创建一个补全。 -返回一个补全对象,若请求以流式传输则返回一组补全对象。 +返回一个补全对象,如果请求是流式的,则返回一个补全对象序列。 ### 正文参数 - `model: string or "gpt-3.5-turbo-instruct" or "davinci-002" or "babbage-002"` - 要使用的模型 ID。你可以使用 [模型列表](/docs/api-reference/models/list) API 查看所有可用模型,或参阅我们的 [模型概述](/docs/models) 了解相关描述。 + 要使用的模型 ID。你可以使用 [列出模型](/docs/api-reference/models/list) API 查看所有可用的模型,或参阅我们的 [模型概述](/docs/models) 了解它们的说明。 - `string` - `"gpt-3.5-turbo-instruct" or "davinci-002" or "babbage-002"` - 要使用的模型 ID。你可以使用 [模型列表](/docs/api-reference/models/list) API 查看所有可用模型,或参阅我们的 [模型概述](/docs/models) 了解相关描述。 + 要使用的模型 ID。你可以使用 [列出模型](/docs/api-reference/models/list) API 查看所有可用的模型,或参阅我们的 [模型概述](/docs/models) 了解它们的说明。 - `"gpt-3.5-turbo-instruct"` @@ -30,7 +30,7 @@ 用于生成补全的提示,可以编码为字符串、字符串数组、token 数组或 token 数组的数组。 - 注意, 是模型在训练期间看到的文档分隔符,因此如果未指定提示,模型将像从新文档的开头开始一样生成内容。 + 注意 <|endoftext|> 是模型在训练期间看到的文档分隔符,因此如果未指定提示,模型将如同从新文档开头开始一样进行生成。 - `string` @@ -42,66 +42,66 @@ - `best_of: optional number or null` - 在服务端 `best_of` 生成补全服务端,并返回“最佳”结果(即每个 token 具有最高对数概率的那一个)。结果无法以流式方式返回。 + 在 `best_of` 端服务端生成补全,并返回“最佳”的一个(每个 token 具有最高对数概率的那个)。结果无法以流式返回。 - 与 `n`, `best_of` 一起使用时,控制候选补全的数量, `n` 指定返回的数量—— `best_of` 必须大于 `n`. + 与 `n`, `best_of` 一起使用时,用于控制候选补全的数量,而 `n` 指定要返回的数量 —— `best_of` 必须大于 `n`. - **注意:** 由于该参数会生成大量补全,可能会迅速消耗你的 token 配额。请谨慎使用,并确保你为 `max_tokens` 和 `stop`. + **注意:** 由于此参数会生成大量补全,可能会迅速消耗你的 token 配额。请谨慎使用,并确保你对 `max_tokens` 和 `stop`. - `echo: optional boolean or null` - 除了补全内容外,回显输入提示 + 除补全外,还回显提示 - `frequency_penalty: optional number or null` - 介于 -2.0 和 2.0 之间的数值。正值会根据新 token 在已有文本中的出现频率对其进行惩罚,从而降低模型逐字重复相同内容的可能性。 + 介于 -2.0 和 2.0 之间的数值。正值会根据新 token 截至目前在文本中已出现的频率对其进行惩罚,从而降低模型逐字重复相同内容的可能性。 - [查看关于频率惩罚和存在惩罚的更多信息。](/docs/guides/text-generation) + [查看有关频率和存在惩罚的更多信息。](/docs/guides/text-generation) - `logit_bias: optional map[number] or null` - 修改指定 token 在补全中出现的概率。 + 修改指定 token 出现在补全中的可能性。 - 接受一个 JSON 对象,将 GPT 分词器中的 token(通过其 token ID 指定)映射到 -100 到 100 之间的关联偏置值。你可以使用此 [分词器工具](/tokenizer?view=bpe) 将文本转换为 token ID。从数学上讲,该偏置会在采样之前加到模型生成的 logits 上。具体效果因模型而异,但 -1 到 1 之间的值应会降低或增加被选中的可能性;类似 -100 或 100 的值应会导致相应 token 被禁止或被唯一选中。 + 接受一个 JSON 对象,用于将词元(通过其在 GPT 分词器中的词元 ID 指定)映射到 -100 到 100 之间的关联偏置值。你可以使用这个 [分词器工具](/tokenizer?view=bpe) 将文本转换为词元 ID。从数学上讲,该偏置会在采样之前添加到模型生成的 logits 上。不同模型的具体效果会有所不同,但 -1 到 1 之间的值应会降低或提高被选中的可能性;像 -100 或 100 这样的值应会导致相应词元被禁止或被唯一选中。 - 例如,你可以传入 `{"50256": -100}` 以防止生成 <|endoftext|> token。 + 例如,你可以传入 `{"50256": -100}` 以防止 词元被生成。 - `logprobs: optional number or null` - 在 `logprobs` 最可能的输出 token 以及所选 token 上包含对数概率。例如,如果 `logprobs` 为 5,API 将返回一个包含 5 个最可能 token 的列表。API 始终会返回所采样 token 的 `logprob` ,因此响应中最多可能包含 `logprobs+1` 个元素。 + 在 `logprobs` 最可能的输出词元以及所选词元上包含对数概率。例如,如果 `logprobs` 为 5,API 将返回一个包含 5 个最可能词元的列表。API 将始终返回所采样词元的 `logprob` ,因此响应中最多可能有 `logprobs+1` 个元素。 的最大值为 `logprobs` 5。 - `max_tokens: optional number or null` - 可在补全中生成的最大 [token 数](/tokenizer) 。你的 prompt 的 token 数加上。 + 可在完成中生成的最大 [词元](/tokenizer) 数。 - 不能超过模型的上下文长度。 `max_tokens` 可参考用于计算 token 数的。 [Python 示例代码](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken) 。 + 你的提示的词元数加上 `max_tokens` 不能超过模型的上下文长度。 [用于计算词元的 Python 示例代码](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken) 。 - `n: optional number or null` - 为每个 prompt 生成的补全数量。 + 为每个提示生成的完成数。 - **注意:** 由于该参数会生成大量补全,可能会迅速消耗你的 token 配额。请谨慎使用,并确保你为 `max_tokens` 和 `stop`. + **注意:** 由于此参数会生成大量补全,可能会迅速消耗你的 token 配额。请谨慎使用,并确保你对 `max_tokens` 和 `stop`. - `presence_penalty: optional number or null` - 介于 -2.0 到 2.0 之间的数值。正值会根据新 token 是否已出现在文本中对其进行惩罚,从而增加模型谈论新主题的可能性。 + 介于 -2.0 和 2.0 之间的数值。正值会根据新 token 是否已在迄今为止的文本中出现来对其进行惩罚,从而提高模型谈论新主题的可能性。 - [查看关于频率惩罚和存在惩罚的更多信息。](/docs/guides/text-generation) + [查看有关频率和存在惩罚的更多信息。](/docs/guides/text-generation) - `seed: optional number or null` - 如果指定,系统将尽最大努力以确定性方式采样,使得使用相同的 `seed` 和参数发起的重复请求返回相同的结果。 + 如果指定,我们的系统将尽最大努力进行确定性采样,使得在相同参数下重复发起的请求 `seed` 应返回相同的结果。 - 无法保证完全确定性,你应该参考 `system_fingerprint` 响应参数来监测后端的变化。 + 无法保证完全确定性,你可以参考 `system_fingerprint` 响应参数来监测后端的变化。 - `stop: optional string or array of string or null` 最新的推理模型不支持该参数 `o3` 和 `o4-mini`. - 最多 4 个序列,遇到这些序列时 API 将停止生成更多 token。返回的 - 文本不会包含该停止序列。 + 最多 4 个序列,当出现这些序列时,API 将停止生成更多 token。 + 返回的文本不会包含停止序列。 - `string` @@ -109,54 +109,54 @@ - `stream: optional boolean or null` - 是否流式返回部分进度。如果设置,token 将以纯数据 [服务端发送事件](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) 的形式在可用时立即发送,流以一条 `data: [DONE]` 消息终止。 [Python 示例代码](https://cookbook.openai.com/examples/how_to_stream_completions). + 是否流式返回部分进度。如果启用,token 将以仅含数据的 [服务端发送事件](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) 在数据可用时,流以一条 `data: [DONE]` 消息结束。 [用于计算词元的 Python 示例代码](https://cookbook.openai.com/examples/how_to_stream_completions). - `stream_options: optional ChatCompletionStreamOptions or null` - 流式响应的选项。仅当设置 `stream: true`. + 流式响应的选项。仅在你设置 `stream: true`. - `include_obfuscation: optional boolean` 为 true 时,将启用流混淆。流混淆会向流式增量事件上的 - 字段添加随机字符,以 `obfuscation` 规范化负载大小,作为对某些侧信道攻击的缓解措施。 - 这些混淆字段默认会被包含,但会给数据流增加少量。 - 开销。你可以设置 - 为 `include_obfuscation` 为 - 如果你信任你的应用与 - OpenAI API 之间的网络链路,则设为 false 以优化带宽。 + 字段添加随机字符,以 `obfuscation` 规整负载大小,作为针对某些侧信道攻击的缓解措施。 + 这些混淆字段默认包含在内,但会给数据流带来少量。 + 开销。你可以将 + 设置为 `include_obfuscation` 以 + 如果信任你的应用与 OpenAI API 之间的网络链路,则可设为 false 以优化带宽。 + 你的应用与 该公司 接口 之间的。 - `include_usage: optional boolean` - 如果设置,则会在之前额外流式传输一个数据块 `data: [DONE]` - 消息。该数据块上的 `usage` 字段会显示整个请求的令牌用量统计信息, - 而该字段则始终是一个 `choices` 空数组。 - 空数组。 + 如果设置,则会在之前流式传输一个额外的分块 `data: [DONE]` + 消息。该分块的 `usage` 字段会显示整个请求的 token 使用统计信息, + 整个请求的 token 使用情况,并且该 `choices` 字段将始终为空 + 数组。 - 所有其他数据块也会包含一个 `usage` 字段,但其值为 - null。 **注意:** 如果流被中断,你可能无法收到 - 包含整个请求总令牌用量的最终用量数据块。 + 所有其他分块也会包含一个 `usage` 字段,但其值为 null + 值。 **注意:** 如果流被中断,你可能无法收到包含该请求总 token 用量的 + 最后一个用量数据块。 - `suffix: optional string or null` - 在已插入文本的补全内容之后出现的后缀。 + 插入文本补全之后的后缀。 - 该参数仅支持 `gpt-3.5-turbo-instruct`. + 此参数仅受支持于 `gpt-3.5-turbo-instruct`. - `temperature: optional number or null` - 使用的采样温度,介于 0 到 2 之间。较高的值(例如 0.8)会使输出更加随机,而较低的值(例如 0.2)会使输出更加聚焦和确定性。 + 使用的采样温度,介于 0 和 2 之间。较高的值(如 0.8)会使输出更加随机,而较低的值(如 0.2)会使输出更加集中和确定。 我们通常建议更改此参数或 `top_p` ,但不要同时更改两者。 - `top_p: optional number or null` - 一种采用温度采样的替代方法,称为核采样(nucleus sampling),模型会考虑具有 top_p 概率质量的令牌结果。因此 0.1 表示仅考虑构成前 10% 概率质量的令牌。 + 一种替代的温度采样方法,称为核采样,其中模型会考虑具有 top_p 概率质量的 token 的结果。因此 0.1 表示仅考虑构成前 10% 概率质量的 token。 我们通常建议更改此参数或 `temperature` ,但不要同时更改两者。 - `user: optional string` - 用于表示你最终用户的唯一标识符,可以帮助 OpenAI 监控和检测滥用行为。 [了解更多](/docs/guides/safety-best-practices#end-user-ids). + 用于表示你终端用户的唯一标识符,可以帮助 OpenAI 监控和检测滥用行为。 [了解更多](/docs/guides/safety-best-practices#end-user-ids). ### Returns @@ -170,13 +170,13 @@ - `choices: array of CompletionChoice` - 模型为输入提示生成的补全选项列表。 + 模型针对输入提示所生成的补全选项列表。 - `finish_reason: "stop" or "length" or "content_filter"` - 模型停止生成 token 的原因。这将 `stop` 如果模型遇到自然停止点或提供了停止序列, + 模型停止生成 token 的原因。该值将 `stop` 如果模型遇到了自然停止点或提供了停止序列, `length` 如果达到了请求中指定的最大 token 数, - 或 `content_filter` 如果内容由于我们的内容过滤器的标记而被省略。 + 或者 `content_filter` 如果由于我们内容过滤器的标记而省略了内容。 - `"stop"` @@ -200,7 +200,7 @@ - `created: number` - 补全创建时的 Unix 时间戳(秒)。 + 创建补全时的 Unix 时间戳(以秒为单位)。 - `model: string` @@ -214,9 +214,9 @@ - `system_fingerprint: optional string` - 此指纹表示模型运行所用的后端配置。 + 此指纹表示模型运行所使用后端配置。 - 可以与 `seed` 请求参数结合使用,以了解后端何时发生了可能影响确定性的更改。 + 可与以下请求参数结合使用, `seed` 以了解何时进行了可能影响确定性的后端更改。 - `usage: optional CompletionUsage` @@ -232,15 +232,15 @@ - `total_tokens: number` - 请求中使用的 token 总数(提示 + 补全)。 + 请求中使用的总 token 数(提示 + 补全)。 - `completion_tokens_details: optional object { accepted_prediction_tokens, audio_tokens, reasoning_tokens, 2 more }` - 补全中使用的 token 细分。 + 补全中使用的 token 明细。 - `accepted_prediction_tokens: optional number` - 使用 Predicted Outputs 时,中的 token 数 + 使用 Predicted Outputs 时,下面的 token 数 completion 中出现的预测 token。 - `audio_tokens: optional number` @@ -249,14 +249,14 @@ - `reasoning_tokens: optional number` - 模型为推理生成的 token。 + 模型用于推理生成的 token。 - `rejected_prediction_tokens: optional number` - 使用 Predicted Outputs 时,中的 token 数 - completion 中未出现的预测 token。但与 - 推理 token 一样,这些 token 仍会计入 - 用于计费、输出和上下文窗口的 completion token 总数 + 使用 Predicted Outputs 时,下面的 token 数 + 未在 completion 中出现的预测 token。然而,与 + 推理 token 一样,这些 token 仍会计入用于计费、输出和上下文窗口 + 的 total completion tokens 中。 限制。 - `text_tokens: optional number` @@ -265,31 +265,31 @@ - `compute_units: optional number or null` - 请求的计算单元。目前在可用时为 null。 + 请求的计算单元。当前可用时为 null。 - `prompt_tokens_details: optional object { audio_tokens, cache_write_tokens, cached_tokens, 2 more }` - 提示词中使用的 token 明细。 + 提示中使用的 token 明细。 - `audio_tokens: optional number` - 提示词中出现的音频输入 token。 + 提示中存在的音频输入 token。 - `cache_write_tokens: optional number` - 写入缓存的未调整的提示词 token 数。 + 写入缓存的未调整提示 token 数。 - `cached_tokens: optional number` - 提示词中出现的已缓存 token。 + 提示中存在的已缓存 token。 - `image_tokens: optional number` - 提示词中出现的图像输入 token。 + 提示中存在的图像输入 token。 - `text_tokens: optional number` - 提示词中出现的文本输入 token。 + 提示中存在的文本输入 token。 ### 示例 @@ -364,14 +364,14 @@ curl https://api.openai.com/v1/completions \ } ``` -### 无流式传输 +### 非流式 ```http curl https://api.openai.com/v1/completions \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $OPENAI_API_KEY" \ -d '{ - "model": "VAR_completion_model_id", + "model": "gpt-3.5-turbo-instruct", "prompt": "Say this is a test", "max_tokens": 7, "temperature": 0 @@ -385,7 +385,7 @@ curl https://api.openai.com/v1/completions \ "id": "cmpl-uqkvlQyYK7bGYrRHQ0eXlWi7", "object": "text_completion", "created": 1589478378, - "model": "VAR_completion_model_id", + "model": "gpt-3.5-turbo-instruct", "system_fingerprint": "fp_44709d6fcb", "choices": [ { @@ -403,14 +403,14 @@ curl https://api.openai.com/v1/completions \ } ``` -### 流式传输 +### 流式 ```http curl https://api.openai.com/v1/completions \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $OPENAI_API_KEY" \ -d '{ - "model": "VAR_completion_model_id", + "model": "gpt-3.5-turbo-instruct", "prompt": "Say this is a test", "max_tokens": 7, "temperature": 0,